Skip to content

Commit 3fc5b62

Browse files
committed
task: update documentation for v25.10.0-beta.5
Signed-off-by: nvidia-ci-cd <[email protected]>
1 parent 0aec51e commit 3fc5b62

File tree

15 files changed

+244
-223
lines changed

15 files changed

+244
-223
lines changed

docs/advanced/images-sha256.rst

Lines changed: 158 additions & 137 deletions
Large diffs are not rendered by default.

docs/common/vars.rst

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,47 @@
1-
.. |network-operator-version| replace:: v25.10.0-beta.4
1+
.. |network-operator-version| replace:: v25.10.0-beta.5
22
.. |network-operator-repository| replace:: nvcr.io/nvstaging/mellanox
3-
.. |helm-chart-version| replace:: 25.10.0-beta.4
4-
.. |doca-driver-version| replace:: doca3.2.0-25.10-1.1.2.0-0
3+
.. |helm-chart-version| replace:: 25.10.0-beta.5
4+
.. |doca-driver-version| replace:: doca3.2.0-25.10-1.1.7.0-0
55
.. |doca-driver-repository| replace:: nvcr.io/nvstaging/mellanox
66
.. |doca-driver-version-lts| replace:: 24.10-0.7.0.0-0
7-
.. |doca-init-container-version| replace:: network-operator-v25.10.0-beta.4
7+
.. |doca-init-container-version| replace:: network-operator-v25.10.0-beta.5
88
.. |doca-init-container-repository| replace:: nvcr.io/nvstaging/mellanox
9-
.. |sriov-device-plugin-version| replace:: network-operator-v25.10.0-beta.4
9+
.. |sriov-device-plugin-version| replace:: network-operator-v25.10.0-beta.5
1010
.. |sriov-device-plugin-repository| replace:: nvcr.io/nvstaging/mellanox
11-
.. |k8s-rdma-shared-dev-plugin-version| replace:: network-operator-v25.10.0-beta.4
11+
.. |k8s-rdma-shared-dev-plugin-version| replace:: network-operator-v25.10.0-beta.5
1212
.. |k8s-rdma-shared-dev-plugin-repository| replace:: nvcr.io/nvstaging/mellanox
13-
.. |ib-kubernetes-version| replace:: network-operator-v25.10.0-beta.4
13+
.. |ib-kubernetes-version| replace:: network-operator-v25.10.0-beta.5
1414
.. |ib-kubernetes-repository| replace:: nvcr.io/nvstaging/mellanox
15-
.. |cni-plugins-version| replace:: network-operator-v25.10.0-beta.4
15+
.. |cni-plugins-version| replace:: network-operator-v25.10.0-beta.5
1616
.. |cni-plugins-repository| replace:: nvcr.io/nvstaging/mellanox
17-
.. |multus-version| replace:: network-operator-v25.10.0-beta.4
17+
.. |multus-version| replace:: network-operator-v25.10.0-beta.5
1818
.. |multus-repository| replace:: nvcr.io/nvstaging/mellanox
19-
.. |ipoib-cni-version| replace:: network-operator-v25.10.0-beta.4
19+
.. |ipoib-cni-version| replace:: network-operator-v25.10.0-beta.5
2020
.. |ipoib-cni-repository| replace:: nvcr.io/nvstaging/mellanox
21-
.. |nvidia-ipam-version| replace:: network-operator-v25.10.0-beta.4
21+
.. |nvidia-ipam-version| replace:: network-operator-v25.10.0-beta.5
2222
.. |nvidia-ipam-repository| replace:: nvcr.io/nvstaging/mellanox
23-
.. |nic-feature-discovery-version| replace:: network-operator-v25.10.0-beta.4
23+
.. |nic-feature-discovery-version| replace:: network-operator-v25.10.0-beta.5
2424
.. |nic-feature-discovery-repository| replace:: nvcr.io/nvstaging/mellanox
25-
.. |sriovnetop-version| replace:: network-operator-v25.10.0-beta.4
25+
.. |sriovnetop-version| replace:: network-operator-v25.10.0-beta.5
2626
.. |sriovnetop-repository| replace:: nvcr.io/nvstaging/mellanox
27-
.. |sriovnetop-sriov-cni-version| replace:: network-operator-v25.10.0-beta.4
27+
.. |sriovnetop-sriov-cni-version| replace:: network-operator-v25.10.0-beta.5
2828
.. |sriovnetop-sriov-cni-repository| replace:: nvcr.io/nvstaging/mellanox
29-
.. |sriovnetop-ib-sriov-cni-version| replace:: network-operator-v25.10.0-beta.4
29+
.. |sriovnetop-ib-sriov-cni-version| replace:: network-operator-v25.10.0-beta.5
3030
.. |sriovnetop-ib-sriov-cni-repository| replace:: nvcr.io/nvstaging/mellanox
31-
.. |sriovnetop-sriov-device-plugin-version| replace:: network-operator-v25.10.0-beta.4
31+
.. |sriovnetop-sriov-device-plugin-version| replace:: network-operator-v25.10.0-beta.5
3232
.. |sriovnetop-sriov-device-plugin-repository| replace:: nvcr.io/nvstaging/mellanox
3333
.. |doca-telemetry-version| replace:: 1.22.5-doca3.1.0-host
3434
.. |doca-telemetry-repository| replace:: nvcr.io/nvidia/doca
35-
.. |node-feature-discovery-version| replace:: network-operator-v25.10.0-beta.4
35+
.. |node-feature-discovery-version| replace:: network-operator-v25.10.0-beta.5
3636
.. |node-feature-discovery-repository| replace:: nvcr.io/nvstaging/mellanox
37-
.. |doca-driver-build-commit| replace:: e74163010653bad1de33ead5a607f5e821ac9eb8
38-
.. |nic-configuration-operator-version| replace:: network-operator-v25.10.0-beta.4
37+
.. |doca-driver-build-commit| replace:: 701cb52ae9ccaf002f0114eff04135dd7502b314
38+
.. |nic-configuration-operator-version| replace:: network-operator-v25.10.0-beta.5
3939
.. |nic-configuration-operator-repository| replace:: nvcr.io/nvstaging/mellanox
40-
.. |maintenance-operator-version| replace:: network-operator-v25.10.0-beta.4
40+
.. |maintenance-operator-version| replace:: network-operator-v25.10.0-beta.5
4141
.. |maintenance-operator-repository| replace:: nvcr.io/nvstaging/mellanox
42-
.. |ovs-cni-version| replace:: network-operator-v25.10.0-beta.4
42+
.. |ovs-cni-version| replace:: network-operator-v25.10.0-beta.5
4343
.. |ovs-cni-repository| replace:: nvcr.io/nvstaging/mellanox
44-
.. |rdma-cni-version| replace:: network-operator-v25.10.0-beta.4
44+
.. |rdma-cni-version| replace:: network-operator-v25.10.0-beta.5
4545
.. |rdma-cni-repository| replace:: nvcr.io/nvstaging/mellanox
46-
.. |spectrumxop-version| replace:: network-operator-v25.10.0-beta.4
46+
.. |spectrumxop-version| replace:: network-operator-v25.10.0-beta.5
4747
.. |spectrumxop-repository| replace:: nvcr.io/nvstaging/mellanox
48-
.. |k8s-launch-kit-version| replace:: v25.10.0
49-
.. |k8s-launch-kit-repository| replace:: nvcr.io/nvidia/cloud-native
50-
.. |k8s-launch-kit-network-operator-repository| replace:: nvcr.io/nvidia/cloud-native
51-
.. |k8s-launch-kit-component-version| replace:: network-operator-v25.10.0

