Install Cisco Optical Network Planner

Cisco Optical Network Planner Overview

Cisco Optical Network Planner (Cisco ONP) provides a way to model and test Optical Transport Network (OTN) and Dense Wavelength Division Multiplexing (DWDM) optical networks in a graphical environment. The primary use of Cisco ONP is to design and validate networks of NCS 1004, NCS 2000 and NCS 4000 series. Use the Cisco ONP tool, to create multiple instances of a network, modify different parameters in each instance and compare the instances.

Hardware and Software Requirements

The hardware and software requirements for installing Cisco ONP are:

Hardware Requirements

You need UCS server or Linux VM with Ubuntu 18.04.3 and 20.04.3.

Recommended Server Configuration for Cisco ONP and LNI:

  • 8 CPU, 48 GB RAM, and 500GB server free space after installation, for 3 concurrent Parallel ONP analysis with LNI of 500 devices

  • 8 CPU, 64 GB RAM, and 500GB server free space after installation, for 6 concurrent Parallel ONP analysis with LNI of 500 devices

  • 8 CPU, 96 GB RAM, and 500GB server free space after installation, for 10 concurrent Parallel ONP analysis with LNI of 500 devices

Software Requirements
  • Clients require the latest version of the Google Chrome browser.

  • Recommended version of the Google Chrome browser:

    • For Windows: Version 94.0.4606.61

    • For Mac: Version 93.0.4577.82


    Note

    Minimum 100Mbps internet speed is recommended for better Cisco ONP user experience.


Install Cisco ONP

The Cisco ONP application is delivered as a bundled tar file package. The tar file (CONP-xx.xx.xx.tar.gz) contains the following files:

  • ONP component

  • LNI component

  • A shell script (ONPLniinstaller.sh) to install both ONP and LNI components

Use this procedure to install Cisco ONP by using the tar archive and the installation script:

Procedure


Step 1

Log into the server, where Cisco ONP is to be installed.

Step 2

Create the directory home/ONP_Builds in the server.

Example:

mkdir ONP_Builds
Note 

The path /home/ONP_Builds is referenced as $ONP_HOME in this document.

The $ONP_HOME directory in this example can be any other directory in the server. You can create a directory of your choice and copy the ONP build tar file to that directory.

Step 3

Copy the Cisco ONP build tar into the created ONP_Builds directory.

Step 4

Copy the Cisco ONP signature and public key file into the created directory.

Step 5

Go to the $ONP_HOME directory.

Step 6

Assign full permission to the build tar.

Example:

cd /home/ONP_Builds
sudo chmod 777 CONP-xx-xx.xx.tar.gz
Step 7

Untar the Cisco ONP build.

tar -xvf CONP-xx-xx-xx.tar.gz
Step 8

Set read, write, and execute permissions for the Install script, LNI, and ONP folders using the following commands.

sudo chmod -R 775 ONP
sudo chmod -R 775 LNI
sudo chmod 775 ONPLniInstaller.sh
Step 9

Check whether curl is installed in the server by entering the following command:

root:~/$ONP_HOME# curl

If you see the following output, curl is installed. Otherwise, install curl.

curl: try 'curl --help' or 'curl --manual' for more information

To install curl, run the following command:

root:~/$ONP_HOME# Sudo apt install curl
Step 10

Start Cisco ONP installation. Type command “sudo ./ <install file> <tar file> PUBLIC_KEY,” and press Enter.

Example:
sudo ./ONPLniInstaller.sh CONP-xx.xx.xx.xx.tar.gz CONP-xx.xx.xx.xx.tar.gz_pem.pubkey 
Would you like to change the IP (y/n)

If you enter n, the installation proceeds with the same IP address as mentioned above and if you enter y, you must provide the IP address and the installation proceeds with the IP address that is provided by you.

ONP Host IP: 10.76.82.14
LNI Host IP: 10.76.82.14
Step 11

Enter your ONP database credentials:

Note 

If you are installing Cisco ONP for the first time, you must set the username and password to access the database.

Enter your ONP database username, only alphanumeric characters are valid [user]:
Enter your ONP database password, only alpha numeric characters are valid (len >= 8 and <= 64 characters) [password]:
Repeat your ONP database password.
Step 12

Enter your LNI database credentials:

Please enter your Username LNI database: (Maximum 12 chars)
Please enter Password for LNI database (Min chars, Maximum 64 chars):
Please repeast Password for LNI database (Min chars, Maximum 64 chars):
Step 13

Enter the disk space for the log storage:

Application will reserve 10 GB for logs. Do you want to change this value? (y/n):
Please enter maximum avaialble disk space in GB for log storage (from 5 to 50):
Step 14

Enter the encryption key for device credentials:

Do you want to provide encryption key for device credentials (y/n):

If you enter n, Cisco ONP uses the default encryption key. If you want to provide encryption key for the LNI device, enter y and enter the encryption key.

Please enter encryption key for device credentials (Min 8 chars, Max 64 chars):

Wait for the installation to complete.

The Cisco ONP services start automatically, after you successfully install the build.

The install logs are located in the following path:

/var/log/cnp/install.log

Step 15

Run the following command to see the list of services running:

root:~/$ONP_HOME# docker ps

