Configure the Gateway Application (Software)
To configure a single gateway or the first processing node of a cluster, select option 2 (Configure the Gateway) from the Gateway main menu.
To configure a single
Layer7 API Gatewayor the first processing node of a cluster, select option
2(Configure the Gateway) from the Gateway main menu.
The configuration process is slightly different depending on whether the Gateway has been configured once before or if this is the first time the Gateway is configured, and whether an embedded database is chosen.
The instructions in this section describe how to set up a
standaloneSoftware Gateway. For directions on configuring a
cluster, see Configure a Gateway Cluster instead.
Using the Embedded Database
When creating a new Gateway database, you have the option of configuring a connection to a MySQL database or using the built-in embedded (non-MySQL) database on the Gateway.
The embedded database is designed for environments where it is not possible to have a separate MySQL instance. For example, your security policy may forbid operating MySQL or any other network-accessible SQL database, even on
The embedded database is also ideal for testing or evaluating the CA API Gateway, as it can be set up quickly, without relying on an external database.
Note the following limitations when an embedded database is in effect:
Gateway Currently Unconfigured
2(Configure the Gateway) is selected for a Gateway or node that is currently unconfigured, the configurator will gather the required information.
At any time during the configuration, you may type "quit" to cancel the configuration or "<" to return to the previous configuration step.
The following table summarizes the configuration steps.
Set Up the Gateway Java VM
This step directs the Gateway to the Java VM to use.
Choose a database
Choose the database connection to use:
Set Up the CA API Gateway Database
(Only applies to MySQL database connections)
This step sets up a new Gateway database.
Set Up the SSM Administrator
This step defines the Policy Manager administrator. This is the "super user" who has access to every feature in the Policy Manager.
To set up additional Policy Manager administrators or to change the password of the administrator entered here, use the Policy Manager. For more information, see "Changing a Password" and "Creating an Internal User"
Set Up the CA API Gateway Gateway Administrative HTTPS Listener
This step lets you change the default settings for the administrative listener. This listener may also be modified using the Manage Listen Ports task in the Policy Manager. Additional listeners may be created there as well.
If you do not create a listener, a default one will be created for you. Use the Manage Listen Ports task to create additional listeners or modify the configuration of existing listeners.
Set Up the CA API Gateway Cluster
Enter the host name and password for the Gateway cluster. Note: A standalone Gateway is considered to be a cluster of one.
If you need to change thecluster host name, do the following using the Policy Manager:
Carefully review the configuration settings. To make corrections, type "<" to return to the appropriate step, and then complete the configuration steps as before. Press [Enter] to apply the settings.
Displays a success message or lists the errors encountered.
If errors were found, make a note of the error messages and run the configurator again. If no errors were detected, you may start the Gateway now. If configuring a cluster, you may now configure the subsequent nodes.
Gateway Already Configured
2(Configure the Gateway) is selected for a Gateway or node that has already been configured, you can choose which settings to modify:
Select option to configure: 1) Java VM 2) Database Connection 3) Configure Database Failover Connection 4) Cluster Configuration S) Save and exit X) Exit without saving
Select the option to configure:
- Enter1to modify the Java VM settings. For information on these settings, see the step "Set Up the CA API Gateway Gateway Java VM" in the previous table.
- Enter2to modify the database connection settings. For information on these settings, see the step "Set Up the CA API Gateway Gateway Database" in the previous table.
- Enter3to be guided through the steps to configure a failover connection for the database.
- Enter4to change the cluster passphrase. For information, see the step "Set Up the Gateway Cluster" in the previous table. Note that only the cluster passphrase can be modified, not the cluster hostname.
To retain the existing value for a setting, press [
Enter] without entering a value.