Create an API Gateway instance

This section describes how to configure an API Gateway instance. This involves using the managedomain script to create the API Gateway instance. For more information on using managedomain, see the see the API Gateway Administrator Guide.

To create an API Gateway instance on the appliance using managedomain, follow these steps:

  1. Log in to the appliance using the default administrator account (user name admin ) and use su - to switch to the root user after logging in. You can log in locally or using SSH. For more information, see Connect to consoles and user interfaces.
  2. Enter the managedomain --menu command to run the managedomain utility.
  3. Enter the domain user name and password.
  4. Choose option 5, Create API Gateway instance and follow the instructions when prompted. After entering a name and group for the new API Gateway instance, you can accept the defaults.
  5. For the appliance, it is recommended that init.d startup and shutdown scripts are created for API Gateway instances and that the processes are executed with non-root user privileges. Enter y when prompted by managedomain to create an init.d script and enter the administrator user as the user to run the script.
  1. When the API Gateway instance is successfully created, enter q to quit managedomain.
  2. Start the API Gateway instance. See Start the API Gateway service.
Note   You must have a valid license file to run an API Gateway instance. For more information, see API Gateway prerequisites.

Example: Create API Gateway instance on Admin Node Manager appliance

The following example shows the important selections to create a new API Gateway instance called APIGateway1 in the group Group1 on an appliance configured as an Admin Node Manager:

Select option: 5
Enter API Gateway name: APIGateway1
Enter group name: Group1
Select a host:
1) 192.0.2.165
2) Enter host name
Enter selection from 1-2 [192.0.2.165]:
Enter local management port for instance [8085]:
Enter external traffic port for instance [8080]:
Do you want to create an init.d script for this instance [n]: y
Enter user to run init.d script: admin
Select option for certificate management for internal SSL communications:
1) Use system generated CA key and certificate to sign all SSL certificates
2) Use user provided CA key and certificate to sign all SSL certificates
3) All SSL certificates must be signed by an external CA
Enter selection from 1-3 [1]:
Enter passphrase for domain CA private key [none]:
Enter signing algorithm for certificates [sha1]:
Enter passphrase for temporary key files stored on disk [none]:
...
The new API Gateway 'APIGateway1' in group 'Group1' has been successfully created and
installed
Hit enter to continue...

Example: Create API Gateway instance on local Node Manager appliance

The following example shows the important selections to create a new API Gateway instance called APIGateway2 in the group Group1 on an appliance configured as a local Node Manager:

Select option: 5
Enter API Gateway name: APIGateway2
Select a group:
1) Group1
2) Enter group name
Enter selection from 1-2 [2]: 1
Select a host:
1) 192.0.2.165
2) 192.0.2.59
3) Enter host name
Enter selection from 1-3 [192.0.2.59]:
Enter local management port for instance [8085]:
Enter external traffic port for instance [8080]:
Do you want to create an init.d script for this instance [n]: y
Enter user to run init.d script: admin
Select option for certificate management for internal SSL communications:
1) Use system generated CA key and certificate to sign all SSL certificates
2) Use user provided CA key and certificate to sign all SSL certificates
3) All SSL certificates must be signed by an external CA
Enter selection from 1-3 [1]:
Enter passphrase for domain CA private key [none]:
Enter signing algorithm for certificates [sha1]:
Enter passphrase for temporary key files stored on disk [none]:
...
The new API Gateway 'APIGateway2' in group 'Group1' has been successfully created and
installed
Hit enter to continue...

Start the API Gateway service

To start the API Gateway service, follow these steps:

  1. Log in to the appliance using the default administrator account (user name admin ) and use su - to switch to the root user after logging in. You can log in locally or using SSH. For more information, see Connect to consoles and user interfaces.
  2. Change to the /etc/init.d directory.
  3. Verify that a script exists in this directory for the API Gateway (for example, vshell-Group1-APIGateway1).
  4. Enter the following command to start the Node Manager:
  5. # service vshell-GROUP_NAME-INSTANCE_NAME start
  6. For example:
  7. # service vshell-vshell-Group1-APIGateway1 start

Related topics

Create a Node Manager

Related Links