Deploying the NCP Package

Installation Steps:

  • Extract the package

tar -I pbzip2 -xf ncp-r1.4.0-en.tar.bz2

  • Change the directory and start the installer

cd ncp-r1.4.0-en
sudo ./installer.sh

  1. NCP supports SSL certificate integration

    1. Select "y" if you want to integrate your own SSL certificate:

      Would you like to install a custom domain SSL certificate?
(If you select 'n', the installation will proceed with a self-signed certificate.)
[y/n]: y
→ Proceeding with custom domain SSL certificate installation..
Enter the path to the private key file: ./certs/server.pem
Enter the path to the certificate file: ./certs/server.crt.pem

      **Replace the Private key & certificate path to the correct location

    2. Select "n" if you wish to use a self-signed certificate included in the NCP package:

    Would you like to install a custom domain SSL certificate?
(If you select 'n', the installation will proceed with a self-signed certificate.)
[y/n]: n
→ Proceeding with self-signed certificates.

  2. Enable the Backup Feature

    1. When prompted during the installation,

      1. answer "y" to enable the DB backup feature.

      2. answer "n" to skip the DB backup feature.

    2. Select Backup Location

      1. Local Backup:

        1. When prompted, enter "local" as the backup location.

        2. Specify the backup directory (by default, NCP creates a ./backup directory):

          1. Example: Enter the backup directory: ./backup

      2. Remote Backup:

        1. When prompted, enter "remote" as the backup location.

        2. Provide the required remote details:

          1. Remote Machine IP: e.g., 10.0.0.1

          2. Remote Machine Username: e.g., admin

          3. Remote Machine Password: (entered securely)

          4. Remote Backup Directory: e.g., ~/backups

    3. Configure Backup File Retention

      1. The system defaults to storing 1 backup for both local and remote locations.

      2. You can modify the number of backup files to retain during installation. The acceptable range is between 1 and 3.

        1. Note: When you exceed the maximum number, the oldest backup will be automatically removed to accommodate the new backup.

    4. Set the Backup Interval

      1. Specify the backup interval in seconds at the prompt.

      2. The default interval is 86400 seconds (equivalent to 1 day), but it can be adjusted to suit your needs (minimum value is 3600 seconds).

  3. Enable the Backup Feature certificate-based authentication

    1. Enable Authentication

      1. When prompted during the installation,

        1. answer "y" to enable Authentication.

        2. answer "n" to skip Authentication.

    2. Provide Certificate Files

      1. If you chose "y", you’ll need to provide:

        1. ca-cert.pem

        2. server-cert.pem

        3. server-key.pem

        4. client-cert.pem

        5. client-key.pem

    3. Auto-Discovery Certificates

      1. Additional prompt for:

        1. ca-cert-reg.pem (used for agent registration)

          1. You may be asked to re-enter the same or new cert/key files.

    Would you like to enable certificate-based authentication between the Network Copilot controller and connected nodes?
[y/n]: y
Enter the path to the ca-cert.pem file: ./gnmi-certs/ca-cert.pem
Enter the path to the server-cert.pem file: ./gnmi-certs/server-cert.pem
Enter the path to the server-key.pem file: ./gnmi-certs/server-key.pem
Enter the path to the client-cert.pem file: ./gnmi-certs/client-cert.pem
Enter the path to the client-key.pem file: ./gnmi-certs/client-key.pem

Proceeding with certificates for Agent Auto Registration

Enter the path to the ca-cert-reg.pem file: ./gnmi-certs/ca-cert-reg.pem
Enter the path to the server-cert.pem file: ./gnmi-certs/server-cert.pem
Enter the path to the server-key.pem file: ./gnmi-certs/server-key.pem
Enter the path to the client-cert.pem file: ./gnmi-certs/client-cert.pem
Enter the path to the client-key.pem file: ./gnmi-certs/client-key.pem

  4. Wait for the installation to complete

aviz@ncp-llm01:~/ncp-r1.4.0-en$ sudo ./installer.sh
Starting Network Copilot Installer...

