CA API Gateway 9.1

9.4 9.1

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.
gateway83
To configure a single
CA API Gateway
 or 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
standalone
 Software 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
localhost
.
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:
  • Multi-node clustering is not available. The Gateway will behave as a single-node cluster.
  • Service metrics (in the Gateway Dashboard) are not available
    .
  • The FTP Audit Archiver is not available.
Gateway Currently Unconfigured
When option
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.
Step
Description
Set Up the Gateway Java VM
This step directs the Gateway to the Java VM to use.
  • Java VM Path:
     Enter the path to the Java Virtual Machine, or press [
    Enter
    ] to keep the existing path.
  • Java VM Memory Allocation:
     Enter the amount of memory to allocate to the Java Virtual Machine or press [
    Enter
    ] to keep the existing setting. You must allocate at least 256MB RAM.
Choose a database
Choose the database connection to use:
  • Enter
    yes
     to configure a connection to a MySQL database. This is the default.
  • Enter
    no
     to use the embedded database. The first prompt you will see is "Set Up the SSM Administrator" below.
Set Up the CA API Gateway Database
(Only applies to MySQL database connections)
This step sets up a new Gateway database.
  • Database Host:
     Enter the name or IP address of the database server or press [
    Enter
    ] to keep the existing name. If the database is installed on the same server as the Gateway node, then enter
    localhost
     in this field.
  • Database Port:
     Enter the port number to use or press [
    Enter
    ] to keep the existing port.
  • Database Name:
     Enter the name of the Gateway database or press [
    Enter
    ] to keep the existing name. New databases default to the name "ssg" or will use the name of the overwritten database.
  • Database Username:
     Enter the name of the user who has access to the database or press [
    Enter
    ] to keep the existing user. The default name is
    gateway
    .
  • Database Password:
     Enter the password for the database. Retype it for confirmation. The default password is
    7layer
    .
  • Administrative Database Username:
     Enter the user name of the root MySQL user. This name is entered only when the database is created.
  • Administrative Database Password:
     Enter the password of the root MySQL user. This password was set during the installation of the MySQL server.
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.
  • SSM Username:
     Enter the name of the SSM administrator.
  • SSM Password:
     Enter the password of the SSM administrator, then retype to confirm.
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.
  • Administrative HTTPS Listener:
     Enter
    yes
     to change either the listener IP address (default "*" all) or listener port number (default "8443"). Enter
    no
     to use the defaults.
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.
  • Cluster Host:
     Enter the Gateway cluster fully qualified domain name (FQDN) used to identify the Gateway and to generate the SSL certificate. An example of a hostname:
    clusterhostname.mycompany.com
    .
  • Cluster Password:
     Enter a password to protect the cluster, between 6-129 characters. Retype to confirm.
If you need to change the
cluster host name, do the following using the Policy Manager:
  1. Set the cluster property
    cluster.hostname
     to the new name of the host. 
  2. Create a new private key using the
    Manage Private Keys
     task. Be sure to set this key as the default SSL key. 
    For more information, see "Creating a Private Key" and "Private Key Properties".
  3. Restart all nodes in the cluster for the new cluster host name to take effect.
Configuration Summary
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.
Configuration Results
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
When option
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:
  • Enter
    1
     to 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. 
  • Enter
    2
     to 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.
  • Enter
    3
     to be guided through the steps to configure a failover connection for the database. 
  • Enter
    4
     to 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.

Content feedback and comments