You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
NetQ restricts the metrics accepted into the local TSDB by default. To view the default whitelist of permitted metrics, run the `netq show otlp whitelist default` command:
242
242
243
-
{{<expand "Default OTLP Whitelist">}}
243
+
{{<expand "Default OTLP whitelist">}}
244
244
```
245
245
nvidia@netq-server:~$ netq show otlp whitelist default
Copy file name to clipboardExpand all lines: content/cumulus-netq-51/Installation-Management/Install-NetQ/Before-You-Install.md
+30-12Lines changed: 30 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ weight: 190
5
5
toc: 3
6
6
---
7
7
8
-
This overview is designed to help you understand the various NetQ deployment and installation options.
8
+
This overview is designed to help you understand the various NetQ deployment and installation options.
9
9
10
10
## Installation Overview
11
11
@@ -14,37 +14,55 @@ Consider the following deployment options and requirements before you install th
14
14
| Single Server | Cluster| Scale Cluster |
15
15
| --- | --- | --- |
16
16
| On-premises only | On-premises only | On-premises only |
17
-
| Network size: small<ul></ul><ul><li>1-node: Supports up to 40 switches* </li></ul>| Network size: medium<ul><li>3-node: Supports up to 100 switches*</li></ul>| Network size: large<ul><li>3-node: Supports up to 1,000 switches and 125,000 interfaces* </li><li>5-node: Supports up to 2,000 switches and 250,000 interfaces*</li></ul>|
17
+
| Network size: small<ul></ul><ul><li>1-node: Supports up to 40 switches* </li></ul>| Network size: medium<ul><li>3-node: Supports up to 100 switches*</li></ul>| Network size: large<ul></ul><ul><li>Support varies based on number of nodes. See {{<linktitle="Before You Install/#server-arrangement"text="Server Arrangement">}}.</li></ul>|
18
18
| KVM or VMware hypervisor | KVM or VMware hypervisor | KVM or VMware hypervisor |
19
-
| No high-availability option | Highavailability | Highavailability |
19
+
| No high-availability option | High-availability | High-availability |
20
20
| System requirements:<ul></ul><ul><li>16 virtual CPUs</li><li>64GB RAM</li><li>500GB SSD disk</li></ul>| System requirements (per node):<ul></ul><ul><li>16 virtual CPUs</li><li>64GB RAM</li><li>500GB SSD disk</li></ul>| System requirements (per node): <ul></ul><ul><li>48 virtual CPUs</li><li>512GB RAM </li><li>3.2TB SSD disk</li></ul>|
21
21
| Not supported:<ul><li>NVLink monitoring</li></ul> | Not supported:<ul><li>NVLink monitoring</li>| Not supported:<ul><li>Network snapshots</li><li>Trace requests</li><li>Flow analysis</li><li>MAC commentary</li><li>Duplicate IP address validations</li></ul> Limited support: <ul><li>Link health view (beta)</li></ul>|
22
22
23
-
*When switches are {{<linktitle="Integrate NetQ with Grafana/#requirements-and-support"text="configured with both OpenTelemetry (OTLP)">}} and the NetQ agent, switch support per deployment model is reduced by half.
23
+
*When switches are {{<linktitle="Integrate NetQ with Grafana/#requirements-and-support"text="configured with both OpenTelemetry (OTLP)">}} and the NetQ agent, switch support per deployment model is reduced by half.<br>
24
24
25
25
26
-
## Server Arrangement: Single or Cluster
26
+
## Server Arrangement
27
27
28
-
In all deployment models, NetQ agents reside on the switches and hosts they monitor in your network.
28
+
**Single server**: A standalone server is easier to set up, configure, and manage, but limits your ability to scale your network monitoring and provides no redundancy in case of a hardware failure.
29
29
30
-
### Single Server
30
+
**Cluster**: The cluster deployment comprises three servers: one master and two workers nodes. NetQ supports high-availability using a virtual IP address. Even if the master node fails, NetQ services remain operational.
31
31
32
-
A standalone server is easier to set up, configure, and manage, but limits your ability to scale your network monitoring. Deploying multiple servers allows you to limit potential downtime and increase availability by having more than one server that can run the software and store the data. Select the standalone, single-server arrangement for smaller, simpler deployments.
32
+
**Scale cluster**: The scale cluster deployment is intended for large network environments and allows you to expand NetQ monitoring capacity by adding nodes as your network grows. NVIDIA typically recommends this deployment for environments with 100 or more switches. It is the only deployment model that supports monitoring for {{<exlinkurl="https://www.nvidia.com/en-us/data-center/nvlink/"text="NVIDIA NVLink">}}, {{<exlinkurl="https://www.nvidia.com/en-us/networking/spectrumx/"text="NVIDIA Spectrum-X Ethernet">}}, as well as mixed Ethernet and NVLink networks.
33
33
34
-
### Cluster of Servers
34
+
The following table shows high-level device support per-node for Ethernet-only, NVLink-only, and combined deployments. This deployment model is currently in beta for clusters larger than 5 nodes. See {{<linktitle="Before You Install/#verified-limits"text="Verified Limits">}} for detailed testing information.
35
35
36
-
NVIDIA offers two types of cluster deployments: cluster and scale cluster. Both deployments are available on-premises and offer high-availability to provide redundancy in case of node failure.
The **cluster** implementation comprises three servers: one master and two workers nodes. NetQ supports high availability using a virtual IP address. Even if the master node fails, NetQ services remain operational. This deployment supports networks with up to 100 switches.
39
42
40
-
The **scale cluster** deployment supports large networks and allows you to adjust NetQ's network monitoring capacity by adding additional nodes to your cluster as your network expands. For example, you can deploy a three-node scale cluster that accommodates up to 1,000 switches. When you add switches to your network, the extensible framework allows you to add additional nodes to support a greater number of switches. NVIDIA recommends this option for networks comprising 100 or more switches with 100 or more interfaces per switch.
43
+
{{%notice note%}}
41
44
42
45
In both cluster deployments, the majority of nodes must be operational for NetQ to function. For example, a three-node cluster can tolerate a one-node failure, but not a two-node failure. Similarly, a five-node cluster can tolerate a two-node failure, but not a three-node failure. If the majority of failed nodes are Kubernetes control plane nodes, NetQ will no longer function. For more information, refer to the {{<exlinkurl="https://etcd.io/docs/v3.3/faq/"text="etcd documentation">}}.
46
+
{{%/notice%}}
47
+
## Verified Limits
43
48
49
+
The following values have been explicitly tested and validated, but they might not reflect the maximum theoretical system limits for NetQ.
50
+
51
+
| Deployment Type | Verified Features | Verified Scale Limit | Data Rate | Hardware Requirements |
Large networks have the potential to generate a large amount of data. For large networks, NVIDIA does not recommend using the NetQ CLI; additionally, {{<linktitle="Access Data with Cards/#table-settings"text="tabular data in the UI">}} is limited to 10,000 rows. If you need to review a large amount of data, NVIDIA recommends downloading and exporting the tabular data as a CSV or JSON file and analyzing it in a spreadsheet program.
47
64
{{%/notice%}}
65
+
48
66
## Base Command Manager
49
67
50
68
NetQ is also available through NVIDIA's cluster management software, Base Command Manager. Refer to the {{<exlinkurl="https://docs.nvidia.com/base-command-manager/#product-manuals"text="Base Command Manager administrator and containerization manuals">}} for instructions on how to launch and configure NetQ using Base Command Manager.
Copy file name to clipboardExpand all lines: content/cumulus-netq-51/Installation-Management/Install-NetQ/Install-NetQ-CLI.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -82,7 +82,7 @@ If you are running NTP in your out-of-band management network with VRF, specify
82
82
83
83
### Get the NetQ CLI Software Package for Ubuntu
84
84
85
-
To install the NetQ CLI on an Ubuntu server, you need to install `netq-apps` on each Ubuntu server. This is available from the {{<exlink url="https://download.nvidia.com/cumulus/apps3.cumulusnetworks.com/repos/deb/pool/netq-latest/" text="NetQ repository">}}.
85
+
To install the NetQ CLI on an Ubuntu server, you need to install `netq-apps` on each Ubuntu server. This is available from the {{<exlink url="https://edge.urm.nvidia.com/artifactory/sw-nbu-netq-debian-local/pool/netq-latest/" text="NetQ repository">}}.
86
86
87
87
{{<tabs "Get NetQ CLI Ubuntu">}}
88
88
@@ -174,7 +174,7 @@ You can specify a NetQ CLI version in the repository configuration. The followin
Copy file name to clipboardExpand all lines: content/cumulus-netq-51/Installation-Management/Install-NetQ/Install-NetQ-System.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ The following deployment models use NetQ to monitor networks that use both Ether
51
51
| Server Arrangement | Hypervisor | Requirements & Installation |
52
52
| :--- | --- | :---: |
53
53
| High-availability scale cluster: three nodes | KVM or VMware | {{<linktitle="Install NetQ for Ethernet and NVLink"text="Start install">}} |
54
-
| High-availability scale cluster: up to six nodes*| KVM or VMware | {{<linktitle="Install NetQ for Ethernet and NVLink (Beta)"text="Start install">}} |
54
+
| High-availability scale cluster: user-defined nodes*| KVM or VMware | {{<linktitle="Install NetQ for Ethernet and NVLink (Beta)"text="Start install">}} |
Copy file name to clipboardExpand all lines: content/cumulus-netq-51/Installation-Management/Install-NetQ/Install-NetQ-Agents.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,7 +144,7 @@ If you are running NTP in your out-of-band management network with VRF, specify
144
144
145
145
### Obtain NetQ Agent Software Package
146
146
147
-
To install the NetQ Agent you need to install `netq-agent` on each server. This is available from the {{<exlink url="https://download.nvidia.com/cumulus/apps3.cumulusnetworks.com/repos/deb/pool/netq-latest/" text="NetQ repository">}}.
147
+
To install the NetQ Agent you need to install `netq-agent` on each server. This is available from the {{<exlink url="https://edge.urm.nvidia.com/artifactory/sw-nbu-netq-debian-local/pool/netq-latest/" text="NetQ repository">}}.
148
148
149
149
To obtain the NetQ Agent package:
150
150
@@ -232,7 +232,7 @@ If you are running NTP in your out-of-band management network with VRF, specify
232
232
233
233
### Obtain NetQ Agent Software Package
234
234
235
-
To install the NetQ Agent you need to install `netq-agent` on each server. This is available from the {{<exlink url="https://download.nvidia.com/cumulus/apps3.cumulusnetworks.com/repos/deb/pool/netq-latest/" text="NetQ repository">}}.
235
+
To install the NetQ Agent you need to install `netq-agent` on each server. This is available from the {{<exlink url="https://edge.urm.nvidia.com/artifactory/sw-nbu-netq-debian-local/pool/netq-latest/" text="NetQ repository">}}.
Copy file name to clipboardExpand all lines: content/cumulus-netq-51/Installation-Management/Install-NetQ/Setup-NVLink-Ethernet-Combined-Cluster-Beta.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ bookhidden: true
7
7
---
8
8
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.
9
9
{{<noticeinfo>}}
10
-
This deployment option is in beta. Deployments with more than three nodes will require a fresh installation upon subsequent NetQ releases.
10
+
This deployment option is in beta. Deployments with more than three nodes will require a fresh installation upon subsequent NetQ releases. {{<linktitle="Before You Install/#server-arrangement"text="View node support information">}}.
0 commit comments