docs/customizations/crds.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -734,8 +734,8 @@ NicConfigurationOperatorSpec is the configuration for NIC Configuration Operator
734734
| ``configurationDaemon`` | Image information for nic-configuration-daemon |
735735
| :ref:`ImageSpec <ImageSpec>` | |
736736
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
737-
| ``nicFirmwareStorage`` | NicFirmwareStorage contains configuration for the NIC firmware storage |
738-
| :ref:`NicFirmwareStorageSpec <NicFirmwareStorageSpec>` | |
737+
| ``nicFirmwareStorage`` | NicFirmwareStorage contains configuration for the NIC firmware storage. If not provided, the NIC |
738+
| :ref:`NicFirmwareStorageSpec <NicFirmwareStorageSpec>` | firmware storage will not be configured. |
739739
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
740740
| ``logLevel`` | LogLevel sets the verbosity level of the logs. info|debug |
741741
| string | |
@@ -758,7 +758,8 @@ NicFirmwareStorageSpec contains configuration for the NIC firmware storage
758758
| Field | Description |
759759
+===================================================================================================+===================================================================================================+
760760
| ``create`` | Create specifies whether to create a new PVC or use an existing one If create == false, the |
761-
| bool | existing PVC should be located in the same namespace as the operator |
761+
| bool | existing PVC with the name specified in pvcName should be located in the same namespace as the |
762+
| | operator |
762763
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
763764
| ``pvcName`` | PVCName is the name of the PVC to mount as NIC Firmware storage. Default value: |
764765
| string | “nic-fw-storage-pvc” |

