Contents

Popular

Versions Compared

Old Version 9

changes.mady.by.user Prathewraj M

Saved on

compared with

New Version 10

changes.mady.by.user User

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 Fiorano API Management product. In addition, it sets out steps to access the Fiorano API Dashboard.

...

Installing Fiorano API Management

Install the product with Download Fiorano platform using the .bin or .exe installer of the product; run the installer which from http://www.fiorano.com/downloads/downloads.php which has an intuitive wizard to install the Fiorano setup as per scenario requirements.

Tip

Alternatively, refer Refer to the Installing Fiorano Platform documentation which lists the steps needed for involved in installing the Fiorano Platform.

Note

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

Installing Cassandra Database Server

...

Anchor
_Toc396220940
_Toc396220940
Prerequisites

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

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 unmatched linear scalability and high availability with proven fault-tolerance in storing details that need to be looked up on-the-fly.

...

Note

After installing Cassandra, to enable the database to be accessed from other machines(if fiorano servers are running in different 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"

Tip

To configure Cassandra Keyspaces in the AMS and AGS servers, refer to the following sections in this page:

  • API Management Server (AMS): Configuring Keyspace for AMS
    • API Gateway Server (AGS): Configuring Keyspace for AGS

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

    • DatastoreURL: localhost
    • KeyspaceName: API

    These default values may be changed by the advanced users 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.

    Installing and configuring PostgreSQL to set up Analytics database

    Fiorano uses PostgreSQL for its analytics data store.

    1. Install PostgreSQL on the machine where the Analytics Database is to be created.
    2. Create a preferred username, set a password and create the database.
    3. 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.

    Note

    Ensure usage of a different database for separate installations of API platform.

    ...

    From eStudio

    This is Profile Management perspective in eStudio

    ...

    From the API Dashboard

    Analytics database can be configured from the API Dashboard itself after completing the API Dashboard setup.

    1. Go to the Server Groups section in the Administration module.

    2. Select the environment (Server Group) for which Analytics database needs to be configured and provide values.

      Tip

      Refer the Configuring Analytics Database section for details.

      Image Removed
      Figure 3: Analytics DB properties in the Server Groups section in the Administration section of API Dashboard

    Configuring the Mail Server to receive Analytics notifications

    Configure the Mail Server section in the Administration module in the API Management Dashboard. Refer the Mail Server section to see the properties that need to be updated.

    Note

    This configuration can be done only after completing the API Dashboard setup.

    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 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 deployments of API projects and policies are controlled. The AMS acts as 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
    Configuring DataStoreURL for AMS

    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".
    Configuring Keyspace for AMS

    To configure/change keyspace, edit the KeyspaceName property below the DataStireURL property configured above. The KeyspaceName default value is "API".

    Image Removed
    Figure 4: DataStoreURL and Keyspace properties for AMS

    Note

    The same value has to be configured in the API Gateway as well, while it needs to be different for different environments.

    Configuring API Trace and keyspace for AMS

    API Trace tracks API calls passing through the API management server and stores into the cassandra database. Edit the DataStoreURL at <ServerProfile> > APIMANAGER > Fiorano > APIManager > trace > APITraceManager to configure the database.

    To configure/change keyspace, edit the KeyspaceName property below the DataStireURL property configured above. The KeyspaceName default value is "API".

    Image Removed
    Figure 5: DataStoreURL and Keyspace properties for API Trace in AMS

    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

    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 URLsAGS acts as a proxy server for backend REST/SOAP based web services. It receives client requests and performs authentication, traffic control and other features like Caching, load balancing, quota management and more. There can be multiple Gateway servers running on a single network controlled by an API Management Server.

    Note
    titlePrerequisite
    Configuring DataStoreURL for AGS

    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".
    Configuring Keyspace for AGS

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

    Image Removed
    Figure 6: DataStoreURL and Keyspace properties for API Trace in AGS

    Note

    The value has to be the same as configured in the API Manager, while it needs to be different for different environments.

    Starting the API Gateway Server

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

    ...

    Note
    1. Default Cassandra setup should be listening to port 9042 for connections.
    2. For higher security, it is suggested running 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 Dashboard should be displayed as in the following figure.

    Info

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


    Figure 71: Fiorano API Management Dashboard

     

    Tip

     Analyzing the API management data

    Fiorano provides an analytics tool to analyse the api traffic and other metrics. For storing this 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 APIManagement 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