Skip to content

Commit fb1c2eb

Browse files
committed
more upgrade edits
1 parent d462134 commit fb1c2eb

3 files changed

Lines changed: 37 additions & 16 deletions

File tree

content/cumulus-netq-52/Installation-Management/Backup-and-Restore-NetQ.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ toc: 3
88
The following sections describe how to back up and restore your NetQ data and VMs for on-premises deployments.
99

1010
{{%notice note%}}
11+
- Follow the backup and restore instructions as outlined on this page to upgrade your deployment from 5.0 to 5.2. If your deployment is currently running version 5.1, {{<link title="Upgrade NetQ Virtual Machines" text="perform an in-place upgrade">}} to upgrade to version 5.2.
1112
- You must run backup and restore scripts with sudo privileges.
1213
- NetQ does not retain custom-signed certificates during the backup and restore process. If your deployment uses a custom-signed certificate, you must {{<link title="Install a Custom Signed Certificate" text="reconfigure the certificate">}} after you restore it on a new NetQ VM.
1314
- The backup and restore process does not retain several configurations necessary for the Grafana integration, including switch TLS certificates, authentication tokens (vm-tokens), OpenTelemetry configurations, and external time-series database configurations. After reinstalling NetQ, you must {{<link title="Integrate NetQ with Grafana" text="reconfigure these components">}}. Grafana will not display data from previous NetQ versions.
@@ -18,7 +19,7 @@ The following sections describe how to back up and restore your NetQ data and VM
1819
Follow the process below for your deployment type to back up your NetQ data.
1920

2021
{{<tabs "TabID19" >}}
21-
{{<tab "Ethernet-only and Combined (Ethernet + NVLink)" >}}
22+
{{<tab "Ethernet and Combined (Ethernet + NVLink) Deployments" >}}
2223

2324
{{%notice note%}}
2425
If your NetQ deployment uses combined Ethernet and NVLink mode, only your Ethernet data can be backed up and restored. NVLink data is excluded from the backup and restoration process.
@@ -106,7 +107,7 @@ nvidia@netq-server:~$ sudo scp /opt/backuprestore/combined_backup_20250117054718
106107
```
107108

108109
{{</tab>}}
109-
{{<tab "NVLink-only" >}}
110+
{{<tab "NVLink-only Deployments" >}}
110111

111112
These steps apply exclusively to {{<link title="Install NetQ for NVLink" text="NetQ NVLink">}} three-node cluster deployments.
112113

@@ -135,12 +136,12 @@ cp -r /home/nvidia/nvlink_cluster_backup_20250617063052 /tmp/data-infra
135136
## Restore Your NetQ Data
136137

137138
{{<tabs "TabID129" >}}
138-
{{<tab "Ethernet-only and Combined (Ethernet + NVLink)" >}}
139+
{{<tab "Ethernet and Combined (Ethernet + NVLink) Deployments" >}}
139140

140141
To restore your NetQ data, perform a {{<link title="Install the NetQ System" text="new NetQ VM installation">}} and follow the steps to restore your NetQ data when you run the `netq install` command. You will use the `restore` option, referencing the path where the backup file resides.
141142

142143
{{</tab>}}
143-
{{<tab "NVLink-only" >}}
144+
{{<tab "NVLink-only Deployments" >}}
144145

145146
1. Run the installation command on your master node and specify the following within the command itself:
146147

content/cumulus-netq-52/Installation-Management/Upgrade-NetQ/Upgrade-System.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 410
55
toc: 4
66
---
77

8-
This page describes how to upgrade your NetQ virtual machines. Note that the upgrade instructions vary depending on NetQ version you’re currently running.
8+
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.
99

1010
For deployments running:
1111

@@ -71,15 +71,20 @@ If the output of this command displays errors or returns an empty response, you
7171
Processing triggers for man-db (2.8.3-2ubuntu0.1) ...
7272
```
7373
74-
74+
-->
7575
## Download the Upgrade Software
7676

77-
1. Download the upgrade tarball.
77+
1. Download the NetQ image.
7878

79-
{{<netq-install/upgrade-image version="4.12">}}
79+
a. Log in to your {{<exlink url="https://nvid.nvidia.com/" text="NVIDIA Application Hub">}} account.<br>
80+
b. Select **NVIDIA Licensing Portal**.<br>
81+
c. Select **Software Downloads** from the menu.<br>
82+
d. In the search field above the table, enter **NetQ**.<br>
83+
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<br>
84+
f. If prompted, read the license agreement and proceed with the download.<br>
8085

