Upgrade NetQ Software on Your Server

Upgrade NetQ Software on Your Server

This document describes the steps required to upgrade the NetQ Software (versions 2.0.x, 2.1.x, and 2.2.0) installed and running on your own server hardware to NetQ version 2.2.1.

Cumulus Networks recommends upgrading NetQ only during a network maintenance window.

Any data you have collected while using NetQ 2.1.0 or later is maintained during this upgrade process.

Events generated during the upgrade process will not be available in the database. Once the upgrade process is complete, the NetQ Agents resynchronize with the current state of the Host or Cumulus Linux switch with the NetQ Server.

Prerequisites

Before you begin the upgrade process, please note the following:

  • The minimum supported Cumulus Linux version for NetQ 2.2.x is 3.3.2.
  • You must upgrade your NetQ Agents as well as the NetQ Platform.
  • You can upgrade to NetQ 2.2.x without upgrading Cumulus Linux.
  • The NetQ installer pod netq-installer should be up in either the Containercreating or Running state. The netq-installer pod state could also be ContainerCreating, in which case the host is initializing with the SSH keys.

Hardware Requirements

Cumulus NetQ software is supported on a variety of hardware.

You must meet these minimum hardware requirements to install the VM and have it run properly.

The NetQ software requires a server with the following:

Hardware Component Minimum On-site Requirement Minimum Cloud Requirement
Processor Eight (8) virtual CPUs Four (4) virtual CPUs
Memory 64 GB RAM 8 GB RAM
Local disk storage 256 GB SSD (Note: This must be an SSD; use of other storage options can lead to system instability and are not supported.) 32 GB (SSD not required)
Network interface speed 1 Gb NIC 1 Gb NIC

You must also open the following ports on your hardware to use the NetQ software:

Port Deployment Type Software Component Access
31980 On-site and cloud NetQ Server
32708 On-site API Gateway
32666 On-site Web-based User Interface

NetQ Platform HyperVisor Requirements

The NetQ Platform can be installed as a Virtual Machine (VM) using one of the following hypervisors:

  • VMware ESXi™ 6.5 for servers running Cumulus Linux, CentOS, Ubuntu and RedHat operating systems.
  • KVM/QCOW (QEMU Copy on Write) image for servers running CentOS, Ubuntu and RedHat operating systems.

NetQ Agent Operating System Requirements

NetQ 2.2 Agents are supported on the following switch and host operating systems:

  • Cumulus Linux 3.3.2 and later
  • Ubuntu 16.04
  • Red Hat® Enterprise Linux (RHEL) 7.1
  • CentOS 7

Upgrade Your NetQ Server

