Skip to content

Commit

Permalink
chore: remove examples from Helm README (#874)
Browse files Browse the repository at this point in the history
  • Loading branch information
e0ne committed Apr 1, 2024
2 parents 621f2b9 + 576879b commit 94c3862
Showing 1 changed file with 0 additions and 96 deletions.
96 changes: 0 additions & 96 deletions deployment/network-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,99 +358,3 @@ kubectl uncordon -l "network.nvidia.com/operator.mofed.wait=false"
## Chart parameters

In order to tailor the deployment of the network operator to your cluster needs, Chart parameters are available. See official [documentation](https://docs.nvidia.com/networking/software/cloud-orchestration/index.html).

## Deployment Examples

As there are several parameters that are required to be provided to create the custom resource during operator
deployment, it is recommended that a configuration file be used. While its possible to provide override to the parameter
via CLI it would simply be cumbersome.

Below are several deployment examples `values.yaml` provided to helm during installation of the network operator in the
following manner:

`$ helm install -f ./values.yaml -n network-operator --create-namespace --wait network-operator nvidia/network-operator`

#### Example 1

Network Operator deployment with a specific version of OFED driver and a single RDMA resource mapped to `enp1`
netdev.

__values.yaml:__

```:yaml
deployCR: true
ofedDriver:
deploy: true
version: 5.3-1.0.0.1
rdmaSharedDevicePlugin:
deploy: true
resources:
- name: rdma_shared_device_a
ifNames: [enp1]
```

#### Example 2

Network Operator deployment with the default version of OFED, RDMA device plugin with two RDMA
resources, the first mapped to `enp1` and `enp2`, the second mapped to `ib0`.

__values.yaml:__

```:yaml
deployCR: true
ofedDriver:
deploy: true
rdmaSharedDevicePlugin:
deploy: true
resources:
- name: rdma_shared_device_a
ifNames: [enp1, enp2]
- name: rdma_shared_device_b
ifNames: [ib0]
```

#### Example 3

Network Operator deployment with:

- RDMA device plugin, single RDMA resource mapped to `ib0`
- Secondary network
- Multus CNI
- Containernetworking-plugins CNI plugins
- Whereabouts IPAM CNI Plugin

__values.yaml:__

```:yaml
deployCR: true
rdmaSharedDevicePlugin:
deploy: true
resources:
- name: rdma_shared_device_a
ifNames: [ib0]
secondaryNetwork:
deploy: true
multus:
deploy: true
cniPlugins:
deploy: true
ipamPlugin:
deploy: true
```

#### Example 4

Network Operator deployment with the default version of RDMA device plugin with RDMA resource mapped to Mellanox
ConnectX-5.

__values.yaml:__

```:yaml
deployCR: true
rdmaSharedDevicePlugin:
deploy: true
resources:
- name: rdma_shared_device_a
vendors: [15b3]
deviceIDs: [1017]
```

0 comments on commit 94c3862

Please sign in to comment.