docs/customizations/helm.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ General Parameters
127127
- Init container image repository.
128128
* - operator.ofedDriver.initContainer.version
129129
- string
130-
- `"network-operator-v25.10.0-beta.4"`
130+
- `"network-operator-v25.10.0-beta.5"`
131131
- Init container image version.
132132
* - operator.repository
133133
- string
@@ -247,7 +247,7 @@ Node Feature Discovery Helm chart customization options can be found `here <http
247247
-
248248
* - node-feature-discovery.image.tag
249249
- string
250-
- `"network-operator-v25.10.0-beta.4"`
250+
- `"network-operator-v25.10.0-beta.5"`
251251
-
252252
* - node-feature-discovery.master
253253
- yaml
@@ -309,35 +309,35 @@ SR-IOV Network Operator Helm chart customization options can be found `here <htt
309309
- Notes
310310
* - sriov-network-operator.images.ibSriovCni
311311
- string
312-
- `"nvcr.io/nvstaging/mellanox/ib-sriov-cni:network-operator-v25.10.0-beta.4"`
312+
- `"nvcr.io/nvstaging/mellanox/ib-sriov-cni:network-operator-v25.10.0-beta.5"`
313313
-
314314
* - sriov-network-operator.images.operator
315315
- string
316-
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator:network-operator-v25.10.0-beta.4"`
316+
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator:network-operator-v25.10.0-beta.5"`
317317
-
318318
* - sriov-network-operator.images.ovsCni
319319
- string
320-
- `"nvcr.io/nvstaging/mellanox/ovs-cni-plugin:network-operator-v25.10.0-beta.4"`
320+
- `"nvcr.io/nvstaging/mellanox/ovs-cni-plugin:network-operator-v25.10.0-beta.5"`
321321
-
322322
* - sriov-network-operator.images.resourcesInjector
323323
- string
324324
- `"ghcr.io/k8snetworkplumbingwg/network-resources-injector:v1.7.0"`
325325
-
326326
* - sriov-network-operator.images.sriovCni
327327
- string
328-
- `"nvcr.io/nvstaging/mellanox/sriov-cni:network-operator-v25.10.0-beta.4"`
328+
- `"nvcr.io/nvstaging/mellanox/sriov-cni:network-operator-v25.10.0-beta.5"`
329329
-
330330
* - sriov-network-operator.images.sriovConfigDaemon
331331
- string
332-
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-config-daemon:network-operator-v25.10.0-beta.4"`
332+
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-config-daemon:network-operator-v25.10.0-beta.5"`
333333
-
334334
* - sriov-network-operator.images.sriovDevicePlugin
335335
- string
336-
- `"nvcr.io/nvstaging/mellanox/sriov-network-device-plugin:network-operator-v25.10.0-beta.4"`
336+
- `"nvcr.io/nvstaging/mellanox/sriov-network-device-plugin:network-operator-v25.10.0-beta.5"`
337337
-
338338
* - sriov-network-operator.images.webhook
339339
- string
340-
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-webhook:network-operator-v25.10.0-beta.4"`
340+
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-webhook:network-operator-v25.10.0-beta.5"`
341341
-
342342
* - sriov-network-operator.operator.admissionControllers
343343
- yaml
@@ -415,6 +415,9 @@ SR-IOV Network Operator Helm chart customization options can be found `here <htt
415415

416416
beta.kubernetes.io/os: "linux"
417417
network.nvidia.com/operator.mofed.wait: "false"
418+
# Enable when using together with NIC Configuration Operator to wait until
419+
# all required FW parameters are successfully applied before configuring SR-IOV
420+
# network.nvidia.com/operator.nic-configuration.wait: "false"
418421

419422
- Selects the nodes to be configured
420423
* - sriov-network-operator.sriovOperatorConfig.deploy
@@ -465,7 +468,7 @@ Maintenance Operator Helm chart customization options can be found `here <https:
465468
-
466469
* - maintenance-operator-chart.operator.image.tag
467470
- string
468-
- `"network-operator-v25.10.0-beta.4"`
471+
- `"network-operator-v25.10.0-beta.5"`
469472
-
470473
* - maintenance-operator-chart.operatorConfig
471474
- object

