APIIDA API Gateway Manager
Prepare the Gateway
Activate Restman
APIIDA API Gateway Manager makes use of Layer7’s Restman service to communicate with the gateway and exchange data. To install the REST Management API from the Policy Manager
In Policy Manager select [Tasks] > Services and APIs > Publish Internal Service from the menu
Select “Gateway REST Management Service” from the list
Click [Finish] to publish the service.
The Gateway REST Management Service is created and resides inside the root folder.
The Restman service should not be accessible from the outside. We encourage our customers to restrict access to Restman to a listen port, that is only accessible from within a secure zone. For more information on how to properly secure Restman see the official documentation for the Layer7 platform.
Install APIIDA Solution Kit
In order to use the API Gateway Manager’s metrics functionality you need to install the APIIDA solution kit on all gateways you want to collect metrics from. The metrics are automatically pushed to the internal or external Prometheus server, so you can access them not only from inside of the Gateway Manager, but also from other tools like Grafana. If you do not plan to use the metrics feature, you can skip this step.
The APIIDA Solution Kit is currently limited to gateways, that are backed by a MySQL database. Ephemeral gateways are not supported. For information on how to gather metrics for ephemeral gateways check our Blog or Broadcom’s documentation.
Create a JDBC Connection to Access the Gateway’s Database
The Solution Kit retrieves the metrics data from the gateway’s database. In order to do so, you must create a JDBC connection. Please ask your system administrator for the connection info to the database used by this gateway or cluster. The user only needs read rights to the database. APIIDA does not issue any changes to your gateway’s database.
Click on [Tasks] > [Data Sources] > [Manage JDBC Connections]
Click on [Add] to create a new JDBC connection
Enter the following details
Connection Name: aagm_db
Driver Class: com.l7tech.jdbc.mysql.MySQLDriver or com.mysql.jdbc.Driver
JDBC URL: The connection string for the database (i.e. jdbc:mysql://localhost:3306/ssg)
Username: The username for the database
Password: The password for the database
Click [Test]
When the test is successful click [Save]
Install the Solution Kit
Download the latest solution kit from https://apiida.com/download/?lang=en
In Policy Manager, select [Tasks] > [Extension and Add-Ons] > [Manage Solution Kits] from the menu
Click on [Install]
Click on [File]
Select the *.sskar file you just downloaded
Click on [Next]
Review the following screen and resolve conflicts if necessary. In case Policy Manager does not pick up the JDBC connection automatically, you have to map it in this screen.
After clicking [Finish] the solution kit is installed
In gateway version 10.1 and older, you must restart the gateway.
The gateways are now prepared, continue with the installation.