To add an auxiliary database to a deployment

Purpose

The following steps describe how to enable an auxiliary database in an NSP deployment and configure communication between the database and the NSP clusters and NFM-P main servers in the deployment.

CAUTION 

CAUTION

Service Disruption

This procedure requires a restart of each NFM-P main server, so is service-affecting.

Perform this procedure only during a scheduled maintenance period.

Note: You must perform the procedure in each data center.

Note: In a redundant deployment, you must perform the procedure first in the standby data center.

Note: The auxiliary database must be installed and running before you perform the procedure.

Note: After you perform the procedure:

Steps
Verify auxiliary database operation
 

Ensure that the auxiliary database is operational.

Note: After you add an auxiliary database to an NFM-P main server configuration, you cannot start the main server unless the auxiliary database is reachable by the main server.

  1. Log in to an auxiliary database station as the root user.

  2. Open a console window.

  3. Enter the following:

    /opt/nsp/nfmp/auxdb/install/bin/auxdbAdmin.sh status ↵

    The script displays the following:

    Database status

     Node       | Host          | State | Version | DB

    ------------+---------------+-------+---------+-------

     node_1 internal_IP_1 | STATE | version | db_name

     node_2 | internal_IP_2 | STATE | version | db_name

    .

    .

    .

     node_n | internal_IP_n | STATE | version | db_name

          Output captured in log_file

  4. If each STATE is not UP, contact technical support for assistance.


Configure TLS on auxiliary database station
 

Open the following file using a plain-text editor such as vi:

/opt/nsp/nfmp/auxdb/install/config/install.config


CAUTION 

CAUTION

Service disruption

Changing a parameter in the auxiliary database install.config file can have serious consequences that include service disruption.

Do not change any parameter in the install.config file, other than the parameters described in the step, without guidance from technical support.

Edit the following lines in the file to read as shown below:

Note: If you set the secure parameter to false, you do not need to configure the PKI-server parameters.

secure=value

pki_server=server

pki_server_port=port

where

value is true or false, and indicates whether TLS is enabled

server is the PKI server IP address or hostname

port is the PKI server port number


Save and close the install.config file.


Configure NFM-P main server
 

Log in to the main server station as the nsp user.


Open a console window.


Stop the main server.

  1. Enter the following:

    bash$ cd /opt/nsp/nfmp/server/nms/bin ↵

  2. Enter the following:

    bash$ ./nmsserver.bash stop ↵

  3. Enter the following:

    bash$ ./nmsserver.bash appserver_status ↵

    The server status is displayed; the server is fully stopped if the status is the following:

    Application Server is stopped

    If the server is not fully stopped, wait five minutes and then repeat this step. Do not perform the next step until the server is fully stopped.

  4. Enter the following to switch to the root user:

    bash$ su ↵

  5. If the NFM-P is not part of a shared-mode NSP deployment, enter the following to display the nspOS service status:

    nspdctl status ↵

    Information like the following is displayed.

    Mode:     redundancy_mode

    Role:     redundancy_role

    DC-Role:  dc_role

    DC-Name:  dc_name

    Registry: IP_address:port

    State:    stopped

    Uptime:   0s

    SERVICE           STATUS

    service_a         inactive

    service_b         inactive

    service_c         inactive

    You must not proceed to the next step until all NSP services are stopped; if the State is not ‘stopped’, or the STATUS indicator of each listed service is not ‘inactive’, repeat this substep.


Enter the following:

samconfig -m main ↵

The following is displayed:

Start processing command line inputs...

<main>


CAUTION 

CAUTION

Misconfiguration Risk

If the station IP-address order in each main server configuration is not identical, the auxiliary database addition fails.

Ensure that the auxiliary database station addresses are listed in the same order in each main server configuration.

In a geo-redundant auxiliary database deployment, the order of the IP addresses must match in each main server configuration in each data center.

Enter the following:

<main> configure auxdb enabled ip-list cluster_1_IP1,cluster_1_IP2,cluster_1_IPn;cluster_2_IP1,cluster_2_IP2,cluster_2_IPn

