Create a Node Manager

This section describes how to configure your appliance as an Admin Node Manager or as a local Node Manager. This involves using the managedomain script to create the Node Manager. For more information on using managedomain, see the see the API Gateway Administrator Guide.

To create a Node Manager 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. The managedomain menu options are displayed:
  5. Host Management:
    1) Register host
    2) Edit a host
    3) Delete a host
    4) Change Admin Node Manager and/or credentials, currently connecting as:
    user 'admin' with truststore 'None'
    API Gateway Management:
    5) Create API Gateway instance
    6) Edit API Gateway (i.e., rename, change management port)
    7) Delete API Gateway instance
    8) Add a tag to API Gateway
    9) Delete a tag from API Gateway
    10) Add init.d script for existing local API Gateway
    Group Management:
    11) Edit group (i.e., rename)
    12) Delete a group
    Topology Management:
    13) Print topology
    14) Check topologies are in sync
    15) Check the Admin Node Manager topology against another topology
    16) Sync all topologies
    17) Reset the local topology
    Deployment:
    18) Deploy to a group
    19) List deployment information
    20) Create deployment archive
    21) Download deployment archive
    22) Update deployment archive properties
    23) Change group configuration passphrase
    Domain SSL certificates:
    24) Regenerate SSL certificates on localhost
    25) Sign Certificate Signing Request (CSR)
    26) Submit externally signed certificate
    q) Quit
  6. Choose option 1, Register host, and follow the instructions when prompted.
  7. To configure the appliance as an Admin Node Manager, enter y to configure an Admin Node Manager on the host. Alternatively, to configure the appliance as a local Node Manager, enter n to configure a local Node Manager that connects to the Admin Node Manager in the existing domain.
  8. For the appliance, it is recommended that init.d startup and shutdown scripts are created for Node Managers 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.
Note   If you intend to connect multiple appliances to a domain, you must use DNS-configured host names or the IP address for the Node Manager.
  1. When the Node Manager is successfully created, enter q to quit managedomain.
  2. Start the Node Manager. See Start the Node Manager service.

Example: Register a host as an Admin Node Manager

The following example shows the important selections to register a host as an Admin Node Manager:

Select option: 1
Is this the first host (Admin Node Manager) in the domain [y]:
Enter details of the new host to be registered...
Select/enter local hostname or IP address:
1) appliance
...
4) Enter hostname or IP address
Enter selection from 1-4 [1]: 4
Enter hostname or IP address: 192.0.2.165
Enter port [8090]:
Enter Node Manager name [Node Manager on 192.0.2.165]:
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]: 1
Enter passphrase for domain CA private key [none]:
Reenter passphrase for domain CA private key [none]:
Enter domain identifier to be used in dname of system generated domain certificate [Domain]:
Enter signing algorithm for certificates [sha1]:
Enter passphrase for temporary key files stored on disk [none]:
The default subject alternative names for the Node Manager's certificate are:
...
Accept the default subject alternative names [y]:
Do you want to create an init.d script for this Node Manager [n]: y
Enter user to run init.d script: admin
...
Completed successfully.
You may now start the Node Manager on your newly registered host.
API Gateway initial setup
The system has placed your domain private key into directory '/opt/apigateway/groups/
certs/private'. Please backup and protect the contents of this directory.
Hit enter to continue...

Example: Register a host as a local Node Manager

The following example shows the important selections to register a host as a local Node Manager:

Select option: 1
Is this the first host (Admin Node Manager) in the domain [y]: n
Enter details of the new host to be registered...
Select/enter local hostname or IP address:
1) appliance
...
4) Enter hostname or IP address
Enter selection from 1-4 [1]: 4
Enter hostname or IP address: 192.0.2.59
Enter port [8090]:
Enter Node Manager name [Node Manager on 192.0.2.59]:
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]: 1
Enter passphrase for domain CA private key [none]:
Does this new Node Manager have admin capabilities, i.e. is it an Admin Node Manager ? [n]:
Enter signing algorithm for certificates [sha1]:
Enter passphrase for temporary key files stored on disk [none]:
The default subject alternative names for the Node Manager's certificate are:
...
Accept the default subject alternative names [y]:
Enter details of the Admin Node Manager already registered in the domain...
Enter remote host: 192.0.2.165
Enter remote port [8090]:
Enter username [admin]:
Enter password:
Enter trust store filename:
Do you want to create an init.d script for this Node Manager [n]: y
Enter user to run init.d script: admin
...
Completed successfully.
You may now start the Node Manager on your newly registered host.
The system has placed your domain private key into directory '/opt/apigateway/groups/
certs/private'. Please backup and protect the contents of this directory.
Hit enter to continue...
Note   This example assumes that you have already created an Admin Node Manager on 192.0.2.165.

Start the Node Manager service

To start the Node Manager 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 Node Manager (for example, vshell-Node-Manager-on-10.142.10.86).
  4. Enter the following command to start the Node Manager:
  5. # service vshell-NODE_MANAGER_NAME start
  6. For example:
  7. # service vshell-Node-Manager-on-10.142.10.86 start

Related Links