To upgrade the NetQ software onto your own hardware using a VM image:

  1. IMPORTANT: Confirm that your server hardware meets the requirements set out above.

  2. Download the NetQ software VM upgrade image.

    1. On the Cumulus Downloads page, select NetQ from the Product list box.
    2. Click 2.2 from the Version list box, and then select 2.2.x from the submenu.
    3. Optionally, select the hypervisor you wish to use (VMware, VMware (cloud), KVM, or KVM (cloud)) from the Hypervisor/Platform list box.

      If you are upgrading an on-premises solution, select either VMware or KVM.

      If you are upgrading an in-cloud solution, select either VMware (Cloud) or KVM (Cloud).

      For customers with VMware/ESXi OVA deployments, Cumulus Networks recommends deploying a fresh installation of NetQ 2.2.1, rather than performing the upgrade from 2.1.x or 2.2.0, to take advantage of the performance improvements available with the new vmxnet3 and Paravirtualization SCSI drivers. Customers with on-premises deployments must backup their NetQ data prior to the fresh installation to retain their data, and then follow the installation with a restoration. Follow the instructions in Backup and Restore NetQ and Install NetQ Software on Your Server.

    4. Scroll down to review the images that match your selection criteria.

    5. Click Upgrade for the relevant version, being careful to select the correct deployment version.

  3. From a terminal window, log in to the NetQ Server using your login credentials. This example uses the default cumulus/CumulusLinux! credentials.

    <computer>:~<username>$ ssh cumulus@netq-platform
    cumulus@netq-platform's password: 
    cumulus@netq-platform:~$ 
    
  4. Change to the root user.

    cumulus@netq-platform:~$ sudo -i
    [sudo] password for cumulus:
    root@netq-platform:~#
    
  5. Create an installables subdirectory in the mount directory.

    root@netq-platform:~# mkdir -p /mnt/installables/
    
  6. Copy the upgrade image file into your new directory. The on-site file is named NetQ-2.2.1.tgz and the cloud file is named NetQ-2.2.1-opta.tgz.

    root@netq-platform:~# cd /mnt/installables/
    root@netq-platform:/mnt/installables# cp /home/usr/dir/<NetQ-package>.tgz ./ 
    
  7. Export the installer script.

    root@netq-platform:/mnt/installables# tar -xvf <NetQ-package>.tgz ./netq-install.sh
    
  8. Verify the contents of the directory. You should have the package file and the netq-install.sh script.

    root@netq-platform:/mnt/installables# ls -l
    total 9607744
    -rw-r--r-- 1 cumulus cumulus 5911383922 Apr 23 11:13 <NetQ-package>.tgz
    -rwxr-xr-x 1 \_lldpd \_lldpd 4309 Apr 23 10:34 netq-install.sh
    root@netq-appliance:/mnt/installables#
    
  9. Configure SSH access.

    If you perform the upgrade more than once, you can skip this step after performing it once.

    If you have an existing SSH key, skip to step 9c.

    1. Generate the SSH key to enable you to run the script.

      Leave the passphrase blank to simplify running the script.

      root@netq-platform:/mnt/installables# ssh-keygen -t rsa -b 4096
      Generating public/private rsa key pair.
      Enter file in which to save the key (/root/.ssh/id_rsa):
      Created directory '/root/.ssh'.
      Enter passphrase (empty for no passphrase):
      Enter same passphrase again:
      Your identification has been saved in /root/.ssh/id_rsa.
      Your public key has been saved in /root/.ssh/id_rsa.pub.
      
    2. Copy the key to the authorized_keys directory.

      root@netq-platform:/mnt/installables# cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
      root@netq-platform:/mnt/installables# chmod 0600 ~/.ssh/authorized_keys
      root@netq-platform:/mnt/installables#
      
    3. Associate the key with the installer.

      root@netq-platform:/mnt/installables/# ./netq-install.sh --usekey ~/.ssh/id_rsa
      [Fri 21 Jun 2019 06:34:47 AM UTC] - This Script can only be invoked by user: root
      [Fri 21 Jun 2019 06:34:47 AM UTC] - The logged in user is root
      [Fri 21 Jun 2019 06:34:47 AM UTC] - Install directory /mnt/installables exists on system.
      [Fri 21 Jun 2019 06:34:47 AM UTC] - File /root/.ssh/id_rsa exists on system...
      [Fri 21 Jun 2019 06:34:47 AM UTC] - checking the presence of existing instaler-ssh-keys secret/instaler-ssh-keys created
      [Fri 21 Jun 2019 06:34:48 AM UTC] - Unable to find netq-installer up and running. Sleeping for 10 seconds ...
      [Fri 21 Jun 2019 06:34:58 AM UTC] - Unable to find netq-installer up and running. Sleeping for 10 seconds ...
      [Fri 21 Jun 2019 06:35:08 AM UTC] - Able to find the netq-installer up and running...
      
  10. Upgrade the NetQ software. This example shows an upgrade to version 2.2.1, on-premises deployment.

    root@netq-platform:/mnt/installables# ./netq-install.sh  --installbundle  /mnt/installables/NetQ-2.2.1.tgz --updateapps
    [Fri 26 Jul 2019 08:18:37 PM UTC] - File /mnt/installables/NetQ-2.2.1.tgz exists on system for updating netq-installer ...
    [Fri 26 Jul 2019 08:18:37 PM UTC] - Check the netq-installer is up and running to process requests ....
    [Fri 26 Jul 2019 08:18:37 PM UTC] - Checking the Status of netq-installer ....
    [Fri 26 Jul 2019 08:18:37 PM UTC] - The netq-installer is up and running ...
    [Fri 26 Jul 2019 08:18:37 PM UTC] - Updating the netq-installer ...
    [Fri 26 Jul 2019 08:18:37 PM UTC] - Able to execute the command for updating netq-installer ...
    [Fri 26 Jul 2019 08:18:37 PM UTC] - Checking initialization of netq-installer update ...
    [Fri 26 Jul 2019 08:18:37 PM UTC] - Update of netq-installer is in progress ...
    ******************************0
    [Fri 26 Jul 2019 08:28:39 PM UTC] - Successfully updated netq installer....
    0,/mnt/installables/NetQ-2.2.1.tgz
    [Fri 26 Jul 2019 08:28:39 PM UTC] - File /mnt/installables/NetQ-2.2.1.tgz exists on system for updating netq apps...
    [Fri 26 Jul 2019 08:28:39 PM UTC] - User selected to update netq-apps ...
    [Fri 26 Jul 2019 08:28:39 PM UTC] - Checking the Status of netq-installer ....
    [Fri 26 Jul 2019 08:28:41 PM UTC] - Unable to find netq-installer up and running. Sleeping for 10 seconds ...
    [Fri 26 Jul 2019 08:28:52 PM UTC] - Unable to find netq-installer up and running. Sleeping for 10 seconds ...
    [Fri 26 Jul 2019 08:29:03 PM UTC] - Unable to find netq-installer up and running. Sleeping for 10 seconds ...
    [Fri 26 Jul 2019 08:29:14 PM UTC] - Unable to find netq-installer up and running. Sleeping for 10 seconds ...
    [Fri 26 Jul 2019 08:29:24 PM UTC] - The netq-installer is up and running ...
    [Fri 26 Jul 2019 08:29:24 PM UTC] - Able to execute the command for netq apps updates ...
    [Fri 26 Jul 2019 08:29:24 PM UTC] - Checking initialization of apps update ...
    [Fri 26 Jul 2019 08:29:29 PM UTC] - netq apps update is in progress ...
    ************************************************************************************************************************************    ******************************************************************************************************************************************************************************
    0
    [Fri 26 Jul 2019 09:20:31 PM UTC] - Successfully updated netq apps ....
    root@netq-platform:/mnt/installables#
    

    Please allow about an hour for the upgrade to complete.

