feat: Document NIC Firmware Mismatch feature

Signed-off-by: Ivan Kolodiazhnyi <[email protected]>
Mellanox · Nov 25, 2024 · 08490bc · 08490bc
1 parent dbd4263
commit 08490bc
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 1 deletion.
diff --git a/docs/getting-started-kubernetes.rst b/docs/getting-started-kubernetes.rst
@@ -2705,4 +2705,34 @@ Status conditions of the NicDevice CR reflect the status of the configuration up
       message: ""
       reason: UpdateStarted
       status: "True"
-      type: ConfigUpdateInProgress
+      type: ConfigUpdateInProgress
+
+----------------------------------
+NIC Firmware Mismatch Notification
+----------------------------------
+
+NIC Configuration Operator updates status conditions of the NicDevice CR to set `FirmwareConfigMatch` condition based on a current NIC firmware:
+
+.. code-block:: bash
+
+    > kubectl get nicdevice -n nic-configuration-operator cloud-dev-40-1015-mt1627x08307 -o jsonpath='{.status.conditions}' | yq -P
+
+    - lastTransitionTime: "2024-09-21T08:43:10Z"
+      message: Device firmware '20.42.1000' matches to recommended version '20.42.1000'
+      reason: DeviceFirmwareConfigMatch
+      status: "True"
+      type: FirmwareConfigMatch
+
+.. 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.:
+
+.. code-block:: bash
+
+    > kubectl get nicdevice -n nic-configuration-operator cloud-dev-40-1015-mt1627x08307 -o jsonpath='{.status.conditions}' | yq -P
+
+   - lastTransitionTime: "2024-11-08T09:19:41Z"
+     message: Device firmware '20.42.1000' matches to recommended version '20.42.1000'
+     reason: DeviceFirmwareConfigMatch
+     status: "True"
+     type: FirmwareConfigMatch
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
@@ -197,6 +197,7 @@ Known Limitations
      - | - There is a known limitation when using `docker` on RHEL 8 and 9. If you encounter this issue, it is recommended to use "the preferred, maintained, and supported container runtime of choice for Red Hat Enterprise Linux".
        |   For more details, refer to the article `Is the docker package available for Red Hat Enterprise Linux 8 and 9? <https://access.redhat.com/solutions/3696691>`_ in the Red Hat Knowledge Base.
        | - In NIC Configuration Operator template v0.1.14 BF2/BF3 DPUs (not SuperNICs) FW reset flow isn't supported.
+       | - NVIDIA NIC Configuration Operator v0.1.14 Firmware Mismatch notification feature doesn't support NVIDIA BlueField-3 SuperNIC.
    * - 24.7.0
      - | - In case ENABLE_NFSRDMA is enabled for DOCA Driver container and NVMe modules are loaded in the host system, NVIDA DOCA Driver Container will fail to load.
        |   User should blacklist NVMe modules to prevent them from loading on system boot. If this is not possible (e.g when the system uses NVMe SSD drives) then ENABLE_NFSRDMA must be set to `false`.