How do I update the NSP system configuration?

Purpose

Perform this procedure to update one or more aspects of the NSP deployment; for example:

  • Change a parameter value.

  • Add an installation option.

  • Remove an installation option.

CAUTION 

CAUTION

Service Disruption

Performing the procedure requires a restart of each NSP cluster, which is service-affecting. During the restart, the NSP may be temporarily unavailable.

You must perform the procedure only during a scheduled maintenance period.

Note: You must perform the procedure on each NSP cluster.

Note: In a DR deployment, you must perform the steps first on the standby NSP cluster.

Steps
 
1 

Open a terminal session to the NSP deployer VM.

2 

Log in as the root or NSP admin user.

3 

If you intend to remove any installation options, stop the NSP cluster.

  1. 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

  2. Edit the following line in the platform section, kubernetes subsection to read as shown below:

      deleteOnUndeploy:false

  3. Save and close the file.

  4. Enter the following:

    # cd /opt/nsp/NSP-CN-DEP-release-ID/bin ↵

4 

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

Add or remove installation options
 
5 

Locate the installationOptions section in the nsp section, which resembles the following:

  installationOptions:

    - name: "NSP Platform - Base Services"

      id: platform-baseServices

    - name: "NSP Platform - Logging and Monitoring"

      id: platform-loggingMonitoring

#    - name: "Other Installation Option"

#      id: otherInstallationOption

6 

To add an installation option, uncomment the installation option name and id lines by removing the leading # character from each line.

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

7 

To remove an installation option, convert the installation option name and id lines to comments by inserting a # character at the beginning of each line.

Note: You must preserve the spaces that follow the # character.

Update parameters
 
8 

To enable a parameter that is currently disabled, uncomment the parameter line by removing the leading # character.

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

9 

To disable a parameter that is currently enabled, comment out the parameter line by restoring the leading # character.

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

10 

Configure parameter values, as required.

Save and deploy updated configuration
 
11 

Save and close the nsp-config.yml file.

12 

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 nspdeployerctl command, as shown in the following example, and are subsequently prompted for the root password of each cluster member:

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

# ./nspdeployerctl install --config --deploy ↵

The NSP cluster starts, and the configuration update is put into effect.

End of steps