Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/advanced/proxy-airgapped.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ NicClusterPolicy supports use of image container digest in the `version` field,

There is one caveat with regards to the DOCA driver image. The version field must be appended by the OS name and Architecture running on the worker node.

For example for DOCA driver version |mofed-version|, the tag for Ubuntu 24.04 with X86 architecture is "|mofed-version|-ubuntu24.04-amd64".
For example for DOCA driver version |doca-driver-version|, the tag for Ubuntu 24.04 with X86 architecture is "|doca-driver-version|-ubuntu24.04-amd64".
Available DOCA driver image tags can be found at `NGC <https://catalog.ngc.nvidia.com/orgs/nvidia/teams/mellanox/containers/doca-driver/tags>`_.

In case of local registry required authentication, make sure to create a pull secret and configure in NicClusterPolicy accordingly.
Expand Down
6 changes: 3 additions & 3 deletions docs/common/vars.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. |network-operator-version| replace:: v25.1.0
.. |helm-chart-version| replace:: 25.1.0
.. |ocp-channel| replace:: v25.1
.. |mofed-version| replace:: 25.01-0.6.0.0-0
.. |mofed-version-lts| replace:: 24.10-0.7.0.0-0
.. |mofed-init-container-version| replace:: v0.0.3
.. |doca-driver-version| replace:: 25.01-0.6.0.0-0
.. |doca-driver-version-lts| replace:: 24.10-0.7.0.0-0
.. |doca-init-container-version| replace:: v0.0.3
.. |sriov-device-plugin-version| replace:: v3.9.0
.. |k8s-rdma-shared-dev-plugin-version| replace:: v1.5.2
.. |ib-kubernetes-version| replace:: v1.1.0
Expand Down
2 changes: 1 addition & 1 deletion docs/customizations/cr-full-example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This example should serve as a reference, it is not recommended to apply it as i
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
upgradePolicy:
autoUpgrade: true
drain:
Expand Down
26 changes: 13 additions & 13 deletions docs/getting-started-kubernetes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Note: You may need to change the interface names in the NicClusterPolicy to thos
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
forcePrecompiled: false
imagePullSecrets: []
terminationGracePeriodSeconds: 300
Expand Down Expand Up @@ -271,7 +271,7 @@ Note: You may need to change the interface names in the NicClusterPolicy to thos
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
forcePrecompiled: false
imagePullSecrets: []
terminationGracePeriodSeconds: 300
Expand Down Expand Up @@ -592,7 +592,7 @@ The ``pod.yaml`` configuration file for such a deployment:
restartPolicy: OnFailure
containers:
- image:
name: mofed-test-ctr
name: doca-test-ctr
securityContext:
capabilities:
add: [ "IPC_LOCK" ]
Expand Down Expand Up @@ -738,7 +738,7 @@ Once the Network Operator is installed create a NicClusterPolicy with:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
forcePrecompiled: false
imagePullSecrets: []
terminationGracePeriodSeconds: 300
Expand Down Expand Up @@ -871,7 +871,7 @@ The ``pod.yaml`` configuration file for such a deployment:
restartPolicy: OnFailure
containers:
- image:
name: mofed-test-ctr
name: doca-test-ctr
securityContext:
capabilities:
add: [ "IPC_LOCK" ]
Expand Down Expand Up @@ -923,7 +923,7 @@ Once the Network Operator is installed create a NicClusterPolicy with:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
forcePrecompiled: false
imagePullSecrets: []
terminationGracePeriodSeconds: 300
Expand Down Expand Up @@ -1101,7 +1101,7 @@ Once the Network Operator is installed create a NicClusterPolicy with:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
forcePrecompiled: false
imagePullSecrets: []
terminationGracePeriodSeconds: 300
Expand Down Expand Up @@ -1378,7 +1378,7 @@ Once the Network Operator is installed create a NicClusterPolicy with:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
forcePrecompiled: false
imagePullSecrets: []
terminationGracePeriodSeconds: 300
Expand Down Expand Up @@ -1571,7 +1571,7 @@ Once the Network Operator is installed create a NicClusterPolicy with:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
forcePrecompiled: false
imagePullSecrets: []
terminationGracePeriodSeconds: 300
Expand Down Expand Up @@ -1753,7 +1753,7 @@ Network Operator Deployment for DPDK Workloads with NicClusterPolicy

.. _HUGEPAGE: http://manpages.ubuntu.com/manpages/focal/man8/hugeadm.8.html

