Skip to content

Commit

Permalink
Merge pull request #118 from rollandf/container-images
Browse files Browse the repository at this point in the history
chore: add full CR example
  • Loading branch information
rollandf authored Oct 23, 2024
2 parents 9d39ca8 + a1333ef commit 1757644
Show file tree
Hide file tree
Showing 4 changed files with 150 additions and 18 deletions.
8 changes: 4 additions & 4 deletions docs/common/vars.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. |network-operator-version| replace:: v24.10.0-beta.3
.. |helm-chart-version| replace:: 24.10.0-beta.3
.. |network-operator-version| replace:: v24.10.0-beta.4
.. |helm-chart-version| replace:: 24.10.0-beta.4
.. |ocp-channel| replace:: v24.10
.. |mofed-version| replace:: 24.10-0.4.6.0-0
.. |mofed-version| replace:: 24.10-0.5.5.0-0
.. |mofed-init-container-version| replace:: v0.0.2
.. |sriov-device-plugin-version| replace:: v3.7.0
.. |k8s-rdma-shared-dev-plugin-version| replace:: sha-4f3eb2224b8b5f97be3f17441ddee8d41753b7d5
Expand All @@ -12,7 +12,7 @@
.. |whereabouts-version| replace:: v0.7.0
.. |nvidia-ipam-version| replace:: v0.2.0
.. |nic-feature-discovery-version| replace:: v0.0.1
.. |sriovnetop-version| replace:: network-operator-24.10.0-beta.3
.. |sriovnetop-version| replace:: network-operator-24.10.0-beta.4
.. |sriovnetop-sriov-cni-version| replace:: v2.8.1
.. |sriovnetop-ib-sriov-cni-version| replace:: v1.1.1
.. |sriovnetop-sriov-device-plugin-version| replace:: v3.7.0
Expand Down
131 changes: 131 additions & 0 deletions docs/customizations/cr-full-example.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
.. license-header
SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: Apache-2.0
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. headings # #, * *, =, -, ^, "
.. include:: ../common/vars.rst

****************************************
NicClusterPolicy Custom Resource Example
****************************************

The following NIC Cluster Policy example contains all the sub-components that NVIDA Network Operator can deploy.
This example should serve as a reference, it is not recommended to apply it as is to your cluster.

**NOTE:** Edit the example to contain only the required components for the target environment.

.. code-block:: yaml
:substitutions:
apiVersion: mellanox.com/v1alpha1
kind: NicClusterPolicy
metadata:
name: nic-cluster-policy
spec:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
upgradePolicy:
autoUpgrade: true
drain:
deleteEmptyDir: true
enable: true
force: true
timeoutSeconds: 300
maxParallelUpgrades: 1
startupProbe:
initialDelaySeconds: 10
periodSeconds: 10
livenessProbe:
initialDelaySeconds: 30
periodSeconds: 30
readinessProbe:
initialDelaySeconds: 10
periodSeconds: 30
rdmaSharedDevicePlugin:
image: k8s-rdma-shared-dev-plugin
repository: ghcr.io/mellanox
version: |k8s-rdma-shared-dev-plugin-version|
# The config below directly propagates to k8s-rdma-shared-device-plugin configuration.
# Replace 'devices' with your (RDMA capable) netdevice name.
config: |
{
"configList": [
{
"resourceName": "rdma_shared_device_a",
"rdmaHcaMax": 63,
"selectors": {
"vendors": ["15b3"],
"deviceIDs": ["101b"]
}
}
]
}
sriovDevicePlugin:
image: sriov-network-device-plugin
repository: ghcr.io/k8snetworkplumbingwg
version: |sriov-device-plugin-version|
config: |
{
"resourceList": [
{
"resourcePrefix": "nvidia.com",
"resourceName": "hostdev",
"selectors": {
"vendors": ["15b3"],
"isRdma": true
}
}
]
}
secondaryNetwork:
cniPlugins:
image: plugins
repository: ghcr.io/k8snetworkplumbingwg
version: |cni-plugins-version|
ipoib:
image: ipoib-cni
repository: ghcr.io/mellanox
version: |ipoib-cni-version|
multus:
image: multus-cni
repository: ghcr.io/k8snetworkplumbingwg
version: |multus-version|
config: ''
ipamPlugin:
image: whereabouts
repository: ghcr.io/k8snetworkplumbingwg
version: |whereabouts-version|
nvIpam:
image: nvidia-k8s-ipam
repository: ghcr.io/mellanox
version: |nvidia-ipam-version|
enableWebhook: false
ibKubernetes:
image: ib-kubernetes
repository: ghcr.io/mellanox/ib-kubernetes
version: |ib-kubernetes-version|
pKeyGUIDPoolRangeStart: "02:00:00:00:00:00:00:00"
pKeyGUIDPoolRangeEnd: "02:FF:FF:FF:FF:FF:FF:FF"
ufmSecret: ufm-secret
nicFeatureDiscovery:
image: nic-feature-discovery
repository: ghcr.io/mellanox
version: |nic-feature-discovery-version|
docaTelemetryService:
image: doca_telemetry
repository: nvcr.io/nvidia/doca
version: |doca-telemetry-version|
3 changes: 2 additions & 1 deletion docs/customizations/customization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ Customization Options

