Contents

Popular

Versions Compared

Old Version 38

changes.mady.by.user Prathewraj M

Saved on

compared with

New Version 39

changes.mady.by.user Prathewraj M

Saved on

Key

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

Table of Contents
indent15px
stylenone

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.

...

 The steps below illustrate how to install Fiorano API Management product as well as to launch the Fiorano API Dashboard:

 

Table of Contents
indent15px
stylenone
outlinetrue

Installing Fiorano API Management

Download Fiorano Platform using the .bin or .exe installer from http://www.fiorano.com/downloads/downloads.php which has an intuitive wizard to install the Fiorano setup as per scenario requirements.

Tip

...

Refer to the Installing Fiorano Platform documentation which lists the steps

...

for installing

...

Fiorano Platform.

Note

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

...

Anchor
_Toc396220940
_Toc396220940
Prerequisites

Installing Java

For the servers to run, JAVA1.8 (or higher versions) needs to be installed.

Info

Download and install Java 1.8 from http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html.

Installing Cassandra Database Server

Cassandra DB Server needs to be installed as Fiorano API  Management uses Cassandra 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. Cassandra Database is an open source database that provides

...

linear scalability and high availability with proven fault-tolerance

...

in storing details that need to be looked up on-the-fly.

...

Info

Download Cassandra Version 3.x from the link https://academy.datastax.com/planet-cassandra/cassandra and please refer to the directions provided

...

at http://cassandra.apache.org/doc/latest/getting_started/index.html to install Cassandra

...

Note

...

  • If Fiorano servers are running in different machines, after installing Cassandra, to enable the 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.

  • Before starting Cassandra 3.8 or 3.9 in Windows environment as a service, un-comment the property with name "cdc_raw_directory" in the cassandra.yaml file and set the value as <CASSANDRA_HOME>/data/cdc_raw.

    Info
    titleExample

     cdc_raw_directory: "C:/Program Files/DataStax-DDC/data/cdc_raw"

Continue with the steps mentioned in the next section.

Tip

...

To avoid a single point of failure Cassandra servers, configure Cassandra as a cluster.

...

  1. Install PostgreSQL on the machine where the Analytics Database is to be created.
  2. Create a desired user name, set a password and create the database.
  3. Download the PostgreSQL JDBC driver for JVM.
  4. Once Fiorano is installed, some changes need to be 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 choice.
    4. Go to $FIORANO_HOME/esb/server/bin/server.conf and under the <java.classpath>segment,add the path to the above downloadedJDBCdriver,sothat the driver gets added to the classpath of the JVM.

Fiorano API Management servers are preconfigured to use Cassandra Data Store URL and Keyspaces with default values as below:

  • DatastoreURL: localhost/9042
  • KeyspaceName: API

Advanced users may change these default values by following the steps mentioned in the Changing Cassandra Data Store URL and Keyspace values section.

Note

To avoid a single point of failure of Cassandra servers, configure Cassandra as a cluster.

Anchor
_Toc396220941
_Toc396220941
Setting up

The following steps will provide you with step by step instructions on how to go about using the product.

Anchor
_Toc396220942
_Toc396220942
Adding product licenses

The Fiorano API installers work with the same license as used by the main Fiorano Platform.

...

Please contact Fiorano Support at presales@fiorano.com

...

 for licenses. Once the licenses are received, copy them to the FIORANO_HOME/licenses directory.

Anchor
_Toc396220943
_Toc396220943
Starting API servers

Fiorano API Management product provides the server setups listed below:

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

Anchor
_Toc396220944
_Toc396220944
API Management Server (AMS)

This is the control center of the API Management product. It is the place from where all the main deployment of API projects and policies is controlled. The AMS acts as the central repository to create and access API projects. It hosts the API dashboard and incorporates Analytics engine apart from Managing access control and performing aggregation functions for APIs. The API Dashboard is also hosted on this server.

Note
titlePrerequisite

Before starting the AMS Server, perform the following actions to provide the DataStoreURL in the Server profile.

  1. Go to the eStudio Profile Management. 
  2. Navigate through the server profile <ServerProfile> > APIMANAGER > Fiorano > APIManager > DeveloperApps > DeveloperAppsManager

  3. Provide the IP address of the machine where the Cassandra DB is running in DataStoreURL property.

    Warning
    Provide the actual IP address as provided in the rpc_address property in the cassandra.yaml file instead of "localhost".
Tip

To configure/change keyspace, edit the KeyspaceName property. Default value is "API".

Image Removed
Figure 1: Fiorano API Manager Profile Management properties

Starting the API Management Server

To start the AMS server, please execute the following command at $FIORANO_HOME/esb/server/bin:

  • Linux

    Code Block
    titleLinux
    ./server.sh -mode ams -profile server1 –nobackground

  • Windows

    Code Block
    server.bat -mode ams -profile server1
Tip

To know how to shut down the server, refer to the Shutting down the AMS server section.

Anchor
_Toc396220945
_Toc396220945
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. AGS acts as a proxy server for backend REST/SOAP-based web services. It receives client requests and performs activities such as authentication, traffic control and other features like caching, load balancing, and quota management.

Info

There can be multiple Gateway servers running on a single network controlled by an API Management Server.

Note
titlePrerequisite

Before starting the AGS Server, perform the following actions to provide the DataStoreURL in the Server profile.

  1. Go to the eStudio Profile Management. 
  2. Navigate through the server profile <ServerProfile> > APIGATEWAY > Fiorano > APIGateway > APIGatewayManager

  3. Provide the IP address of the machine where the Cassandra DB is running in DataStoreURL property.

    Warning
     Provide the actual IP address as provided in the rpc_address property in the cassandra.yaml file instead of "localhost".
Tip

To configure/change keyspaces, edit the KeyspaceName property. Default value is "API".

Image Removed
Figure 2: Fiorano API Gateway Manager Profile Management properties

Starting the API Gateway Server

To start the AGS server, execute the following command at $FIORANO_HOME/esb/server/bin:

  • Linux

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

  • Windows

    Code Block
    server.bat -mode ags -profile server1

Fiorano provides a pre-configured second secondary 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
Tip

To know how to shut down the server, refer to the Shutting down the AGS server section.

When both the servers start, the Command Prompt 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 does not get displayed on the Server Console and find , but displays errors as below, please check whether the Cassandra DB is running.:

================ API traffic dataStore Initialization Failed ================

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

Anchor
_Toc396220946
_Toc396220946
Launching the API Dashboard

Fiorano API Management uses a new provides 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:

Code Block
http://<ip-address-of-installation-machine>:1981

After logging in with the credentials, the API Management Dashboard should be gets displayed as in the following figure.

Info

Default user name username and password are 'admin' and 'passwd' respectively).


Figure 31: Fiorano API Management Dashboard

 

Tip

 Analyzing the API management data

Fiorano provides an analytics tool to analyze the API traffic and other metrics. For storing these analytical data, Fiorano uses PostgreSQL as its datastore. Refer the Configuring Analytics Database section for configuring the same.

Configuring Analytics notifications

By configuring Mail Server in the Admin module of Fiorano API Management Dashboard, Analytics notifications can be received via email. Refer the Mail Server section to see the properties that need to be updated.

Adaptavist ThemeBuilder EngineAtlassian Confluence