added nvlink only backup restore

Author: rachel-netq

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

@@ -9,17 +9,16 @@ The following sections describe how to back up and restore your NetQ data and VM
 
 {{%notice note%}}
 - You must run backup and restore scripts with sudo privileges.
-- 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.
-- 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.
+- 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. *This caveat does not apply to NVLink clusters.*
+- 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. *This caveat does not apply to NVLink clusters.*
 {{%/notice%}}
 
 ## Back Up Your NetQ Data
 
-Follow the process below for your deployment type to back up your NetQ data:
+Follow the process below for your deployment type to back up your NetQ data.
 
 {{<tabs "TabID19" >}}
-
-{{<tab "On-premises Deployments" >}}
+{{<tab "Other Deployments" >}}
 
 1. Retrieve the `vm-backuprestore.sh` script:
 
@@ -103,9 +102,46 @@ nvidia@netq-server:~$ sudo scp /opt/backuprestore/combined_backup_20250117054718
 ```
 
 {{</tab>}}
+{{<tab "NVLink Clusters" >}}
+
+These steps apply exclusively to {{<link title="Install NetQ for NVLink" text="NetQ NVLink">}} three-node cluster deployments.
+
+1. Run the {{<link title="nvl/#netq-nvl-cluster-backup" text="netq nvl cluster backup">}} command on each node in your cluster:
+
+```
+nvidia@<hostname>: netq nvl cluster backup
+2025-06-17 06:30:52,717 - INFO - Parsed arguments: Namespace(action='backup', backup_path='nvlink_cluster_backup', drop_mongo_collections=False, cm_op_ns='infra', cm_target_ns=['infra', 'kafka', 'nmx'], mongo_db_name=None, mongo_collections=None, mongo_k8s_ns='infra', mongo_statefulset='mongodb', mongo_container='mongodb', mongo_replicaset='rs0')
+2025-06-17 06:30:52,717 - INFO - Action: Full Backup selected.
+2025-06-17 06:30:52,717 - INFO - --- Starting NVLINK Cluster Full Backup to: nvlink_cluster_backup_20250617063052 ---
+...
+2025-06-17 06:30:55,159 - INFO - Full backup completed to: nvlink_cluster_backup_20250617063052
+```
+
+2. Copy the newly-created file to the `/tmp/data-infra/` directory:
+
+```
+cp -r /home/nvidia/nvlink_cluster_backup_20250617063052 /tmp/data-infra
+```
 
+{{</tab >}}
 {{</tabs>}}
 
 ## Restore Your NetQ Data
 
-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.
+{{<tabs "TabID129" >}}
+{{<tab "Other Deployments" >}}
+
+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.
+
+{{</tab>}}
+{{<tab "NVLink Clusters" >}}
+
+1. Restore your data by running the {{<link title="nvl/#netq-nvl-cluster-restore" text="netq nvl cluster restore">}} command with the `drop-mongo-collections` option. This option prevents NetQ from re-installing duplicate data.
+
+```
+nvidia@<hostname>: netq nvl cluster restore /tmp/data-infra/nvlink_cluster_backup_20250617063052/ drop-mongo-collections
+```
+If this step fails, run `netq nvl bootstrap rest` and then try again.
+
+{{</tab >}}
+{{</tabs>}}

content/cumulus-netq-51/Installation-Management/Install-NetQ/Install-NetQ-System.md

@@ -7,6 +7,8 @@ toc: 3
 
 ## NetQ for Ethernet
 
+The following deployment models use NetQ to monitor Ethernet-only networks.
+
 {{<tabs "TabID11" >}}
 
 {{<tab "On-premises" >}}
@@ -23,6 +25,8 @@ toc: 3
 
 ## NetQ for NVLink
 
+The following deployment model uses NetQ to monitor NVLink-only networks.
+
 {{<tabs "TabID35" >}}
 
 {{<tab "On-premises" >}}
@@ -38,14 +42,16 @@ toc: 3
 
 ## NetQ for Ethernet and NVLink
 
+The following deployment models use NetQ to monitor networks that use both Ethernet and NVLink. NetQ 5.1 introduces a new option that lets you deploy NetQ on as many nodes as you wish to include in your server cluster. This deployment option is in beta and will require a fresh installation upon subsequent NetQ releases.
+
 {{<tabs "TabID56" >}}
 
 {{<tab "On-premises" >}}
 
 | Server Arrangement | Hypervisor | Requirements & Installation |
 | :--- | --- | :---: |
 | High-availability scale cluster: three-nodes | KVM or VMware | {{<link title="Install NetQ for Ethernet and NVLink" text="Start install">}} |
-| High-availability scale cluster: unlimited nodes (beta) | KVM or VMware | {{<link title="Install NetQ for Ethernet and NVLink (Beta)" text="Start install">}} |
+| High-availability scale cluster: user-defined nodes | KVM or VMware | {{<link title="Install NetQ for Ethernet and NVLink (Beta)" text="Start install">}} |
 
 {{</tab>}}
 

content/cumulus-netq-51/Installation-Management/Install-NetQ/Setup-NVLink-Cluster.md

@@ -242,55 +242,11 @@ nvidia@netq-server:~$ vim /tmp/nvl-cluster-config.json
 
 12.  Run the installation command on your master node using the JSON configuration file that you created in the previous step. Specify the passwords for the read-write user and the read-only user in the `rw-password` and `ro-password` fields, respectively. The passwords must each include a minimum of eight characters.
 
-{{< tabs "TabID268">}}
-{{< tab "New Install">}}
-
 ```
 nvidia@<hostname>:~$ netq install nvl bundle /mnt/installables/NetQ-5.1.0.tgz kong-rw-password <rw-password> kong-ro-password <ro-password> /tmp/nvl-cluster-config.json
 ```
 <div class=“notices tip”><p>If this step fails for any reason, run <code>netq bootstrap reset</code> and then try again.</p></div>
 
-{{< /tab >}}
-{{< tab "Restore Data and New Install">}}
-<!--need to check this with QA-->
-1. Add the `config-key` parameter to the JSON template from step 11 using the key created during the {{<link title="Back Up and Restore NetQ" text="backup process">}}. Edit the file with values for each attribute.
-
-```
-nvidia@netq-server:~$ vim /tmp/nvl-cluster-config.json
-{
-        "version": "v2.0",
-        "interface": "<INPUT>",
-        "config-key": "<INPUT>",
-        "cluster-vip": "<INPUT>",
-        "servers": [
-                {
-                        "ip": "<INPUT>"
-                        "description": "<SERVER1>"
-                },
-                {
-                        "ip": "<INPUT>"
-                        "description": "<SERVER2>"
-                },
-                {
-                        "ip": "<INPUT>"
-                        "description": "<SERVER3>"
-                },
-                ],
-        "storage-path": "/var/lib/longhorn",
-        "alertmanager_webhook_url": "<INPUT>"
-}
-```
-
-2. Run the following command on your master node, using the JSON configuration file from the previous step. Include the restore option referencing the path where the backup file resides:
-
-```
-nvidia@<hostname>:~$ netq install nvl bundle /mnt/installables/NetQ-5.1.0.tgz /tmp/nvl-cluster-config.json restore /home/nvidia/combined_backup_20241211111316.tar
-```
-
-<div class="notices tip"><p><ul><li>If this step fails for any reason, run <code>netq bootstrap reset</code> and then try again.</li><li>If you restore NetQ data to a server with an IP address that is different from the one used to back up the data, you must <a href="https://docs.nvidia.com/networking-ethernet-software/cumulus-netq/Installation-Management/Install-NetQ/Install-NetQ-Agents/#configure-netq-agents">reconfigure the agents</a> on each switch as a final step.</li></ul></p></div>
-{{< /tab >}}
-{{< /tabs >}}
-
 ## Verify Installation Status
 
 To view the status of the installation, use the `netq show status [verbose]` command. The following example shows a successful 3-node installation:

content/cumulus-netq-51/Installation-Management/Install-NetQ/Setup-NVLink-Ethernet-Combined-Cluster-Beta.md

@@ -7,7 +7,7 @@ bookhidden: true
 ---
 Follow these steps to set up and configure your VMs in a cluster of servers. First configure the VM on the master node, and then configure the VM on each additional node. NVIDIA recommends installing the virtual machines on different servers to increase redundancy in the event of a hardware failure.
 {{<notice info>}}
-This deployment type is currently in beta, and installations with more than five nodes will not support upgrades to future NetQ versions.
+This deployment type is currently in beta and will require a fresh installation upon subsequent NetQ releases.
 {{</notice>}}
 ## System Requirements