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 the NetQ Platform

The first step in upgrading your NetQ 2.4.0 installation to NetQ 2.4.1 is to upgrade your NetQ Platform. This topic describes how to upgrade this for 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 the hardware

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

To complete the preparation:

  1. Optionally back up your NetQ 2.4.0 data. Refer to Back Up Your NetQ Data.

  2. Download the relevant software.

    1. Go to the Cumulus Downloads page, and select NetQ from the Product list.

    2. Select 2.4 from the Version list, and then click 2.4.1 from the submenu.

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

      Your Deployment TypeHypervisor/Platform SelectionDownloaded Filename
      NetQ On-premises Platform running KVMKVMNetQ-2.4.1.tgz
      NetQ Cloud Platform running KVMKVM (Cloud)NetQ-2.4.1-opta.tgz
      NetQ On-premises Platform running VMwareVMwareNetQ-2.4.1.tgz
      NetQ Cloud Platform running VMwareVMware (Cloud)NetQ-2.4.1-opta.tgz
      NetQ Appliance (on-premises)ApplianceNetQ-2.4.1.tgz
      NetQ Cloud ApplianceAppliance (Cloud)NetQ-2.4.1-opta.tgz
    4. Scroll down and click Download. For example: The NetQ Appliance images.

  3. Copy the file to the /mnt/installables/ directory on your hardware.

  4. Update the NetQ debian packages using the following three commands.

    cumulus@<hostname>:~$ sudo dpkg --remove --force-remove-reinstreq netq-apps netq-agent 2>/dev/null
    [sudo] password for cumulus:
    (Reading database ... 71621 files and directories currently installed.)
    Removing netq-apps (2.4.0-ub18.04u24~1577405296.fcf3c28) ...
    Removing netq-agent (2.4.0-ub18.04u24~1577405296.fcf3c28) ...
    Processing triggers for man-db (2.8.3-2ubuntu0.1) ...
    
    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-2.4 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 (2.4.1-ub18.04u26~1581351889.c5ec3e5) ...
    ...
    Unpacking netq-apps (2.4.1-ub18.04u26~1581351889.c5ec3e5) ...
    Setting up netq-apps (2.4.1-ub18.04u26~1581351889.c5ec3e5) ...
    Setting up netq-agent (2.4.1-ub18.04u26~1581351889.c5ec3e5) ...
    Processing triggers for rsyslog (8.32.0-1ubuntu4) ...
    Processing triggers for man-db (2.8.3-2ubuntu0.1) ...
    

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

Upgrade Your Platform Using the NetQ Admin UI

After completing the preparation steps, upgrading your NetQ Platform(s) or NetQ Appliance(s) is simple using the Admin UI.

To upgrade your NetQ software:

  1. Run the bootstrap CLI to upgrade the Admin UI itself.

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

  3. Click Upgrade.

  4. Enter NetQ-2.4.1.tgz or NetQ-2.4.1-opta.tgz and click .

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

  5. 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.

  6. 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 Platform(s) or NetQ Appliance(s) is simple using the NetQ CLI.

To upgrade your hardware:

  1. Run the appropriate netq upgrade command.

    netq upgrade bundle /mnt/installables/NetQ-2.4.1.tgz
    
    netq upgrade bundle /mnt/installables/NetQ-2.4.1-opta.tgz
    
  2. After the upgrade is completed, confirm the upgrade was successful.

    cat /etc/app-release
    

    The output should look like this:

    On-premisesCloud
    NetQ Platform
    • KVM:
      APPLIANCE_VERSION=2.4.1
      APPLIANCE_MANIFEST_HASH=E9361…12BE7
      APPLIANCE_NAME=”<NetQ Platform Name>“
    • VMware:
      APPLIANCE_VERSION=2.4.1
      APPLIANCE_MANIFEST_HASH=7916C…6D0EF
      APPLIANCE_NAME=”<NetQ Platform Name>“
    • KVM:
      APPLIANCE_VERSION=2.4.1
      APPLIANCE_MANIFEST_HASH=383E9…F4371
      APPLIANCE_NAME=”<NetQ Cloud Platform Name>“
    • VMware:
      APPLIANCE_VERSION=2.4.1
      APPLIANCE_MANIFEST_HASH=E6176…A3EA1
      APPLIANCE_NAME=”<NetQ Cloud Platform Name>“
    NetQ ApplianceAPPLIANCE_VERSION=2.4.1
    APPLIANCE_MANIFEST_HASH=ADB58…E6732
    APPLIANCE_NAME="NetQ Appliance”
    APPLIANCE_VERSION=2.4.1
    APPLIANCE_MANIFEST_HASH=4F50D…57FE1
    APPLIANCE_NAME="NetQ Cloud Appliance”