Skip to content

Commit ecc8d26

Browse files
committed
update notice on the Maintenance Operator in the NIC Config section
Signed-off-by: Alexander Maslennikov <[email protected]>
1 parent a3b70a1 commit ecc8d26

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/getting-started-kubernetes.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2559,16 +2559,21 @@ Configure NIC Firmware using the NIC Configuration Operator
25592559
===========================================================================
25602560
`NVIDIA NIC Configuration Operator <https://github.com/Mellanox/nic-configuration-operator>`_ provides Kubernetes API (Custom Resource Definition) to allow Firmware update and configuration on NVIDIA NICs in a coordinated manner. It deploys a configuration daemon on each of the desired nodes to configure NVIDIA NICs there. NVIDIA NIC Configuration Operator uses `Maintenance Operator <https://github.com/Mellanox/maintenance-operator>`_ to prepare a node for maintenance before the actual configuration.
25612561

2562-
.. warning:: `Maintenance Operator <https://github.com/Mellanox/maintenance-operator>`_ is required to be deployed in the cluster for the NIC Configuration Operator
2563-
25642562
.. warning:: NVIDIA NIC Configuration Operator does not support FW reset flow for DPU mode. Check `limitations <https://github.com/Mellanox/network-operator-docs/blob/main/docs/release-notes.rst>`_
25652563

25662564
.. note::
25672565
To perform Firmware validation and update on NIC devices, NIC Configuration Operator requires a persistent storage set up in the cluster.
25682566
To set up a persistent NFS storage in the cluster, the `example from the CSI NFS Driver repository <https://github.com/kubernetes-csi/csi-driver-nfs/blob/master/deploy/example/nfs-provisioner/README.md>`_ might be used.
25692567
After deploying the NFS server and NFS CSI driver, the `storage class <https://github.com/kubernetes-csi/csi-driver-nfs/blob/master/deploy/example/storageclass-nfs.yaml>`_ should become available in the cluster. The name of the storage class should then be passed when configuring the NIC Configuration Operator.
25702568

2571-
First install the Network Operator and deploy a NIC Cluster Policy CRD with NIC Configuration Operator enabled:
2569+
First install the Network Operator helm chart with the Maintenance Operator enabled and deploy a NIC Cluster Policy CRD with NIC Configuration Operator enabled:
2570+
2571+
``values.yaml``:
2572+
2573+
.. code-block:: yaml
2574+
2575+
maintenanceOperator:
2576+
enabled: true
25722577
25732578
``nicclusterpolicy.yaml``:
25742579

0 commit comments

Comments
 (0)