------------------------------------------------------------
Network Copilot is being installed for the first time.
Please review and select the appropriate options when prompted.
------------------------------------------------------------

Installing prerequisites...
→ Prerequisites installed.

Installing Network Copilot...

Would you like to install a custom domain SSL certificate?
(If you select 'n', the installation will proceed with a self-signed certificate.)
[y/n]: n
→ Proceeding with self-signed certificates.

Would you like to enable the database backup feature?
[y/n]: n
→ Database backup feature is disabled.

Would you like to enable certificate-based authentication between the Network Copilot controller and connected nodes?
[y/n]: n
→ Certificate-based authentication is disabled.

Setting up the environment and loading essential Docker containers...

Loaded image: aviz/ncp-gnmi-collector:v1.4.0
Loaded image: aviz/ncp-snmp-collector:v1.4.0

<...>

Network Copilot Installation Completed Successfully!

--------------------------------------------------------
You can now access the Network Copilot UI at: https://<host-ip>
--------------------------------------------------------

aviz@ncp-llm01:~/ncp-r1.4.0-en$

  • Verify the installation

aviz@ncp-llm01:~/ncp-r1.4.0-en$ docker-compose ps -a
        Name                       Command                  State                                                               Ports
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
ncp-api                 gunicorn main:app -w 4 -k  ...   Up             0.0.0.0:9001->8000/tcp,:::9001->8000/tcp
ncp-broker              /etc/confluent/docker/run        Up             0.0.0.0:29092->29092/tcp,:::29092->29092/tcp, 0.0.0.0:9092->9092/tcp,:::9092->9092/tcp,
                                                                        0.0.0.0:9101->9101/tcp,:::9101->9101/tcp
ncp-collector-db        /docker-entrypoint.sh postgres   Up             0.0.0.0:5432->5432/tcp,:::5432->5432/tcp, 8008/tcp, 8081/tcp
ncp-config-collector    java -jar -XX:MaxGCPauseMi ...   Up             8094/tcp
ncp-connect             /etc/confluent/docker/run        Up (healthy)   0.0.0.0:8083->8083/tcp,:::8083->8083/tcp, 9092/tcp
ncp-db                  docker-entrypoint.sh postgres    Up             5432/tcp
ncp-docker              python3 app.py                   Up
ncp-flow-collector      ./goflow2 -transport=kafka ...   Up             0.0.0.0:2055->2055/udp,:::2055->2055/udp, 0.0.0.0:6343->6343/udp,:::6343->6343/udp,
                                                                        0.0.0.0:8099->8080/tcp,:::8099->8080/tcp
ncp-gateway             ./gnmi-gateway -TargetLoad ...   Up             0.0.0.0:9339->9339/tcp,:::9339->9339/tcp
ncp-gnmi-collector      java -jar -XX:MaxGCPauseMi ...   Up             0.0.0.0:50053->50053/tcp,:::50053->50053/tcp, 8093/tcp
ncp-knowledgebase       chroma run --host 0.0.0.0  ...   Up             8000/tcp
ncp-ksqldb              /usr/bin/docker/run              Up             0.0.0.0:8088->8088/tcp,:::8088->8088/tcp
ncp-llm                 entrypoint.sh                    Up
ncp-schema-registry     /etc/confluent/docker/run        Up             0.0.0.0:8081->8081/tcp,:::8081->8081/tcp
ncp-snmp-collector      java -jar -XX:MaxGCPauseMi ...   Up             162/udp, 8093/tcp
ncp-streams-processor   java -jar /app/stream-proc ...   Up             8080/tcp
ncp-ui                  docker-entrypoint.sh node  ...   Up             3002/tcp, 0.0.0.0:443->443/tcp,:::443->443/tcp
ncp-zookeeper           /etc/confluent/docker/run        Up             0.0.0.0:2181->2181/tcp,:::2181->2181/tcp, 2888/tcp, 3888/tcp
aviz@ncp-llm01:~/ncp-r1.4.0-en$
PreviousInstalling Prerequisite PackagesNextManaging Network Copilot

Last updated

Was this helpful?