If you have changed the IP Address of the NetQ Platform, you need to re-register this address with the Kubernetes containers before you can continue.

  1. Reset all Kubernetes administrative settings. Run the command twice to make sure all directories and files have been reset.

    cumulus@switch:~$ sudo kubeadm reset -f  
    cumulus@switch:~$ sudo kubeadm reset -f
    
  2. Remove the Kubernetes configuration.

    cumulus@switch:~$ sudo rm /home/cumulus/.kube/config
    
  3. Reset the NetQ Platform install daemon.

    cumulus@switch:~$ sudo systemctl reset-failed
    
  4. Reset the Kubernetes service.

    cumulus@switch:~$ sudo systemctl restart cts-kubectl-config
    

    Note: Allow 15 minutes for the prompt to return.

  5. Reboot the VM.
    Note: Allow 5-10 minutes for the VM to boot.

Update the CLI

Now that the core software is updated, you must update the CLI.

  1. Edit the /etc/apt/sources.list file to add the repository for Cumulus NetQ.

    cumulus@switch:~$ sudo nano /etc/apt/sources.list
    ...
    deb http://apps3.cumulusnetworks.com/repos/deb CumulusLinux-3 netq-2.2
    ...
    
  2. Update the local apt repository, then install the NetQ apps package on the switch.

    cumulus@switch:~$ sudo apt-get update
    cumulus@switch:~$ sudo apt-get install netq-apps
    

