System Install

Install NSO for production use in a system-wide deployment.

Installation Steps

Complete the following activities in the given order to perform a System Install of NSO.

Prepare

1. Fulfill System Requirements 2. Download Installer/NEDs 3. Unpack the Installer

Install

4. Run the Installer

Finalize

5. Set up User Access 6. Set Environment Variables 7. Runtime Directory Creation 8. Generate License Token

Step 1 - Fulfill System Requirements

Start by setting up your system to install and run NSO.

To install NSO:

1. Fulfill at least the primary requirements.

2. If you intend to build and run NSO deployment examples, you also need to install additional applications listed under Additional Requirements.

Primary Requirements

Primary requirements to do a System Install include:

• Linux for x86_64 architecture is required for production. Linux or macOS Darwin for x86_64 or macOS Darwin for arm64 is required for development purposes.

• GNU libc 2.24 or higher.

• Java JRE 17 or higher. Used by Cisco Smart Licensing.

• Required and included with many Linux/macOS distributions:

  • tar command. Unpack the installer.

  • gzip command. Unpack the installer.

  • ssh-keygen command. Generate SSH host key.

  • openssl command. Generate self-signed certificates for HTTPS.

  • find command. Used to find out if all required libraries are available.

  • which command. Used by the NSO package manager.

  • libpam.so.0. Pluggable Authentication Module library.

  • libexpat.so.1. EXtensible Markup Language parsing library.

  • libz.so.1 version 1.2.7.1 or higher. Data compression library.

Additional Requirements

Additional requirements to, for example, build and run NSO production deployment examples, include:

• Java JDK 17 or higher.

• Ant 1.9.3 or higher.

• Python 3.7 or higher.

• Python Setuptools is required to build the Python API.

• Often installed using the Python package installer pip:

  • Python Paramiko 2.2 or higher. To use netconf-console.

  • Python requests. Used by the RESTCONF demo scripts.

• xsltproc command. Used by the support/ned-make-package-meta-data command to generate the package-meta-data.xml file.

• One of the following web browsers is required for NSO GUI capabilities. The version must be supported by the vendor at the time of release.

  • Safari

  • Mozilla Firefox

  • Microsoft Edge

  • Google Chrome

• OpenSSH client applications. For example ssh and scp commands.

• cron. Run time-based tasks, such as logrotate.

• logrotate. rotate, compress, and mail NSO and system logs.

• rsyslog. pass NSO logs to a local syslog managed by rsyslogd and pass logs to a remote node.

• systemd or init.d scripts to start and stop NSO.

Step 2 - Download the Installer and NEDs

To download the Cisco NSO installer and example NEDs:

1. Go to the Cisco's official Software Download site.

2. Search for the product "Network Services Orchestrator" and select the desired version.

3. There are two versions of the NSO installer, i.e. for macOS and Linux systems. For System Install, choose the Linux OS version.

Identifying the Installer

You need to know your system specifications (Operating System and CPU architecture) to choose the appropriate NSO Installer.

NSO is delivered as an OS/CPU-specific signed self-extractable archive. The signed archive file has the pattern nso-VERSION.OS.ARCH.signed.bin that after signature verification extracts the nso-VERSION.OS.ARCH.installer.bin archive file, where:

• VERSION is the NSO version to install.

• OS is the Operating System (linux for all Linux distributions and darwin for macOS).

• ARCH is the CPU architecture, for example, x86_64.

Step 3 - Unpack the Installer

If your downloaded file is a signed.bin file, it means that it has been digitally signed by Cisco, and upon execution, you will verify the signature and unpack the installer.bin.

If you only have installer.bin, skip to the next step.

To unpack the installer:

1. In the terminal, list the binaries in the directory where you downloaded the installer, for example:

   cd ~/Downloads
   ls -l nso*.bin
   -rw-r--r--@ 1 user  staff   199M Dec 15 11:45 nso-6.0.linux.x86_64.installer.bin
   -rw-r--r--@ 1 user  staff   199M Dec 15 11:45 nso-6.0.linux.x86_64.signed.bin