where

cluster_1_IP1, cluster_1_IP2,cluster_1_IPn are the external IP addresses of the stations in one cluster

cluster_2_IP1, cluster_2_IP2,cluster_2_IPn are the external IP addresses of the stations in the geo-redundant cluster; required only for geo-redundant auxiliary database

The prompt changes to <main configure auxdb>.


10 
CAUTION 

CAUTION

Misconfiguration Risk

After you configure any auxdb parameter on a main server and start the main server, you cannot modify the redundancy-level parameter.

Ensure that you are certain of the redundancy-level setting before you save the configuration.

Perform one of the following.

  1. If the auxiliary database is distributed among multiple stations, enter the following:

    <main configure auxdb> redundancy-level 1 exit ↵

  2. If the auxiliary database is deployed on one station, enter the following:

    <main configure auxdb> redundancy-level 0 exit ↵


11 

Enter the following:

<main> apply ↵

The configuration is applied.


12 

Enter the following:

<main> exit ↵

The samconfig utility closes.


13 

Enter the following to switch back to the nsp user:

exit ↵


Start main server, verify statistics migration
 
14 

Enter the following to start the main server:

bash$ /opt/nsp/nfmp/server/nms/bin/nmsserver.bash start ↵

The main server creates the required database elements and begins the migration of statistics data, if any, from the main database to the auxiliary database.


15 

In the event that a statistics migration fails on any auxiliary database station, the migration is retried up to 10 times. If after 10 retries the migration remains unsuccessful, the main server shuts down and displays the following message:

Failed to migrate Application Assurance statistics from main database to auxiliary database

If the migration fails, you must do the following:

  1. Restore the main database.

  2. Resolve the cause of the migration failure.

  3. Start the main server.


16 

Close the console window.


Configure NSP cluster
 
17 

If the NFM-P is in a shared-mode deployment, log in as the root user on the NSP deployer host in the local NSP cluster.

Otherwise, go to Step 23.


18 

Open the following file using a plain-text editor such as vi:

/opt/nsp/NSP-CN-DEP-release-ID/NSP-CN-release-ID/config/nsp-config.yml


19 

Locate the following section:

    auxDb:

      secure: "value"

      ipList: ""

      standbyIpList: ""


20 

Edit the section to read as follows:

Note: For a geo-redundant auxiliary database, ensure that you record the following, which must be correctly specified in the local NFM-P main server configuration:

  • ip_list addresses, which must be specified as the cluster_1 addresses on the main server

  • standby_ip_list addresses, which must be specified as the cluster_2 addresses on the main server

Note: You must preserve the leading spaces in each line.

    auxDb:

      secure: "value"

      ipList: "cluster_1_IP1,cluster_1_IP2...cluster_1_IPn"

      standbyIpList: "cluster_2_IP1,cluster_2_IP2...cluster_2_IPn"

where

cluster_1_IP1, cluster_1_IP2...cluster_1_IPn are the external IP addresses of the stations in the local cluster

value is true or false, and specifies whether TLS is enabled

cluster_2_IP1, cluster_2_IP2...cluster_2_IPn are the external IP addresses of the stations in the peer cluster; required only for geo-redundant deployment


21 

Save and close the nsp-config.yml file.


22 

Enter the following to start the NSP cluster:

Note: If the NSP cluster VMs do not have the required SSH key, you must include the --ask-pass argument in the command, as shown in the following example, and are subsequently prompted for the root password of each cluster mem7ber:

nspdeployerctl --ask-pass install --config --deploy

/opt/nsp/NSP-CN-DEP-release-ID/bin/nspdeployerctl install --config --deploy ↵

The NSP configuration is updated to include the auxiliary database.


Verify backup configuration
 
23 

Regular auxiliary database backups are strongly recommended. Ensure that scheduled database backups are enabled to ensure minimal data loss in the event of a failure. See the NSP System Administrator Guide for information.

End of steps