Fiorano API Management is quick to install and easy to use. To start with the installation apart from JAVA1.8 (or higher versions) and ANT1.9.2, a few prerequisite Third Party installations are required which include:
- Cassandra DB Server - It is used as the data store for all information that is looked up while a request is being processed such as the subscriptions, clients, and distributed quotas.
- PostgreSQL DB Server - This is the analytics database. All analytics data being tracked at the proxy is stored and fetched from here for processing.
The step by step guide below is to assist with the installation of the above servers as well as the Fiorano API Management product. In addition, it sets out steps to access the Fiorano API Dashboard.
Prerequisites
Installing Fiorano API Management
Install the product with the .bin or .exe installer of the product; run the installer which has an intuitive wizard to install the Fiorano setup as per scenario requirements.
Installing Cassandra Database Server
Cassandra Database is an open source database that provides unmatched linear scalability and high availability with proven fault-tolerance in storing details that need to be looked up on-the-fly.
Installing and configuring PostgreSQL to set up Analytics database
Fiorano uses PostgreSQL for its analytics data store.
- Install PostgreSQL on the machine where the Analytics Database is to be created.
- Create a preferred username, set a password and create the database.
- Download the PostgreSQL JDBC driver for JVM.
After Fiorano Platform installation, certain changes need to be made to the Fiorano setup for the Analytics database to connect to the PostgreSQL.
Changes to the Fiorano setup can be made from:
- Configuration file
- eStudio
- API Dashboard
From the configuration file
Open the apidb.cfg file present at $FIORANO_HOME/esb/server/profiles/server1/AMS/conf and make the following changes in the document:
Under the section 2, change the <ip-address>, <port> and <database> variables to the actual desired settings of the above installed PostgreSQL setup.
- Under section 3 and section 4 of this document, provide the username and password credentials needed to connect to the installed database.
- Under section 6 and 7, provide the reconnect settings of choice.
- Go to $FIORANO_HOME/esb/server/bin/server.conf and under the <java.classpath>segment, add the path to the above-downloaded JDBC driver so that the driver gets added to the classpath of the JVM.
From eStudio
This is Profile Management perspective in eStudio
- Launch the Profile Management perspective from Window > Open perspective > Profile Management and open the APIMANAGER profile.
- Right-click the APIMANAGER node and click the DB Configuration for API Management option.
Change values in this dialog box as required (refer to the properties in the From the configuration file section above). The changes will reflect in the apidb.cfg file.
From the API Dashboard
Analytics database can be configured from the API Dashboard itself after completing the API Management setup.
- Go to the Server Groups section in the Administration module.
Select the environment (Server Group) for which Analytics database needs to be configured and provide values.
Setting up
The following steps will provide you with step by step instructions on how to go about using the product.
Adding product licenses
The Fiorano API installers work with the same license as used by the main Fiorano Platform.
Starting API servers
Fiorano API Management product provides the server setups listed below:
- API Management Server (AMS)
- API Gateway Server (AGS)
API Management Server (AMS)
This is the control center of the API Management product. It is the place from where all the main deployments of API projects and policies are controlled. The API Dashboard is also hosted on this server.
Starting the API Management Server
To start the AMS server, please execute the following command at $FIORANO_HOME/esb/server/bin
Linux
LinuxWindows
API Gateway Server (AGS)
This is the server on which the projects are deployed. This server will be the place where clients will connect before their traffic is stored for analysis and from where requests are redirected to the backend target URLs. There can be multiple Gateway servers running on a single network controlled by an API Management Server.
Starting the API Gateway Server
To start the AGS server, execute the following command at $FIORANO_HOME/esb/server/bin:
Linux
Windows
Fiorano provides a pre-configured second Gateway Server Profile which can also be started by executing the following command at $FIORANO_HOME/esb/server/bin:
Linux
Windows
When both the servers start, the Command Prompt displays the content below as a confirmation of having successfully connected to the Cassandra database.
================ API traffic dataStore Initialized ================
In case you do not get the above statement on the Server Console and find errors as below, please check whether the Cassandra DB is running.
================ API traffic dataStore Initialization Failed ================
Launching the API Dashboard
Fiorano API Management uses a new API Management Dashboard as a client GUI to assist in configuring and maintaining the API servers and projects.
The dashboard is hosted at the following address after the starting of the AMS server:
After logging in with the credentials, the Dashboard should be displayed as in the following figure.
Figure 3: Fiorano API Management Dashboard