This deployment mode supports DPDK applications. In order to run DPDK applications, HUGEPAGE_ should be configured on the required K8s Worker Nodes. By default, the inbox operating system driver is used. For support of cases with specific requirements, OFED container should be deployed.
This deployment mode supports DPDK applications. In order to run DPDK applications, HUGEPAGE_ should be configured on the required K8s Worker Nodes. By default, the inbox operating system driver is used. For support of cases with specific requirements, DOCA Driver container should be deployed.

Network Operator deployment with:

Expand All @@ -1773,7 +1773,7 @@ Network Operator deployment with:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
sriovDevicePlugin:
image: sriov-network-device-plugin
repository: ghcr.io/k8snetworkplumbingwg
Expand Down Expand Up @@ -2192,7 +2192,7 @@ Please see the following DOCA documentation for OVS hardware offload verificatio
Network Operator Deployment and OpenvSwitch offload - externally managed OpenvSwitch with VF lag
------------------------------------------------------------------------------------------------

.. warning:: This feature is not compatible with the OFED container.
.. warning:: This feature is not compatible with the DOCA Driver container.

.. warning:: This feature is supported only for Vanilla Kubernetes deployments with SR-IOV Network Operator.

Expand Down Expand Up @@ -2698,7 +2698,7 @@ NIC Configuration Operator updates status conditions of the NicDevice CR to set

.. warning:: NIC Firmware Mismatch feature doesn't support NVIDIA BlueField-3 NIC.

`FirmwareConfigMatch` condition status is set to `Unknown` if MOFED is not installed otherwise it notifies if current NIC firmware is recommended or not recommended by MOFED. E.g.:
`FirmwareConfigMatch` condition status is set to `Unknown` if DOCA Driver is not installed otherwise it notifies if current NIC firmware is recommended or not recommended by DOCA Driver. E.g.:

.. code-block:: bash

Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started-openshift.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ SR-IOV device plugin, single SR-IOV resource pool:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
startupProbe:
initialDelaySeconds: 10
periodSeconds: 20
Expand Down Expand Up @@ -350,7 +350,7 @@ Note that the SR-IOV Network Operator is required as described in the Deployment
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
startupProbe:
initialDelaySeconds: 10
periodSeconds: 20
Expand Down Expand Up @@ -457,7 +457,7 @@ The following is an example of RDMA Shared with MacVlanNetwork:
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
startupProbe:
initialDelaySeconds: 10
periodSeconds: 20
Expand Down
4 changes: 2 additions & 2 deletions docs/life-cycle-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ To enable automatic DOCA Driver upgrade, define the UpgradePolicy section for th
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
upgradePolicy:
# autoUpgrade is a global switch for automatic upgrade feature
# if set to false all other options are ignored
Expand Down Expand Up @@ -374,7 +374,7 @@ The status upgrade of each node is reflected in its nvidia.com/ofed-driver-upgra
ofedDriver:
image: doca-driver
repository: nvcr.io/nvidia/mellanox
version: |mofed-version|
version: |doca-driver-version|
upgradePolicy:
autoUpgrade: true
maxParallelUpgrades: 1
Expand Down
4 changes: 2 additions & 2 deletions docs/platform-support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ The following component versions are deployed by the Network Operator:
- 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
- nvcr.io/nvidia/mellanox/doca-driver:|mofed-version|
- LTS version: |mofed-version-lts|
- nvcr.io/nvidia/mellanox/doca-driver:|doca-driver-version|
- LTS version: |doca-driver-version-lts|
* - k8s-rdma-shared-device-plugin
- ghcr.io/mellanox/k8s-rdma-shared-dev-plugin:|k8s-rdma-shared-dev-plugin-version|
-
Expand Down
6 changes: 3 additions & 3 deletions hack/release/templates/vars/vars.template
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. |network-operator-version| replace:: {{ .NetworkOperator.Version }}
.. |helm-chart-version| replace:: {{ .HelmChartVersion }}
.. |ocp-channel| replace:: {{ .OcpDefaulChannel }}
.. |mofed-version| replace:: {{ .Mofed.Version }}
.. |mofed-version-lts| replace:: 24.10-0.7.0.0-0
.. |mofed-init-container-version| replace:: {{ .NetworkOperatorInitContainer.Version }}
.. |doca-driver-version| replace:: {{ .Mofed.Version }}
.. |doca-driver-version-lts| replace:: 24.10-0.7.0.0-0
.. |doca-init-container-version| replace:: {{ .NetworkOperatorInitContainer.Version }}
.. |sriov-device-plugin-version| replace:: {{ .SriovDevicePlugin.Version }}
.. |k8s-rdma-shared-dev-plugin-version| replace:: {{ .RdmaSharedDevicePlugin.Version }}
.. |ib-kubernetes-version| replace:: {{ .IbKubernetes.Version }}
Expand Down