If you are using the current version of Cumulus NetQ, the content on this page may not be up to date. The current version of the documentation is available here. If you are redirected to the main page of the user guide, then this page may have been renamed; please search for it there.

Upgrade NetQ Appliances and Virtual Machines

The first step in upgrading your NetQ 2.4.x or 3.0.0 installation to NetQ 3.1.0 is to upgrade your NetQ appliance(s) or VM(s). This topic describes how to upgrade both on-premises and cloud deployments.

Prepare for Upgrade

Two important steps are required to prepare for upgrade of your NetQ Platform:

  • Download the necessary software tarballs
  • Update the Debian packages on physical server and VMs

Optionally, you can choose to back up your NetQ Data before performing the upgrade.

To complete the preparation:

  1. For on-premises deployments only, optionally back up your NetQ 2.4.x or 3.0.0 data. Refer to Back Up and Restore NetQ.

  2. Download the relevant software.

    1. Go to the MyMellanox downloads page page, and select NetQ from the Product list.

    2. Select 3.1 from the Version list, and then click 3.1.0 in the submenu.

    3. Select the relevant software from the HyperVisor/Platform list:

      If you are upgrading NetQ Platform software for a NetQ On-premises Appliance or VM, select Appliance to download the NetQ-3.1.0.tgz file. If you are upgrading NetQ Collector software for a NetQ Cloud Appliance or VM, select Appliance (Cloud) to download the NetQ-3.1.0-opta.tgz file.

    4. Scroll down and click Download.

      You can ignore the note on the image card because, unlike during installation, you do not need to download the bootstrap file for an upgrade.

  3. Copy the file to the /mnt/installables/ directory on your appliance or VM.

  4. Update /etc/apt/sources.list.d/cumulus-netq.list to netq-3.1 as followed

    cat /etc/apt/sources.list.d/cumulus-netq.list
    deb [arch=amd64] https://apps3.cumulusnetworks.com/repos/deb bionic netq-3.1
  5. Update the NetQ debian packages using the following commands.

    cumulus@<hostname>:~$ sudo apt-get update
    Get:1 http://apps3.cumulusnetworks.com/repos/deb bionic InRelease [13.8 kB]
    Get:2 http://apps3.cumulusnetworks.com/repos/deb bionic/netq-3.1 amd64 Packages [758 B]
    Hit:3 http://archive.ubuntu.com/ubuntu bionic InRelease
    Get:4 http://security.ubuntu.com/ubuntu bionic-security InRelease [88.7 kB]
    Get:5 http://archive.ubuntu.com/ubuntu bionic-updates InRelease [88.7 kB]
    Get:24 http://archive.ubuntu.com/ubuntu bionic-backports/universe Translation-en [1900 B]
    Fetched 4651 kB in 3s (1605 kB/s)
    Reading package lists... Done
    cumulus@<hostname>:~$ sudo apt-get install -y netq-agent netq-apps
    Reading package lists... Done
    Building dependency tree
    Reading state information... Done
    The following NEW packages will be installed:
    netq-agent netq-apps
    Fetched 39.8 MB in 3s (13.5 MB/s)
    Unpacking netq-agent (3.1.0-ub18.04u28~1594095612.8f00ba1) ...
    Unpacking netq-apps (3.1.0-ub18.04u28~1594095612.8f00ba1) ...
    Setting up netq-apps (3.1.0-ub18.04u28~1594095612.8f00ba1) ...
    Setting up netq-agent (3.1.0-ub18.04u28~1594095612.8f00ba1) ...
    Processing triggers for rsyslog (8.32.0-1ubuntu4) ...
    Processing triggers for man-db (2.8.3-2ubuntu0.1) ...

You can now upgrade your appliance using the NetQ Admin UI, in the next section. Alternately, you can upgrade using the CLI here: Upgrade Your Platform Using the NetQ CLI.

Upgrade Your Platform Using the NetQ Admin UI

After completing the preparation steps, upgrading your NetQ On-premises or Cloud Appliance(s) or VMs is simple using the Admin UI.

To upgrade your NetQ software:

  1. Run the bootstrap CLI to upgrade the Admin UI application.
cumulus@<hostname>:~$ netq bootstrap master upgrade /mnt/installables/NetQ-3.1.0.tgz
2020-04-28 15:39:37.016710: master-node-installer: Extracting tarball /mnt/installables/NetQ-3.1.0.tgz
2020-04-28 15:44:48.188658: master-node-installer: Upgrading NetQ Admin container
2020-04-28 15:47:35.667579: master-node-installer: Removing old images
Successfully bootstrap-upgraded the master node
netq bootstrap master upgrade /mnt/installables/NetQ-3.1.0-opta.tgz
  1. Open the Admin UI by entering https://<hostname-or-ipaddress>:8443 in your browser address field.

  2. Click Upgrade.

    On-premises deployment (cloud deployment only has Node and Pod cards)

    On-premises deployment (cloud deployment only has Node and Pod cards)

  3. Enter NetQ-3.1.0.tgz or NetQ-3.1.0-opta.tgz and click .

    The is only visible after you enter your tar file information.

  4. Monitor the progress. Click to monitor each step in the jobs.

    The following example is for an on-premises upgrade. The jobs for a cloud upgrade are slightly different.

  5. When it completes, click to be returned to the Health dashboard.

Upgrade Your Platform Using the NetQ CLI

After completing the preparation steps, upgrading your NetQ On-premises/Cloud Appliance(s) or VMs is simple using the NetQ CLI.

To upgrade:

  1. Run the appropriate netq upgrade command.
netq upgrade bundle /mnt/installables/NetQ-3.1.0.tgz
netq upgrade bundle /mnt/installables/NetQ-3.1.0-opta.tgz
  1. After the upgrade is completed, confirm the upgrade was successful.

    cumulus@<hostname>:~$ cat /etc/app-release