Verify the Installation

  1. Run the netq show opta-health command to verify all applications are operating properly. Note that the output is different depending on whether you installed the on-premises or in-cloud version of NetQ. Please allow 10-15 minutes for all applications to come up and report their status.

    On-premises

      cumulus@<netq-platform-hostname>:~$ netq show opta-health
         Application                    Status    Health    Kafka Stream    Git Hash    Timestamp
         -----------------------------  --------  --------  --------------  ----------  ------------------------
         netq-app-macfdb                UP        true      up              14b42e6     Mon Jun  3 20:20:35 2019
         netq-app-interface             UP        true                      0fe11c6     Mon Jun  3 20:20:34 2019
         netq-app-vlan                  UP        true                      4daed85     Mon Jun  3 20:20:35 2019
         netq-app-sensors               UP        true      up              f37272c     Mon Jun  3 20:20:34 2019
         netq-app-topology              UP        true                      3f4a887     Mon Jun  3 20:20:34 2019
         kafka-broker                   UP                                              Mon Jun  3 20:20:35 2019
         netq-app-mstpinfo              UP        true      up              ef5565d     Mon Jun  3 20:20:35 2019
         netq-app-address               UP        true      up              7e0d03d     Mon Jun  3 20:20:35 2019
         netq-gui                       UP                                              Mon Jun  3 20:20:35 2019
         netq-app-kube                  UP        true      up              fbcaa9d     Mon Jun  3 20:20:34 2019
         netq-app-link                  UP        true      up              6c2b21a     Mon Jun  3 20:20:35 2019
         netq-app-ptm                   UP        true      up              7162771     Mon Jun  3 20:20:34 2019
         netq-opta                      UP        true                                  Mon Jun  3 20:20:34 2019
         netq-app-clagsession           UP        true      up              356dda9     Mon Jun  3 20:20:34 2019
         netq-endpoint-gateway          UP        true                      295e9ed     Mon Jun  3 20:20:34 2019
         netq-app-ospf                  UP        true      up              e0e2ab0     Mon Jun  3 20:20:34 2019
         netq-app-lldp                  UP        true      up              90582de     Mon Jun  3 20:20:35 2019
         netq-app-inventory             UP        true      up              bbf9938     Mon Jun  3 20:20:34 2019
         netq-app-tracecheck-scheduler  UP        true                      5484c68     Mon Jun  3 20:20:34 2019
         netq-app-infra                 UP        true      up              13f9e7c     Mon Jun  3 20:20:34 2019
         kafka-connect                  UP                                              Mon Jun  3 20:20:35 2019
         netq-app-search                UP        true      up              e47aaba     Mon Jun  3 20:20:34 2019
         netq-app-procdevstats          UP        true      up              b8e280e     Mon Jun  3 20:20:34 2019
         netq-app-vxlan                 UP        true      up              123c577     Mon Jun  3 20:20:34 2019
         zookeeper                      UP                                              Mon Jun  3 20:20:35 2019
         netq-app-resource-util         UP        true      up              41dfb07     Mon Jun  3 20:20:34 2019
         netq-app-evpn                  UP        true      up              05a4003     Mon Jun  3 20:20:34 2019
         netq-api-gateway               UP        true                      c40231a     Mon Jun  3 20:20:34 2019
         netq-app-port                  UP        true      up              4592b70     Mon Jun  3 20:20:35 2019
         netq-app-macs                  UP        true                      dd6cd96     Mon Jun  3 20:20:35 2019
         netq-app-notifier              UP        true      up              da57b69     Mon Jun  3 20:20:35 2019
         netq-app-events                UP        true      up              8f7b4d9     Mon Jun  3 20:20:34 2019
         netq-app-services              UP        true      up              5094f4a     Mon Jun  3 20:20:34 2019
         cassandra                      UP                                              Mon Jun  3 20:20:35 2019
         netq-app-configdiff            UP        true      up              3be2ef1     Mon Jun  3 20:20:34 2019
         netq-app-neighbor              UP        true      up              9ebe479     Mon Jun  3 20:20:35 2019
         netq-app-bgp                   UP        true      up              e68f7a8     Mon Jun  3 20:20:35 2019
         schema-registry                UP                                              Mon Jun  3 20:20:35 2019
         netq-app-lnv                   UP        true      up              a9ca80a     Mon Jun  3 20:20:34 2019
         netq-app-healthdashboard       UP        true                      eea044c     Mon Jun  3 20:20:34 2019
         netq-app-ntp                   UP        true      up              651c86f     Mon Jun  3 20:20:35 2019
         netq-app-customermgmt          UP        true                      7250354     Mon Jun  3 20:20:34 2019
         netq-app-node                  UP        true      up              f676c9a     Mon Jun  3 20:20:34 2019
         netq-app-route                 UP        true      up              6e31f98     Mon Jun  3 20:20:35 2019
    

    If any of the applications or services display Status as DOWN after 30 minutes, open a support ticket and attach the output of the opta-support command.

    In-cloud

      cumulus@<netq-platform-hostname>:~$ netq show opta-health
      OPTA is healthy
    

    If the results do not indicate the server is healthy after 30 minutes, open a support ticket and attach the output of the opta-support command.

  2. Verify that NTP is configured and running. NTP operation is critical to proper operation of NetQ. Refer to Setting Date and Time in the Cumulus Linux User Guide for details and instructions.

  3. Continue the NetQ upgrade by upgrading the NetQ Agent on each switch or host you want to monitor. Refer to the next section for instructions.