You can confirm the successful installation based on whether the following services are up and running for more than five minutes:

  • cnp_frontend

  • cnp

  • cnp_ode.1

  • cnp_ode.2

  • cnp_ode.3

  • cnp_mongo

  • lni_mongo

  • lni_modelaggregatorservice

  • modelaggregator_cnp_lni-service

  • topology_cnp_lni-service

  • inventory_cnp_lni-service

  • circuit_cnp_lni-service

  • devicemanager_cnp_lni-service

  • collector_cnp_lni-service

  • kibana

  • apigw_cnp_lni-service

  • kafka

  • zookeeper

  • servicediscovery-service

  • tl1adapter_cnp_lni-service

  • ncplugin_cnp_lni

  • inventory2kadapter_cnp_lni-service

  • netconfadapter_cnp_lni-service

  • inventory1kadapter_cnp_lni-service

  • inventory4kadapter_cnp_lni-service

  • t1plugin_cnp_lni-service

  • mongo_cnp_lni

  • lnibroker_cnp_lni-service

  • elasticsearch

  • logstash

  • mongo:4.0.18

Step 16

After the successful installation, log into Cisco ONP server and start using the application.

After you confirm that all the above mentioned services are up, you can access the Cisco ONP URL.

The docker storage volumes are located at the following locations:

  • /var/log/cnp

  • /var/lib/mongodb_cnp

  • /opt/cnp/conf/

  • /var/log/nginx

  • /opt/cnp/nginx/conf


Log into Cisco ONP

After installing Cisco ONP, use this procedure to log into the Cisco ONP user interface.

Procedure


Step 1

Open the Google Chrome browser.

Note 

Clear the browser cache if you have used earlier versions of Cisco ONP.

Step 2

In the browser’s address line, enter https://ipaddress/, where ipaddress is the IP address of the server on which Cisco ONP is installed.

The Cisco ONP user interface displays the Login window.

Step 3

Enter admin and cisco123 as the default username and password.

Step 4

Click Login to log into Cisco ONP.

Note 

Cisco ONP prompts you to change the administrator password, when you login for the first time after installation. Do not use the default administrator username after installation, because if you happen to forget it,you cannot reset the administrator password. We recommend that you create a new user with valid email ID, activate the same when Cisco ONP is installed.


Update Self-Signed Certificates

Use this procedure to update the self-signed certificates for Cisco ONP, after the installation:

Procedure


Step 1

Log into the server where Cisco ONP is hosted.

Step 2

Go to the path /opt/cnp/nginx/conf/ssl using “cd” command.

Example:
cd /opt/cnp/nginx/conf/ssl 
Step 3

Paste the certificates and key.

Step 4

Restart the dockers using the following commands:

  • docker service rm $(docker service ls -q)
  • cd images/conf 
  • docker stack deploy -c docker-compose.yml --resolve-image=never cnp

Restart Cisco ONP

Use this procedure to restart the Cisco ONP server:

Procedure


Step 1

Go to $ONP_HOME.

Step 2

Execute the following command:

sudo docker stack rm cnp
Step 3

Execute the following command from $ONP_HOME/ONP:

sudo docker stack deploy -c images/conf/docker-compose.yml --resolve-image=never cnp  
Step 4

Execute the following commands from $ONP_HOME/LNI:

sudo bash ciscoLniInstaller.sh -o start -t update -m offlinemode
sudo bash ciscoLniInstaller.sh -o start -t update -m offlinemode

Uninstall Cisco ONP

Warning: When you uninstall Cisco ONP, you will lose all created networks and users. You must again set the admin password.


Note

We suggest that you perform a database backup before uninstallation.


Use these commands to uninstall Cisco ONP:


Note

You must run the following commands with root or sudo permission.


docker swarm leave --force

apt -y purge docker-ce
apt -y purge docker-ce-cli
rm -rf /var/lib/mongodb_cnp
rm -rf /opt/cnp
rm -rf /var/log/cnp
rm -rf /var/log/nginx
 
docker image prune -a -f
rm -rf /var/lib/mongodb_lni
rm -rf /var/lib/elasticsearch_data/*
rm -rf ONP
rm -rf LNI
rm -rf ONPLniInstaller.sh

Docker Commands

The following table lists the docker commands, that you can use for performing a specific task:

Task Docker Command
Check installed docker version. docker -v docker --version
List available docker images. docker images
List all running containers. docker ps
List all running and exited containers. docker ps -a
Remove a particular container. docker rm <container ID/ container name>
Remove a particular docker image. docker rmi <Image name / Image ID>
Fetch the logs of a container. docker logs -f <container ID>
Fetch the resource utilization by a container. docker stats <container ID>

Monitor Cisco ONP Health

To check the status or health of Cisco ONP, use the following command, which lists all running containers:

$sudo docker ps 

Cisco ONP Logs

Cisco ONP provides the following logs:

Table 1. Logs

Logs

Description

Container Logs

The command sudo docker ps provides the list of running containers and their IDs. Copy the container ID of that container whose log you require.

You can obtain the log or activities of the container by using the following command:

sudo docker logs (container name/ID) > filename.log/txt 

Example:

sudo docker logs cnp > file.log
sudo docker logs 274a5fc1152b > file.log

Application Logs

You can find Cisco ONP application logs in the following locations:

  • /var/log/cnp

  • /var/log/nginx

If carbon patch is 5, it is under/var/log/.

Install Logs

You can find Cisco ONP install logs in the following location:

/var/log/cnp