docs/nic-conf-operator/configuration-details.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,10 @@ Configuration details
5555
- ``CNP_DSCP_P1=4``, ``CNP_DSCP_P2=4``
5656
- ``CNP_802P_PRIO_P1=6``, ``CNP_802P_PRIO_P2=6``
5757

58-
- Configure pfc (Priority Flow Control) for priority 3 and set trust to dscp on each PF
58+
- Configure pfc (Priority Flow Control) for priority 3, set trust to dscp on each PF, set ToS (Type of Service) to 0.
5959

6060
- Non-persistent (need to be applied after each boot)
61-
- Users can override values via ``trust`` and ``pfc`` parameters
61+
- Users can override values via ``trust``, ``pfc`` and ``tos`` parameters
6262

6363
- Can only be enabled with ``linkType=Ethernet``
6464

examples/processed/host-device-rdma/10-nicclusterpolicy.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ spec:
66
sriovDevicePlugin:
77
image: sriov-network-device-plugin
88
repository: nvcr.io/nvstaging/mellanox
9-
version: network-operator-v25.10.0-beta.4
9+
version: network-operator-v25.10.0-beta.5
1010
config: |
1111
{
1212
"resourceList": [
@@ -23,15 +23,15 @@ spec:
2323
nvIpam:
2424
image: nvidia-k8s-ipam
2525
repository: nvcr.io/nvstaging/mellanox
26-
version: network-operator-v25.10.0-beta.4
26+
version: network-operator-v25.10.0-beta.5
2727
imagePullSecrets: []
2828
enableWebhook: false
2929
secondaryNetwork:
3030
cniPlugins:
3131
image: plugins
3232
repository: nvcr.io/nvstaging/mellanox
33-
version: network-operator-v25.10.0-beta.4
33+
version: network-operator-v25.10.0-beta.5
3434
multus:
3535
image: multus-cni
3636
repository: nvcr.io/nvstaging/mellanox
37-
version: network-operator-v25.10.0-beta.4
37+
version: network-operator-v25.10.0-beta.5

examples/processed/host-device-rdma/complete.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ spec:
66
sriovDevicePlugin:
77
image: sriov-network-device-plugin
88
repository: nvcr.io/nvstaging/mellanox
9-
version: network-operator-v25.10.0-beta.4
9+
version: network-operator-v25.10.0-beta.5
1010
config: |
1111
{
1212
"resourceList": [
@@ -23,18 +23,18 @@ spec:
2323
nvIpam:
2424
image: nvidia-k8s-ipam
2525
repository: nvcr.io/nvstaging/mellanox
26-
version: network-operator-v25.10.0-beta.4
26+
version: network-operator-v25.10.0-beta.5
2727
imagePullSecrets: []
2828
enableWebhook: false
2929
secondaryNetwork:
3030
cniPlugins:
3131
image: plugins
3232
repository: nvcr.io/nvstaging/mellanox
33-
version: network-operator-v25.10.0-beta.4
33+
version: network-operator-v25.10.0-beta.5
3434
multus:
3535
image: multus-cni
3636
repository: nvcr.io/nvstaging/mellanox
37-
version: network-operator-v25.10.0-beta.4
37+
version: network-operator-v25.10.0-beta.5
3838
---
3939
apiVersion: nv-ipam.nvidia.com/v1alpha1
4040
kind: IPPool

examples/processed/ipoib-rdma-shared/10-nicclusterpolicy.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ spec:
66
ofedDriver:
77
image: doca-driver
88
repository: nvcr.io/nvstaging/mellanox
9-
version: doca3.2.0-25.10-1.1.0.0-0
9+
version: doca3.2.0-25.10-1.1.7.0-0
1010
rdmaSharedDevicePlugin:
1111
image: k8s-rdma-shared-dev-plugin
1212
repository: nvcr.io/nvstaging/mellanox
13-
version: network-operator-v25.10.0-beta.4
13+
version: network-operator-v25.10.0-beta.5
1414
config: |
1515
{
1616
"configList": [
@@ -40,19 +40,19 @@ spec:
4040
nvIpam:
4141
image: nvidia-k8s-ipam
4242
repository: nvcr.io/nvstaging/mellanox
43-
version: network-operator-v25.10.0-beta.4
43+
version: network-operator-v25.10.0-beta.5
4444
imagePullSecrets: []
4545
enableWebhook: false
4646
secondaryNetwork:
4747
cniPlugins:
4848
image: plugins
4949
repository: nvcr.io/nvstaging/mellanox
50-
version: network-operator-v25.10.0-beta.4
50+
version: network-operator-v25.10.0-beta.5
5151
multus:
5252
image: multus-cni
5353
repository: nvcr.io/nvstaging/mellanox
54-
version: network-operator-v25.10.0-beta.4
54+
version: network-operator-v25.10.0-beta.5
5555
ipoib:
5656
image: ipoib-cni
5757
repository: nvcr.io/nvstaging/mellanox
58-
version: network-operator-v25.10.0-beta.4
58+
version: network-operator-v25.10.0-beta.5

examples/processed/ipoib-rdma-shared/complete.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ spec:
66
ofedDriver:
77
image: doca-driver
88
repository: nvcr.io/nvstaging/mellanox
9-
version: doca3.2.0-25.10-1.1.0.0-0
9+
version: doca3.2.0-25.10-1.1.7.0-0
1010
rdmaSharedDevicePlugin:
1111
image: k8s-rdma-shared-dev-plugin
1212
repository: nvcr.io/nvstaging/mellanox
13-
version: network-operator-v25.10.0-beta.4
13+
version: network-operator-v25.10.0-beta.5
1414
config: |
1515
{
1616
"configList": [
@@ -40,22 +40,22 @@ spec:
4040
nvIpam:
4141
image: nvidia-k8s-ipam
4242
repository: nvcr.io/nvstaging/mellanox
43-
version: network-operator-v25.10.0-beta.4
43+
version: network-operator-v25.10.0-beta.5
4444
imagePullSecrets: []
4545
enableWebhook: false
4646
secondaryNetwork:
4747
cniPlugins:
4848
image: plugins
4949
repository: nvcr.io/nvstaging/mellanox
50-
version: network-operator-v25.10.0-beta.4
50+
version: network-operator-v25.10.0-beta.5
5151
multus:
5252
image: multus-cni
5353
repository: nvcr.io/nvstaging/mellanox
54-
version: network-operator-v25.10.0-beta.4
54+
version: network-operator-v25.10.0-beta.5
5555
ipoib:
5656
image: ipoib-cni
5757
repository: nvcr.io/nvstaging/mellanox
58-
version: network-operator-v25.10.0-beta.4
58+
version: network-operator-v25.10.0-beta.5
5959
---
6060
apiVersion: nv-ipam.nvidia.com/v1alpha1
6161
kind: IPPool

examples/processed/macvlan-rdma-shared/10-nicclusterpolicy.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ spec:
66
rdmaSharedDevicePlugin:
77
image: k8s-rdma-shared-dev-plugin
88
repository: nvcr.io/nvstaging/mellanox
9-
version: network-operator-v25.10.0-beta.4
9+
version: network-operator-v25.10.0-beta.5
1010
config: |
1111
{
1212
"configList": [
@@ -22,15 +22,15 @@ spec:
2222
nvIpam:
2323
image: nvidia-k8s-ipam
2424
repository: nvcr.io/nvstaging/mellanox
25-
version: network-operator-v25.10.0-beta.4
25+
version: network-operator-v25.10.0-beta.5
2626
imagePullSecrets: []
2727
enableWebhook: false
2828
secondaryNetwork:
2929
cniPlugins:
3030
image: plugins
3131
repository: nvcr.io/nvstaging/mellanox
32-
version: network-operator-v25.10.0-beta.4
32+
version: network-operator-v25.10.0-beta.5
3333
multus:
3434
image: multus-cni
3535
repository: nvcr.io/nvstaging/mellanox
36-
version: network-operator-v25.10.0-beta.4
36+
version: network-operator-v25.10.0-beta.5

0 commit comments

Comments
 (0)