.. toctree::
Helm Chart <helm.rst>
CRDs <crds.rst>
CRDs <crds.rst>
NicClusterPolicy Reference Example <cr-full-example.rst>
26 changes: 13 additions & 13 deletions docs/platform-support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,43 +57,43 @@ The following component versions are deployed by the Network Operator:
:header-rows: 1

* - Component
- Version
- Container Image
- Notes
* - Node Feature Discovery
- |node-feature-discovery-version|
- registry.k8s.io/nfd/node-feature-discovery:|node-feature-discovery-version|
- Optionally deployed. May already be present in the cluster with proper configuration.
* - NVIDIA DOCA Driver container
- |mofed-version|
- nvcr.io/nvidia/mellanox/doca-driver:|mofed-version|
-
* - k8s-rdma-shared-device-plugin
- |k8s-rdma-shared-dev-plugin-version|
- ghcr.io/mellanox/k8s-rdma-shared-dev-plugin:|k8s-rdma-shared-dev-plugin-version|
-
* - sriov-network-device-plugin
- |sriov-device-plugin-version|
- ghcr.io/k8snetworkplumbingwg/sriov-network-device-plugin:|sriov-device-plugin-version|
-
* - containernetworking CNI plugins
- |cni-plugins-version|
- ghcr.io/k8snetworkplumbingwg/plugins:|cni-plugins-version|
-
* - whereabouts CNI
- |whereabouts-version|
- ghcr.io/k8snetworkplumbingwg/whereabouts:|whereabouts-version|
-
* - multus CNI
- |multus-version|
- ghcr.io/k8snetworkplumbingwg/multus-cni:|multus-version|
-
* - IPoIB CNI
- |ipoib-cni-version|
- ghcr.io/mellanox/ipoib-cni:|ipoib-cni-version|
-
* - IB Kubernetes
- |ib-kubernetes-version|
- ghcr.io/mellanox/ib-kubernetes:|ib-kubernetes-version|
-
* - NV IPAM Plugin
- |nvidia-ipam-version|
- ghcr.io/mellanox/nvidia-k8s-ipam:|nvidia-ipam-version|
-
* - NIC Feature Discovery
- |nic-feature-discovery-version|
- ghcr.io/mellanox/nic-feature-discovery:|nic-feature-discovery-version|
- Only one instance of NFD should be deployed.
* - DOCA Telemetry
- |doca-telemetry-version|
- nvcr.io/nvidia/doca/doca_telemetry:|doca-telemetry-version|
-

===================
Expand Down

0 comments on commit 1757644

Please sign in to comment.