NSP configuration file

nsp-config.yml file format

CAUTION Password Exposure

The NSP cluster configuration may include text-based truststore and keystore passwords that can be exposed.

To avoid exposing a password, you are strongly encouraged to store the NSP configuration file in a secure location outside the NSP management network.

In order to deploy an NSP cluster, you must specify system parameters, installation options, and additional components in the following NSP configuration file on the NSP deployer host:

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

The nsp-config.yml file has the following main sections:

• platform—defines the following for the mandatory platform-baseServices installation option:

  • deployment type, for example, standalone or DR

  • NSP IP addressing scheme

  • container environment

• nsp—defines the NSP deployment; includes the following subsections:

  • deployment—system scale, license, DR, backup configuration

  • installationOptions—NSP installation options to include in the deployment

  • modules—internal nspOs functions such as security and health monitoring, optional system functions

  • integrations—other systems to integrate, for example, NFM-P or WS-NOC

  • sso—single sign-on configuration for system access

A section begins with a header and section label, followed by descriptive text and one or more parameter lines. An example section layout is shown below.

################################################################

## platform - Platform specific configs                       ##

################################################################

platform:

   ## parameter_1     - This is the parameter 1 description.

   ## parameter_2     - This is the parameter 2 description.

   ## parameter_3     - This is the parameter 3 description.

   # parameter_1=

   # parameter_2=

    parameter_3=true

To enable a parameter, delete the leading # symbol from the parameter line. In the example, only parameter_3 is enabled and configured.

Note: You must preserve the lead spacing of each line. Ensure that you delete only the # symbol, and no spaces, from a parameter line.

Note: In the event of a discrepancy between information in a configuration file and the NSP documentation, or if the documentation fails to adequately describe a specific configuration, the configuration file information is to be followed and considered correct. Also, the NSP Release Notice describes configuration updates and corrections that are not captured in the core documentation.

Enabling installation options

The installationOptions section lists all available installation options. You enable the deployment of an option by removing the leading # character from the name and id lines of the option.

Note: NSP Platform - Base Services is mandatory and enabled by default.

In the example below, the following are enabled, and NSP Platform - Pluggable Network Adaptation is disabled:

• NSP Platform - Base Services (mandatory)

• NSP Platform - Logging and Monitoring

• Network Infrastructure Management - Basic Management

  installationOptions:

    - name: "NSP Platform - Base Services"

      id: platform-baseServices

    - name: "NSP Platform - Logging and Monitoring"

      id: platform-loggingMonitoring

#    - name: "NSP Platform - Pluggable Network Adaptation"

#      id: platform-pluggableNetworkAdaptation

    - name: "Network Infrastructure Management - Basic Management"

      id: networkInfrastructureManagement-basicManagement