Configuring Cassandra Data Store URL and Keyspace values
Contents
API management installation preconfigures the datastore URL for the IP address of the local system (localhost) and the port number (9042). If the Cassandra server is running on a different system, the cassandra datastore URL needs to be configured in the API Management and API Gateway server profiles accordingly.
Similarly, the keyspace is also preconfigured as "API". The default value can be changed as per requirement.
The sections below illustrate steps to configure the Datastore URL as well as the Keyspace in the API Management Server and API Gateway server respectively.
API Management Server (AMS)
Configuring DataStoreURL for AMS
Before starting the AMS Server, perform the following actions to provide the DataStoreURL in the Server profile.
- Open the eStudio Profile Management view.
- Navigate through the server profile <ServerProfile> > APIMANAGER > Fiorano > APIManager > DeveloperApps > DeveloperAppsManager.
In the DataStoreURL property, provide the IP address or hostname of the machine where the Cassandra DB is running and the port on which it is listening to. See the figure below.
Replace "localhost" with the actual IP address as provided in the rpc_address property in the cassandra.yaml file present in the conf directory in the Cassandra installation location.
Configuring Keyspace for AMS
To configure keyspace with the new valuevalue (the default value is "API"), edit the KeyspaceName property present below the DataStireURL property explained above.
Figure 1: DataStoreURL and Keyspace properties for AMS
The same URL and keyspace name has to be configured in the all API Gateway servers as well. However, avoid configuring same values for different Fiorano 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 the keyspace with a new value value (the default value is "API"), edit the KeyspaceName property present below the DataStoreURL property explained above.
Figure 2: DataStoreURL and Keyspace properties for API Trace in AMS
API Gateway Server (AGS)
This is the server on which projects are deployed. Clients connect to the AGS server before their traffic is stored for analysis and then 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.
Configuring DataStoreURL for AGS
Before starting the AGS Server, perform the following actions to provide the DataStoreURL in the Server profile.
- Open the eStudio Profile Management view.
- Navigate through the server profile <ServerProfile> > APIGATEWAY > Fiorano > APIGateway > APIGatewayManager
Provide the IP address of the machine where the Cassandra DB is running in DataStoreURL property.
Provide the actual IP address as provided in the rpc_address property in the cassandra.yaml file instead of "localhost". See the figure below.
Configuring Keyspace for AGS
To configure the keyspace with the new value (the default value is "API"), edit the KeyspaceName property.
Figure 3: DataStoreURL and Keyspace properties for API Trace in AGS
The URL and keyspace name have to be the same as configured in the API Manager. However, avoid configuring same values for different Fiorano environments.