2. Use the sh command to run the signed.bin to verify the certificate and extract the installer binary and other files. An example output is shown below.

   sh nso-6.0.linux.x86_64.signed.bin
   # Output
   Unpacking...
   Verifying signature...
   Downloading CA certificate from http://www.cisco.com/security/pki/certs/crcam2.cer ...
   Successfully downloaded and verified crcam2.cer.
   Downloading SubCA certificate from http://www.cisco.com/security/pki/certs/innerspace.cer ...
   Successfully downloaded and verified innerspace.cer.
   Successfully verified root, subca and end-entity certificate chain.
   Successfully fetched a public key from tailf.cer.
   Successfully verified the signature of nso-6.0.linux.x86_64.installer.bin using tailf.cer

3. List the files to check if extraction was successful.

   ls -l
   # Output
   -rw-r--r--  1 user  staff   1.8K Nov 29 06:05 README.signature
   -rw-r--r--  1 user  staff    12K Nov 29 06:05 cisco_x509_verify_release.py
   -rwxr-xr-x  1 user  staff   199M Nov 29 05:55 nso-6.0.linux.x86_64.installer.bin
   -rw-r--r--  1 user  staff   256B Nov 29 06:05 nso-6.0.linux.x86_64.installer.bin.signature
   -rwxr-xr-x@ 1 user  staff   199M Dec 15 11:45 nso-6.0.linux.x86_64.signed.bin
   -rw-r--r--  1 user  staff   1.4K Nov 29 06:05 tailf.cer

Description of Unpacked Files

The following contents are unpacked:

• nso-VERSION.OS.ARCH.installer.bin: The NSO installer.

• nso-VERSION.OS.ARCH.installer.bin.signature: Signature generated for the NSO image.

• tailf.cer: An enclosed Cisco signed x.509 end-entity certificate containing the public key that is used to verify the signature.

• README.signature: File with further details on the unpacked content and steps on how to run the signature verification program. To manually verify the signature, refer to the steps in this file.

• cisco_x509_verify_release.py: Python program that can be used to verify the 3-tier x.509 certificate chain and signature.

NED Packages

The NED Packages that are available with the NSO Installation are netsim-based example NEDs. These NEDs are used for NSO examples only.

Fetch the latest production-grade NEDs from Cisco Software Download using the URLs provided on your NED license certificates.

Manual Pages

The installation program will unpack the NSO manual pages from the documentation archive in $NCS_DIR/man. ncsrc makes an addition to $MANPATH, allowing you to use the man command to view them. The manual pages are available in HTML and PDF formats and from the online documentation located on NCS man-pages, Volume 1 in Manual Pages.

Following is a list of a few of the installed manual pages:

• ncs(1): Command to start and control the NSO daemon.

• ncsc(1): NSO Yang compiler.

• ncs_cli(1): Frontend to the NSO CLI engine.

• ncs-netsim(1): Command to create and manipulate a simulated network.

• ncs-setup(1): Command to create an initial NSO setup.

• ncs.conf: NSO daemon configuration file format.

For example, to view the manual page describing the NSO configuration file you should type:

$ man ncs.conf

Apart from the manual pages, extensive information about command line options can be obtained by running ncs and ncsc with the --help (abbreviated -h) flag.

$ ncs --help

$ ncsc --help

Installer Help

Run the sh nso-VERSION.linux.x86_64.installer.bin --help command to view additional help on running binaries. More details can be found in the ncs-installer(1) manual page included with NSO and also available from the online documentation on DevNet.

Notice the two options for --local-install or --system-install.

sh nso-6.0.linux.x86_64.installer.bin --help

Step 4 - Run the Installer

To run the installer:

1. Navigate to your Install Directory.

