Upgrade NetQ Virtual Machines

This page describes how to upgrade your NetQ virtual machines while preserving your existing NetQ data. Note that the upgrade instructions vary depending on NetQ version you’re currently running.

For deployments running:

During the upgrade process, NetQ will be temporarily unavailable.

  • NetQ does not retain custom-signed certificates during the backup and restore process. If your deployment uses a custom-signed certificate, you must reconfigure the certificate after you restore it on a new NetQ VM.

Download the Upgrade Software

  1. Download the NetQ image.

    a. Log in to your NVIDIA Application Hub account.
    b. Select NVIDIA Licensing Portal.
    c. Select Software Downloads from the menu.
    d. In the search field above the table, enter NetQ.
    e. For deployments using KVM, download the NetQ SW 5.2.0 KVM Scale image. For deployments using VMware, download the NetQ SW 5.2.0 VMware Scale image
    f. If prompted, read the license agreement and proceed with the download.

  2. Copy the tarball to the /mnt/installables/ directory on your NetQ VM.

Upgrade Using the NetQ CLI

Run the appropriate commands for your deployment type:

Run the upgrade command on your master node, specifying the tarball path in the command:

nvidia@<hostname>:~$ netq upgrade bundle /mnt/installables/NetQ-5.2.0.tgz

If this step fails for any reason, run the netq bootstrap reset keep-db command and perform a fresh installation of the tarball with the netq install standalone full command.

Run the upgrade command on your master node, specifying the tarball path and your cluster’s virtual IP address in the command:

nvidia@<hostname>:~$ netq upgrade bundle /mnt/installables/NetQ-5.2.0.tgz <cluster-vip>

Run the upgrade command on your master node and specify the following within the command itself:

  • The path to the tarball of the latest NetQ release. This command upgrades NetQ to the release specified in the command.
  • The passwords for the read-write user (rw-password) and the read-only user (ro-password)
  • The /home/nvidia/nvl-cluster-config.json file
nvidia@<hostname>:~$ netq upgrade nvl bundle /mnt/installables/NetQ-5.2.0.tgz kong-rw-password <rw-password> kong-ro-password <ro-password> /home/nvidia/nvl-cluster-config.json

Two upgrade options are available for this deployment model. One option upgrades your NetQ deployment to the latest version. The other option upgrades your NetQ deployment to the latest version and concurrently adds additional nodes to your existing cluster.

Upgrade with Same Number of Nodes

  1. Run netq install cluster config generate to create a new JSON template. Specify "version": "v3.0" in the template.

  2. Run the upgrade command on your master node, specifying the current version’s tarball and the full path to your cluster’s JSON configuration file:

nvidia@<hostname>:~$ netq upgrade cluster bundle /mnt/installables/NetQ-5.2.0.tgz /tmp/combined-cluster-config.json

Upgrade and Add Additional Nodes (Beta)

  1. Run netq install cluster config extend-cluster /tmp/cluster-install-config.json <text-num-nodes>. Specify the number of additional nodes you’d like to add with <text-num-options>.

  2. Run the installation command on your master node, specifying the current version’s tarball and the full path to your cluster’s JSON configuration file:

nvidia@<hostname>:~$ netq install cluster config extend-cluster bundle /mnt/installables/NetQ-5.2.0.tgz /tmp/combined-cluster-config.json

Next Steps