Skip to content

Commit 55bd47b

Browse files
committed
added install info
1 parent 88624c5 commit 55bd47b

File tree

5 files changed

+13
-15
lines changed

5 files changed

+13
-15
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ nvidia@<hostname>:~$ netq install cluster master-init
163163

164164
```
165165
nvidia@netq-server:~$ netq install cluster config generate
166-
2024-10-28 17:29:53.260462: master-node-installer: Writing cluster installation configuration template file @ /tmp/cluster-install-config.json
166+
2024-10-28 17:29:53.260462: master-node-installer: Writing cluster installation configuration template file @ /tmp/combined-cluster-config.json
167167
```
168168

169169
11. Edit the cluster configuration JSON file with the values for each attribute.
@@ -173,7 +173,7 @@ nvidia@netq-server:~$ netq install cluster config generate
173173
{{< tab "Default JSON Template">}}
174174

175175
```
176-
nvidia@netq-server:~$ vim /tmp/cluster-install-config.json
176+
nvidia@netq-server:~$ vim /tmp/combined-cluster-config.json
177177
{
178178
"version": "v2.0",
179179
"interface": "<INPUT>",
@@ -209,7 +209,7 @@ nvidia@netq-server:~$ vim /tmp/cluster-install-config.json
209209
{{< tab "Completed JSON Example">}}
210210

211211
```
212-
nvidia@netq-server:~$ vim /tmp/cluster-install-config.json
212+
nvidia@netq-server:~$ vim /tmp/combined-cluster-config.json
213213
{
214214
"version": "v2.0",
215215
"interface": "eth0",

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

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This overview is designed to help you understand the various NetQ deployment and
99

1010
## Installation Overview
1111

12-
Consider the following deployment options and requirements before you install the NetQ system:
12+
Consider the following deployment options and requirements before you install the NetQ system.
1313

1414
| Single Server | Cluster| Scale Cluster |
1515
| --- | --- | --- |
@@ -22,29 +22,25 @@ Consider the following deployment options and requirements before you install th
2222

2323
*When switches are {{<link title="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.
2424

25-
## Deployment Type: On-Premises or Cloud
2625

27-
**On-premises deployments** are hosted at your location and require the in-house skill set to install, configure, back up, and maintain NetQ. This model is a good choice if you want very limited or no access to the internet from switches and hosts in your network.
28-
29-
In the **cloud deployment**, you host only a small, local server on your premises that connects to the NetQ cloud service over selected ports or through a proxy server. NetQ cloud supports local data aggregation and forwarding---the majority of the NetQ applications use a hosted deployment strategy, storing data in the cloud. NVIDIA handles the backups and maintenance of the application and storage.
26+
## Server Arrangement: Single or Cluster
3027

3128
In all deployment models, NetQ agents reside on the switches and hosts they monitor in your network.
3229

33-
## Server Arrangement: Single or Cluster
34-
3530
### Single Server
3631

3732
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.
3833

3934
### Cluster of Servers
4035

41-
NVIDIA offers two types of cluster deployments: cluster and scale cluster. Both deployments are available on-premises and offer high-availability and provide redundancy in case of node failure.
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.
37+
38+
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.
4239

43-
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. However, keep in mind that the master hosts the Kubernetes control plane so anything that requires connectivity with the Kubernetes cluster&mdash;such as upgrading NetQ or rescheduling pods to other workers if a worker goes down&mdash;will not work. During the installation process, you configure a virtual IP address that enables redundancy for the Kubernetes control plane. In this configuration, 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. For more information, refer to the {{<exlink url="https://etcd.io/docs/v3.3/faq/" text="etcd documentation">}}.
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.
4441

45-
As an alternative to the three-node cluster deployment with a virtual IP address, you can use an external load balancer to provide high availability for the NetQ API and the NetQ UI.
42+
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 5-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 {{<exlink url="https://etcd.io/docs/v3.3/faq/" text="etcd documentation">}}.
4643

47-
The **scale cluster** deployment supports large networks and offers the highest level of scalability, allowing 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 more switches to your network, the extensible framework allows you to add two additional nodes that can accommodate a network of up to 2,000 switches. NVIDIA recommends this on-premises option for networks comprising 100 or more switches with 100 or more interfaces per switch.
4844

4945
{{%notice note%}}
5046
Large networks have the potential to generate a large amount of data. For large networks, NVIDIA does not recommend using the NetQ CLI; additionally, {{<link title="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.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,7 @@ State: Active
260260
Version: 5.1.0
261261
Installer Version: 5.1.0
262262
Installation Type: Cluster
263+
Installation Mode: NVLink
263264
Activation Key: EhVuZXRxLWVuZHBvaW50LWdhdGV3YXkYsagDIixPSUJCOHBPWUFnWXI2dGlGY2hTRzExR2E5aSt6ZnpjOUvpVVTaDdpZEhFPQ==
264265
Master SSH Public Key: c3NoLXJzYSBBQUFBQjNOemFDMXljMkVBQUFBREFRQUJBQUFCZ1FDNW9iVXB6RkczNkRC
265266
Is Cloud: False

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Additionally, for internal cluster communication, you must open these ports:
6565
c. Select **Software Downloads** from the menu.<br>
6666
d. In the search field above the table, enter **NetQ**.<br>
6767
e. For deployments using KVM, download the **NetQ SW 5.1.0 KVM** image. For deployments using VMware, download the **NetQ SW 5.1.0 VMware** image<br>
68-
f. If prompted, read the license agreement and proceed with the download.<br>
68+
f. If prompted, read the license agreement and proceed with the download.<br> <!--need to check if these are scale images-->
6969

7070
{{%notice note%}}
7171
NVIDIA employees can download NetQ directly from the {{<exlink url="http://ui.licensing.nvidia.com/" text="NVIDIA Licensing Portal">}}.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This page summarizes new features and improvements for the NetQ {{<version>}} re
1313
## What's New in NetQ 5.1
1414

1515

16+
- Check which version of NetQ you are running using the NetQ for NVLink API <!--Swagger link-->
1617
- Performance improvements to the account management page in the UI
1718
- Decreased time to install NetQ
1819
- Added Arm support <!--at risk-->

0 commit comments

Comments
 (0)