2. Run the installer with the --system-install option to perform System Install. This option creates an Install of NSO that is suitable for production deployment.

   $ sudo sh nso-VERSION.OS.ARCH.installer.bin --system-install

   For example:

   $ sudo sh nso-6.0.linux.x86_64.installer.bin --system-install

Default Directories

The System Install by default creates the following directories:

• The Installation Directory is created in /opt/ncs, where the distribution is available.

• The Configuration Directory is created in /etc/ncs, where the ncs.conf file, SSH keys, and WebUI certificates are created.

• The Running Directory is created in /var/opt/ncs, where runtime state files, CDB database, and packages are created.

• The Log Directory is created in /var/log/ncs, where the log files are populated. Also, init scripts are created in /etc/init.d/ncs and system-wide environment variables are created in /etc/profile.d/ncs.sh.

For the --system-install option, you can also choose a user-defined (non-default) Installation Directory, Configuration Directory, Running Directory, and Log Directory with --install-dir, --config-dir, --run-dir and --log-dir parameters, and specify that NSO should run as a different user than root with the --run-as-user parameter.

If you choose a non-default Installation Directory by using --install-dir, you need to specify --install-dir for subsequent installs and also for backup and restore.

For more information on ncs-installer, see the ncs-installer(1) man page.

For an extensive guide to NSO deployment, refer to Deployment Example.

Disable Memory Overcommit

By default, the Linux kernel allows overcommit of memory. However, memory overcommit produces an unexpected and unreliable environment for NSO since the Linux Out Of Memory Killer, or OOM-killer, may terminate NSO without restarting it if the system is critically low on memory. Also, when the OOM-killer terminates NSO, no system dump file will be produced, and the debug information will be lost. Thus, it is strongly recommended that overcommit is disabled.

To achieve this with immediate effect, give the command:

# echo 2 > /proc/sys/vm/overcommit_memory

When overcommit_memory = 2, the /proc/sys/vm/overcommit_ratio parameter defines the percent of the physical RAM + swap space used. The default is "50", or 50%. This setting will underutilize RAM usage if the system has more physical RAM than 50%.

Setting the overcommit_ratio parameter to 100 will include any swap if present. On-disk memory (swap) gives the advantage of having more memory available in case an application needs more RAM than physically available momentarily. But it is usually slow, and thus best practice is to refrain from using the swap for NSO. To allocate physical RAM only, set the overcommit_ratio parameter to 100 * ((RAM - swap space) / RAM).

If the system's physical RAM (MemTotal) is less than or equal to the swap space (SwapTotal), using the swap cannot be avoided and the overcommit_ratio should be set to 100.

Example 1: Physical RAM (MemTotal) > Swap Space (SwapTotal)

# cat /proc/meminfo | grep "MemTotal\|SwapTotal"
MemTotal:    8039352 kB
SwapTotal:   1048572 kB

Calculate the overcommit ratio:

100 * ((8039352-1048572)/8039352) = ~86.9%

To set both overcommit parameters with immediate effect:

# echo 2 > /proc/sys/vm/overcommit_memory
# echo 86.9 > /proc/sys/vm/overcommit_ratio

Example 2: Physical RAM (MemTotal) == Swap Space (SwapTotal)

# cat /proc/meminfo | grep "MemTotal\|SwapTotal"
MemTotal:    16000000 kB
SwapTotal:   16000000 kB

To set both overcommit parameters with immediate effect:

# echo 2 > /proc/sys/vm/overcommit_memory
# echo 100 > /proc/sys/vm/overcommit_ratio

To ensure the overcommit remains disabled after reboot, adjust the overcommit_ratio parameter to match your system memory and add the two lines to the /etc/sysctl.conf file. See the Linux sysctl.conf(5) manual page for details.

Refer to the Linux proc(5) manual page for more details on the overcommit_memory and overcommit_ratio parameters.