8186
2. Copy the tarball to the `/mnt/installables/` directory on your NetQ VM.
82-
87+
<!--
8388
## Run the Upgrade
8489
8590
{{%notice note%}}
@@ -115,7 +120,7 @@ Run the appropriate commands for your deployment type:
115120

116121
{{<tab "Standalone">}}
117122

118-
Run the upgrade command on your master node, specifying the tarball of the latest NetQ release:
123+
Run the upgrade command on your master node, specifying the tarball path in the command:
119124

120125
```
121126
nvidia@<hostname>:~$ netq upgrade bundle /mnt/installables/NetQ-5.2.0.tgz
@@ -126,7 +131,7 @@ If this step fails for any reason, run the <code>netq bootstrap reset keep-db</c
126131
{{</tab>}}
127132

128133
{{<tab "High-availability Cluster">}}
129-
Run the upgrade command on your master node, specifying the current version's tarball and your cluster's virtual IP address.
134+
Run the upgrade command on your master node, specifying the tarball path and your cluster's virtual IP address in the command:
130135

131136
```
132137
nvidia@<hostname>:~$ netq upgrade bundle /mnt/installables/NetQ-5.2.0.tgz <cluster-vip>
@@ -137,7 +142,7 @@ nvidia@<hostname>:~$ netq upgrade bundle /mnt/installables/NetQ-5.2.0.tgz <clust
137142

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

140-
- The tarball of the latest NetQ release. This command upgrades NetQ to the release specified in the command.
145+
- The path to the tarball of the latest NetQ release. This command upgrades NetQ to the release specified in the command.
141146
- The passwords for the read-write user (`rw-password`) and the read-only user (`ro-password`)
142147
- The `/home/nvidia/nvl-cluster-config.json` file
143148

@@ -147,12 +152,28 @@ nvidia@<hostname>:~$ netq upgrade nvl bundle /mnt/installables/NetQ-5.2.0.tgz ko
147152
{{</tab>}}
148153

149154
{{<tab "High-availbility Scale Cluster (NVLink + Ethernet)">}}
150-
Run the upgrade command on your master node, specifying the current version's tarball and your cluster's virtual IP address.
155+
156+
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.
157+
158+
## Upgrade with Same Number of Nodes
159+
160+
Run the upgrade command on your master node, specifying the current version's tarball and your cluster's virtual IP address:
151161

152162

153163
```
154-
nvidia@<hostname>:~$ netq upgrade nvl bundle /mnt/installables/NetQ-5.2.0.tgz <cluster-vip>
164+
nvidia@<hostname>:~$ netq upgrade cluster bundle /mnt/installables/NetQ-5.2.0.tgz <text-cluster-config>
155165
```
166+
## Upgrade and Add Additional Nodes
167+
168+
<!--how to load json file? how to upgrade v2 to v3-->
169+
170+
171+
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:
172+
173+
```
174+
nvidia@<hostname>:~$ netq install cluster extend-cluster bundle /mnt/installables/NetQ-5.2.0.tgz /tmp/combined-cluster-config.json
175+
```
176+
156177
{{</tab>}}
157178

158179
{{</tabs>}}

content/cumulus-netq-52/Whats-New/_index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ This page summarizes new features and improvements for the NetQ {{<version>}} re
4646

4747
NetQ 5.2 is available exclusively for on-premises deployments. You can upgrade to 5.2 if your deployment is running version 5.1 or 5.0.
4848

49-
- To upgrade from 5.1 to 5.2, perform an {{<link title="Upgrade NetQ Virtual Machines" text="in-place upgrade">}}.
50-
- To upgrade from 5.1 to 5.2 and concurrently add additional nodes to your cluster, run the `netq install cluster` command with the `extend-cluster` option.
49+
- To upgrade from 5.1 to 5.2, perform an {{<link title="Upgrade NetQ Virtual Machines" text="in-place upgrade">}}.
5150
- To upgrade from 5.0 to 5.2, {{<link title="Back Up and Restore NetQ" text="back up your NetQ data">}}, then concurrently restore your data and upgrade NetQ during a {{<link title="Install the NetQ System" text="new NetQ 5.2 installation">}}.
5251

5352

0 commit comments

Comments
 (0)