Upgrade the NetQ Agents

The NetQ Agent should be upgraded on each of the existing nodes you want to monitor to be sure you have the latest functionality and fixes. The node can be a:

  • Switch running Cumulus Linux version 3.3.2 or later
  • Server running Red Hat RHEL 7.1, Ubuntu 16.04 or CentOS 7
  • Linux virtual machine running any of the above Linux operating systems

To upgrade the NetQ Agent you need to install the OS-specific meta package, cumulus-netq, on each switch. Optionally, you can install it on hosts. The meta package contains the NetQ Agent, the NetQ command line interface (CLI), and the NetQ library. The library contains modules used by both the NetQ Agent and the CLI.

If your network uses a proxy server for external connections, you should first configure a global proxy, so apt-get can access the meta package on the Cumulus Networks repository.

Upgrade NetQ Agent on a Cumulus Linux Switch

A simple process installs the NetQ Agent on a Cumulus switch.

  1. Edit the /etc/apt/sources.list file to add the repository for Cumulus NetQ. Note that NetQ has a separate repository from Cumulus Linux.

    cumulus@switch:~$ sudo nano /etc/apt/sources.list
    ...
    deb http://apps3.cumulusnetworks.com/repos/deb CumulusLinux-3 netq-2.2
    ...
    

    The repository deb http://apps3.cumulusnetworks.com/repos/deb CumulusLinux-3 netq-latest can be used if you want to always retrieve the latest posted version of NetQ.

  2. Update the local apt repository, then install the NetQ meta package on the switch.

    cumulus@switch:~$ sudo apt-get update
    cumulus@switch:~$ sudo apt-get install cumulus-netq
    
  3. Verify the upgrade.

    cumulus@switch:~$ dpkg -l | grep netq
    ii  cumulus-netq                      2.2.1-cl3u17~155d365432.a60ec9a    all          This meta-package provides installation of Cumulus NetQ packages.
    ii  netq-agent                        2.2.1-cl3u17~1539681411.2bba220    amd64        Cumulus NetQ Telemetry Agent for Cumulus Linux
    ii  netq-apps                         2.2.1-cl3u17~1539681411.2bba220    amd64        Cumulus NetQ Fabric Validation Application for Cumulus Linux
    
  4. Restart rsyslog so log files are sent to the correct destination.

    cumulus@switch:~$ sudo systemctl restart rsyslog.service
    
  5. Configure the NetQ Agent to send telemetry data to the NetQ Platform.

    If you intend to use VRF, skip to Configure the Agent to Use VRF. If you intend to specify a port for communication, skip to Configure the Agent to Communicate over a Specific Port.

    In this example, the IP address for the agent server is 192.168.1.254.

    cumulus@switch:~$ netq config add agent server 192.168.1.254
    cumulus@switch:~$ netq config restart agent
    

    This command updates the configuration in the /etc/netq/netq.yml file.

  6. If you have not already configured CLI access for this switch, you can do so at this time.

    • For on-premises deployment:

      cumulus@switch:~$ netq config add cli server 192.168.1.254
      cumulus@switch:~$ netq config restart cli
      
    • For in-cloud deployment:

      The switch or host must have access to the Internet to configure CLI access.

      Be sure to replace the key values with your user credentials.

         cumulus@switch:~$ netq config add cli server api.netq.cumulusnetworks.com access-key <text-access-key> secret-key <text-secret-key> port 443
         cumulus@switch:~$ netq config restart cli
      

      or, if you have a credentials.yml file, be sure to use the full path to the file and the correct file name.

         cumulus@switch:~$ netq config add cli server api.netq.cumulusnetworks.com cli-keys-file /full-path/credentials.yml port 443
         cumulus@switch:~$ netq config restart cli
      
  7. Repeat these steps for each Cumulus switch, or use an automation tool to install and configure the NetQ Agent on multiple Cumulus Linux switches.