If NSO aborts due to failure to allocate memory, NSO will produce a system dump by default before aborting. When starting NSO from a non-root user, set the NCS_DUMP environment variable to point to a filename in a directory that the non-root user can access. The default setting is NCS_DUMP=ncs_crash.dump, where the file is written to the NSO run-time directory, typically NCS_RUN_DIR=/var/opt/ncs. If the user running NSO cannot write to the directory the NCS_DUMP environment variable points to, generating the system dump file will fail, and the debug information will be lost.

Some older NSO releases expect the /etc/init.d/ folder to exist in the host operating system. If the folder does not exist, the installer may fail to successfully install NSO. A workaround that allows the installer to proceed is to create the folder manually, but the NSO process will not automatically start at boot.

Step 5 - Set Up User Access

The installation is configured for PAM authentication, with group assignment based on the OS group database (e.g. /etc/group file). Users that need access to NSO must belong to either the ncsadmin group (for unlimited access rights) or the ncsoper group (for minimal access rights).

To set up user access:

1. To create the ncsadmin group, use the OS shell command:

   # groupadd ncsadmin

2. To create the ncsoper group, use the OS shell command:

   # groupadd ncsoper

3. To add an existing user to one of these groups, use the OS shell command:

   # usermod -a -G 'groupname' 'username'

Step 6 - Set Environment Variables

To set environment variables:

1. Change to Super User privileges.

   $ sudo -s

2. The installation program creates a shell script file in each NSO installation which sets the environment variables needed to run NSO. With the --system-install option, by default, these settings are set on the shell. To explicitly set the variables, source ncs.sh or ncs.csh depending on your shell type.

   # source /etc/profile.d/ncs.sh

3. Start NSO.

   # /etc/init.d/ncs start

   Once you log on with the user that belongs to ncsadmin or ncsoper, you can directly access the CLI as shown below:

   $ ncs_cli -C

Step 7 - Runtime Directory Creation

As part of the System Install, the NSO daemon ncs is automatically started at boot time. You do not need to create a Runtime Directory for System Install.

Step 8 - Generate License Registration Token

To conclude the NSO installation, a license registration token must be created using a (CSSM) account. This is because NSO uses Cisco Smart Licensing to make it easy to deploy and manage NSO license entitlements. Login credentials to the Cisco Smart Software Manager (CSSM) account are provided by your Cisco contact and detailed instructions on how to create a registration token can be found in the Cisco Smart Licensing. General licensing information covering licensing models, how licensing works, usage compliance, etc., is covered in the Cisco Software Licensing Guide.

To generate a license registration token:

1. When you have a token, start a Cisco CLI towards NSO and enter the token, for example:

   admin@ncs# license smart register idtoken
   YzIzMDM3MTgtZTRkNC00YjkxLTk2ODQtOGEzMTM3OTg5MG
   
   Registration process in progress.
   Use the 'show license status' command to check the progress and result.

   Upon successful registration, NSO automatically requests a license entitlement for its own instance and for the number of devices it orchestrates and their NED types. If development mode has been enabled, only development entitlement for the NSO instance itself is requested.

2. Inspect the requested entitlements using the command show license all (or by inspecting the NSO daemon log). An example output is shown below.

   admin@ncs# show license all
   ...
   <INFO> 21-Apr-2016::11:29:18.022 miosaterm confd[8226]:
   Smart Licensing Global Notification:
   type = "notifyRegisterSuccess",
   agentID = "sa1",
   enforceMode = "notApplicable",
   allowRestricted = false,
   failReasonCode = "success",
   failMessage = "Successful."
   <INFO> 21-Apr-2016::11:29:23.029 miosaterm confd[8226]:
   Smart Licensing Entitlement Notification: type = "notifyEnforcementMode",
   agentID = "sa1",
   notificationTime = "Apr 21 11:29:20 2016",
   version = "1.0",
   displayName = "regid.2015-10.com.cisco.NSO-network-element",
   requestedDate = "Apr 21 11:26:19 2016",
   tag = "regid.2015-10.com.cisco.NSO-network-element",
   enforceMode = "inCompliance",
   daysLeft = 90,
   expiryDate = "Jul 20 11:26:19 2016",
   requestedCount = 8
   ...

