Contents

Popular

Versions Compared

Key

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

...

Anchor
_Toc396220940
_Toc396220940
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.

Tip

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

Note

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

...

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.

Tip

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

Note

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"

Tip

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

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 desired user namepreferred username, set a password and create the database.
  3. Download the PostgreSQL JDBC driver for JVM.Once

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:

  1. 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.

  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 -downloaded JDBC driver so that the driver gets added to the classpath of the JVM.

Continue with the steps mentioned in the next section.


  1. Image Added

From eStudio

This is Profile Management perspective in eStudio

  1. Launch the Profile Management perspective from Window > Open perspective > Profile Management and open the APIMANAGER profile.
  2. Right-click the APIMANAGER node and click the DB Configuration for API Management option.
  3. 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.

    Image Added

From the API Dashboard

Analytics database can be configured from the API Dashboard itself after completing the API Management 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 Added

 

Anchor
_Toc396220941
_Toc396220941
Setting up

...

This is the control center of the API Management product. It is the place from where all the main deployment deployments of API projects and policies is are controlled. 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".
tip
Configuring Keyspace for AMS

To configure/change keyspace, edit the KeyspaceName property

. Default

below the DataStireURL property configured above. The KeyspaceName default value is "API".


Figure 1: Fiorano API Manager Profile Management properties

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 Added

Starting the API Management Server

...

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.

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

To configure/change

keyspaces

keyspace, edit the KeyspaceName property.

Default

The default value is "API".


Figure 2: Fiorano API Gateway Manager Profile Management properties

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

...

Adaptavist ThemeBuilder EngineAtlassian Confluence