Upgrade NetQ Agent on an Ubuntu Server

To install the NetQ Agent on an Ubuntu server:

  1. Reference and update the local apt repository.

    root@ubuntu:~# wget -O- https://apps3.cumulusnetworks.com/setup/cumulus-apps-deb.pubkey | apt-key add -
    
  2. In /etc/apt/sources.list.d/cumulus-host-ubuntu-xenial.list, verify the following repository is included:

    root@ubuntu:~# vi /etc/apt/sources.list.d/cumulus-apps-deb-xenial.list
    ...
    deb [arch=amd64] https://apps3.cumulusnetworks.com/repos/deb xenial netq-latest
    ...
    

    The use of netq-latest in this example means that a get to the repository always retrieves the latest version of NetQ, even in the case where a major version update has been made. If you want to keep the repository on a specific version — such as netq-2.2 — use that instead.

  3. Install the meta package on the server.

    root@ubuntu:~# apt-get update
    root@ubuntu:~# apt-get install cumulus-netq
    
  4. Verify the upgrade.

    root@ubuntu:~$ dpkg -l | grep netq
    ii  cumulus-netq                      2.2.1-cl3u17~155d345432.a60ec9a    all          This meta-package provides installation of Cumulus NetQ packages.
    ii  netq-agent                        2.2.1-cl3u17~1559c81411.2bba220    amd64        Cumulus NetQ Telemetry Agent for Cumulus Linux
    ii  netq-apps                         2.2.1-cl3u17~1559c81411.2bba220    amd64        Cumulus NetQ Fabric Validation Application for Cumulus Linux
    
  5. Configure the NetQ Agent to send telemetry data to the NetQ Platform.

    If you intend to use VRF, skip to Configure the Agent to Use VRF. If you intend to specify a port for communication, skip to Configure the Agent to Communicate over a Specific Port.

    In this example, the IP address for the agent server is 192.168.1.254.

    user@ubuntu:~# netq config add agent server 192.168.1.254
    Updated agent server 192.168.1.254 vrf default. Please restart netq-agent (netq config restart agent).
    user@ubuntu:~# netq config restart agent
    

    This command updates the configuration in the /etc/netq/netq.yml file.

  6. If you have not already configured CLI access for this hosts, you can do so at this time.

    • For on-premises deployment:

      user@ubuntu:~# netq config add cli server 192.168.1.254
      Updated cli server 192.168.1.254 vrf default. Please restart netqd (netq config restart cli).
      user@ubuntu:~# netq config restart cli
      
    • For in-cloud deployment:

      The switch or host must have access to the Internet to configure CLI access.

      Be sure to replace the key values with your user credentials.

       user@ubuntu:~# netq config add cli server api.netq.cumulusnetworks.com access-key <text-access-key> secret-key <text-secret-key> port 443
       user@ubuntu:~# netq config restart cli
      

      or, if you have a credentials.yml file, be sure to use the full path to the file and the correct file name.

       user@ubuntu:~# netq config add cli server api.netq.cumulusnetworks.com cli-keys-file /full-path/credentials.yml port 443
       user@ubuntu:~# netq config restart cli
      
  7. Repeat these steps for each switch/host running Ubuntu, or use an automation tool to install and configure the NetQ Agent on multiple hosts.

Upgrade NetQ Agent on a Red Hat or CentOS Server

