Contents

Popular

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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 we will need , 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 like such as the subscriptions, clients, and distributed quotas etc.
  • PostgreSQL DB PostgreSQL DB Server - This is your the analytics database, all . All analytics data being tracked at the proxy is stored and fetched from here for processing.

We have created a The step by step guide below is to assist you with the installation of these and the the above servers as well as the Fiorano API Management product; this guide also tells you how . In addition, it sets out steps to access the Fiorano API Dashboard.

...

  1. Install the product with the .bin or .exe installer of the product; run the installer which gives you has an intuitive wizard to install the Fiorano setup as per your needsscenario requirements.

    Tip

    You can also Alternatively, refer to the Installing Fiorano Platform documentation which takes you through lists the steps of needed for installing the Fiorano Platform.

    Note

    Further in In this document, "$FIORANO_HOME" refers to the Fiorano Setup installation directory.

  2. Install a Cassandra Database Server and PostgreSQL server.

    1. Cassandra Database is an open source database that provides unmatched linear scalability and high availability with proven fault-tolerance and is used to store details that need to be looked up on the fly.

      Tip
      • After installing Cassandra, to enable the DB database to be accessed from other machines, open the cassandra.yaml file present in the conf folder of Cassandra, and set the rpc_address property to the IP address of the system where Cassandra DB is running.
    2. Fiorano uses PostgreSQL for its analytics data store. To configure PostgreSQL for analytics, perform the following actions:
      1. Install PostgreSQL on the machine where you want your the Analytics Database is to be created.
      2. Create your a desired user name, set the desired a password and create the database that you want Fiorano to use for the purpose.
      3. Download the PostgreSQL JDBC driver for your JVM and keep it ready for the later steps.
      4. Once Fiorano is installed, some changes need to be done in made to the Fiorano setup for the Analytics to connect to the PostgreSQL. To do this, open the apidb.cfg file present at $FIORANO_HOME/esb/server/profiles/server1/AMS/conf and make the following changes in the document:
        1. Under section 2, change the <ip-address>, <port> and <database> variables to the actual desired settings of the above installed PostgreSQL setup.
        2. Under section 3 and section 4 of this document, provide the username and password credentials needed to connect to the installed database.
        3. Under section 6 and 7, provide the reconnect settings of your choice.
        4. Go to $FIORANO_HOME/esb/server/bin/server.conf and under the <java.classpath>segment,add the path to the above downloaded JDBCdriver,so that the driver gets added to the classpath of the JVM.

Now you are ready for the setup. You may continue Continue with the steps mentioned in the next section.

...

Note

Please contact Fiorano Support at presales@fiorano.com in case you face license issuesif there are queries regarding the license.

Anchor
_Toc396220943
_Toc396220943
Starting API servers

Fiorano API Management product provides you with the below server setups listed below:

  • API Management Server (AMS)
  • API Gateway Server (AGS)

...

This is the control center of the API Management product. It is the place from where all the main deployment of your API projects and policies will be is controlled. The API Dashboard is also hosted on this server.

Note

Before starting the AMS Server, provide the DataStoreURL in the Server profile, that is, go to eStudio Profile Management, navigate through the following in the server profile, and provide the IP address of the machine where the Cassandra DB is running in DataStoreURL property:

  <ServerProfile>APIManager > Fiorano > APIMANAGER > DeveloperApps > DeveloperAppsManager

...

This is the server on which the projects get are deployed. This server will be the place to which the where clients will connect before their traffic is stored for analysis and request is from where requests are redirected to the backend target URLs. There can be multiple Gateway Servers servers running on a single network controlled by an API Management Server.

Note

Before starting the AGS Server, provide the DataStoreURL in the Server profile, that is, go to eStudio Profile Management, navigate through the following in the server profile, and provide the IP address of the machine where the Cassandra DB is running in DataStoreURL property:

<ServerProfile> APIGATEWAY > Fiorano > APIGateway > APIGatewayManager

...

  • Linux

    Code Block
    ./server.sh -mode ags -profile server1 –nobackground
  • Windows

    Code Block
    server.bat -mode ags -profile server1

Fiorano also provides you with a pre-configured second Gateway Server Profile which can also be started by executing the following command at $FIORANO_HOME/esb/server/bin:

  • Linux

    Code Block
    ./server.sh -mode ags -profile server2 –nobackground
  • Windows

    Code Block
    server.bat -mode ags -profile server2

Both When both the servers should start without any issues, and should display the below content on console as the Command Prompt displays the content below as a confirmation of having successfully connected to the Cassandra database.

================ API traffic dataStore Initialized ================

...

Note
  1. Default Cassandra setup should be listening to port 9042 for connections.
  2. For higher security, we suggest it is suggested running the Gateway server with SSL enabled on the Jetty.

...

After logging in with the user name and password credentials, the Dashboard looks should be displayed as in the following figure.

...

Adaptavist ThemeBuilder EngineAtlassian Confluence