Evaluation Period

If no registration token is provided, NSO enters a 90-day evaluation period and the remaining evaluation time is recorded hourly in the NSO daemon log:

      ...
<INFO> 13-Apr-2016::13:22:29.178 miosaterm confd[16260]:
Starting the NCS Smart Licensing Java VM
<INFO> 13-Apr-2016::13:22:34.737 miosaterm confd[16260]:
Smart Licensing evaluation time remaining: 90d 0h 0m 0s
...
<INFO> 13-Apr-2016::13:22:34.737 miosaterm confd[16260]:
Smart Licensing evaluation time remaining: 89d 23h 0m 0s
...

Communication Send Error

During upgrades, If you experience a 'Communication Send Error' during license registration, restart the Smart Agent.

If You are Unable to Access Cisco Smart Software Manager

In a situation where the NSO instance has no direct access to the Cisco Smart Software Manager, one option is the Cisco Smart Software Manager Satellite which can be installed to manage software licenses on the premises. Install the satellite and use the command call-home destination address http <url:port> to point to the satellite.

Another option when direct access is not desired is to configure an HTTP or HTTPS proxy, e.g., smart-license smart-agent proxy url https://127.0.0.1:8080. If you plan to do this, take the note below regarding ignored CLI configurations into account:

If ncs.conf contains configuration for any of java-executable, java-options, override-url/url or proxy/url under the configure path /ncs-config/smart-license/smart-agent/, then any corresponding configuration done via the CLI is ignored.

License Registration in HA Mode

When configuring NSO in High Availability (HA) mode, the license registration token must be provided to the CLI running on the primary node. Read more about HA and node types in High Availability.

Licensing Log

Licensing activities are also logged in the NSO daemon log as described in Monitoring NSO. For example, a successful token registration results in the following log entry:

<INFO> 21-Apr-2016::11:29:18.022 miosaterm confd[8226]:
Smart Licensing Global Notification:
type = "notifyRegisterSuccess"

Check Registration Status

To check the registration status, use the command show license status.

admin@ncs# show license status

Smart Licensing is ENABLED

Registration:
Status: REGISTERED
Smart Account: Network Services Orchestrator
Virtual Account: Default
Export-Controlled Functionality: Allowed
Initial Registration: SUCCEEDED on Apr 21 09:29:11 2016 UTC
Last Renewal Attempt: SUCCEEDED on Apr 21 09:29:16 2016 UTC
Next Renewal Attempt: Oct 18 09:29:16 2016 UTC
Registration Expires: Apr 21 09:26:13 2017 UTC
Export-Controlled Functionality: Allowed

License Authorization:

License Authorization:
Status: IN COMPLIANCE on Apr 21 09:29:18 2016 UTC
Last Communication Attempt: SUCCEEDED on Apr 21 09:26:30 2016 UTC
Next Communication Attempt: Apr 21 21:29:32 2016 UTC
Communication Deadline: Apr 21 09:26:13 2017 UTC

System Install FAQs

Frequently Asked Questions (FAQs) about System Install.

Is there a dependency between the NSO Installation Directory and Runtime Directory?

No, there is no such dependency.

Do you need to source the ncsrc file before starting NSO?

No. By default, the environment variables are configured and set on the shell with System Install.

Can you start NSO from a directory, which is not a NSO runtime directory?

Yes.

Can you stop NSO from a directory, which is not a NSO runtime directory?

Yes.

For evaluation and development purposes, instead of a Local Install, you performed a System Install. Now you cannot build or run NSO examples as described in README files. How can you proceed further?

The easiest way is to Uninstall the System install using ncs-uninstall --all and do a Local Install from scratch.

Can we move NSO Installation from one folder to another ?

No.