To upgrade the NetQ Agent on a Red Hat or CentOS server:

  1. Reference and update the local yum repository.

    root@rhel7:~# rpm --import https://apps3.cumulusnetworks.com/setup/cumulus-apps-rpm.pubkey
    root@rhel7:~# wget -O- https://apps3.cumulusnetworks.com/setup/cumulus-apps-rpm-el7.repo > /etc/yum.repos.d/cumulus-host-el.repo
    
  2. Edit /etc/yum.repos.d/cumulus-host-el.repo to set the enabled=1 flag for the two NetQ repositories.

    [cumulus@firewall-2 ~]$ cat /etc/yum.repos.d/cumulus-host-el.repo
    [cumulus-arch-netq-2.2]
    name=Cumulus netq packages
    baseurl=http://rohbuild03.mvlab.cumulusnetworks.com/dev/rpm/el/7/netq-latest/$basearch
    gpgcheck=1
    enabled=1
    
    [cumulus-noarch-netq-2.2]
    name=Cumulus netq architecture-independent packages
    baseurl=http://rohbuild03.mvlab.cumulusnetworks.com/dev/rpm/el/7/netq-latest/noarch
    gpgcheck=1
    enabled=1
    
    [cumulus-src-netq-2.2]
    name=Cumulus netq source packages
    baseurl=http://rohbuild03.mvlab.cumulusnetworks.com/dev/rpm/el/7/netq-latest/src
    gpgcheck=1
    enabled=1
    
  3. Update the NetQ meta packages on the server.

    root@rhel7:~# yum update cumulus-netq.x86_64
    
  4. Verify the upgrade.

    root@ubuntu:~$ yum list installed | grep netq
    ii  cumulus-netq                      2.2.1-cl3u17~15573c5432.a60ec9a    all          This meta-package provides installation of Cumulus NetQ packages.
    ii  netq-agent                        2.2.1-cl3u17~1559b81411.2bba220    amd64        Cumulus NetQ Telemetry Agent for Cumulus Linux
    ii  netq-apps                         2.2.1-cl3u17~1559b81411.2bba220    amd64        Cumulus NetQ Fabric Validation Application for Cumulus Linux
    
  5. Configure the NetQ Agent to send telemetry data to the NetQ Platform.

    If you intend to use VRF, skip to Configure the Agent to Use VRF. If you intend to specify a port for communication, skip to Configure the Agent to Communicate over a Specific Port.

    In this example, the IP address for the agent server is 192.168.1.254.

    root@rhel7:~# netq config add agent server 192.168.1.254
    Updated agent server 192.168.1.254 vrf default. Please restart netq-agent (netq config restart agent).
    root@rhel7:~# netq config restart agent
    
  6. If you have not already configured CLI access for this host, you can do so at this time.

    • For on-premises deployments:

      root@rhel7:~# netq config add cli server 192.168.1.254
      Updated cli server 192.168.1.254 vrf default. Please restart netqd (netq config restart cli).
      root@rhel7:~# netq config restart cli
      
    • For in-cloud deployment:

      The switch or host must have access to the Internet to configure CLI access.

      Be sure to replace the key values with your user credentials.

       root@rhel7:~# netq config add cli server api.netq.cumulusnetworks.com access-key <text-access-key> secret-key <text-secret-key> port 443
       root@rhel7:~# netq config restart cli
      

      or, if you have a credentials.yml file, be sure to use the full path to the file and the correct file name.

       root@rhel7:~# netq config add cli server api.netq.cumulusnetworks.com cli-keys-file /full-path/credentials.yml port 443
       root@rhel7:~# netq config restart cli
      
  7. Repeat these steps for each host running Red Hat or CentOS, or use an automation tool to install and configure the NetQ Agent on multiple hosts.

Configure Optional NetQ Agent Settings

Once the NetQ Agents have been installed on the network nodes you want to monitor, the NetQ Agents must be configured to obtain useful and relevant data. The code examples shown in this section illustrate how to configure the NetQ Agent on a Cumulus switch, but it is exactly the same for the other type of nodes. If you have already configured these settings, you do not need to do so again.

Configure the Agent to Use a VRF Interface

While optional, Cumulus strongly recommends that you configure NetQ Agents to communicate with the NetQ Platform only via a VRF, including a management VRF. To do so, you need to specify the VRF name when configuring the NetQ Agent. For example, if the management VRF is configured and you want the agent to communicate with the NetQ Platform over it, configure the agent like this:

cumulus@leaf01:~$ netq config add agent server 192.168.1.254 vrf mgmt
cumulus@leaf01:~$ netq config add cli server 192.168.254 vrf mgmt

You then restart the agent:

cumulus@leaf01:~$ netq config restart agent
cumulus@leaf01:~$ netq config restart cli

Configure the Agent to Communicate over a Specific Port

By default, NetQ uses port 8981 for communication between the NetQ Platform and NetQ Agents. If you want the NetQ Agent to communicate with the NetQ Platform via a different port, you need to specify the port number when configuring the NetQ Agent like this:

cumulus@switch:~$ netq config add agent server 192.168.1.254 port 7379

You then restart the agent:

cumulus@leaf01:~$ netq config restart agent