Skip to content

update docs on NIC Configuration Operator #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2025
Merged

update docs on NIC Configuration Operator #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/common/vars.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@
.. |doca-telemetry-version| replace:: 1.16.5-doca2.6.0-host
.. |node-feature-discovery-version| replace:: v0.15.6
.. |doca-driver-build-commit| replace:: 6f2fb2243dad12f4ff45ea18b9291dcee68056b7
.. |nic-configuration-operator-version| replace:: v0.1.18
15 changes: 15 additions & 0 deletions docs/customizations/cr-full-example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,18 @@ This example should serve as a reference, it is not recommended to apply it as i
image: doca_telemetry
repository: nvcr.io/nvidia/doca
version: |doca-telemetry-version|
nicConfigurationOperator:
operator:
image: nic-configuration-operator
repository: ghcr.io/mellanox
version: |nic-configuration-operator-version|
configurationDaemon:
image: nic-configuration-operator-daemon
repository: ghcr.io/mellanox
version: |nic-configuration-operator-version|
nicFirmwareStorage:
create: true
pvcName: nic-fw-storage-pvc
storageClassName: nic-fw-storage-class
availableStorageSize: 1Gi
logLevel: info
64 changes: 63 additions & 1 deletion docs/customizations/crds.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,8 @@ ImageSpec
~~~~~~~~~

(*Appears on:* :ref:`DOCATelemetryServiceSpec <DOCATelemetryServiceSpec>`, :ref:`IBKubernetesSpec <IBKubernetesSpec>`, :ref:`ImageSpecWithConfig <ImageSpecWithConfig>`,
:ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>`, :ref:`NVIPAMSpec <NVIPAMSpec>`, :ref:`OFEDDriverSpec <OFEDDriverSpec>`, :ref:`SecondaryNetworkSpec <SecondaryNetworkSpec>`)
:ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>`, :ref:`NVIPAMSpec <NVIPAMSpec>`, :ref:`NicConfigurationOperatorSpec <NicConfigurationOperatorSpec>`, :ref:`OFEDDriverSpec <OFEDDriverSpec>`,
:ref:`SecondaryNetworkSpec <SecondaryNetworkSpec>`)

ImageSpec Contains container image specifications

Expand Down Expand Up @@ -671,6 +672,9 @@ NicClusterPolicySpec defines the desired state of NicClusterPolicy
| ``docaTelemetryService`` | DOCATelemetryService exposes telemetry from NVIDIA networking components to prometheus. See: |
| :ref:`DOCATelemetryServiceSpec <DOCATelemetryServiceSpec>` | https://docs.nvidia.com/doca/sdk/nvidia+doca+telemetry+service+guide/index.html |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nicConfigurationOperator`` | NicConfigurationOperator provides Kubernetes CRD API to allow FW configuration on NVIDIA NICs in |
| :ref:`NicConfigurationOperatorSpec <NicConfigurationOperatorSpec>` | a coordinated manner See: https://github.com/Mellanox/nic-configuration-operator |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nodeAffinity`` | NodeAffinity rules to inject to the DaemonSets objects that are managed by the operator |
| `Kubernetes core/v1.NodeAffinity <https://godoc.org/k8s.io/api/core/v1#NodeAffinity>`__ | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
Expand Down Expand Up @@ -704,6 +708,64 @@ NicClusterPolicyStatus defines the observed state of NicClusterPolicy
| :ref:`[]AppliedState <AppliedState>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _NicConfigurationOperatorSpec:

NicConfigurationOperatorSpec
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

(*Appears on:* :ref:`NicClusterPolicySpec <NicClusterPolicySpec>`)

NicConfigurationOperatorSpec is the configuration for NIC Configuration Operator

.. container:: md-typeset__scrollwrap

.. container:: md-typeset__table

+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===================================================================================================+===================================================================================================+
| ``operator`` | Image information for nic-configuration-operator |
| :ref:`ImageSpec <ImageSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``configurationDaemon`` | Image information for nic-configuration-daemon |
| :ref:`ImageSpec <ImageSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nicFirmwareStorage`` | NicFirmwareStorage contains configuration for the NIC firmware storage |
| :ref:`NicFirmwareStorageSpec <NicFirmwareStorageSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``logLevel`` | LogLevel sets the verbosity level of the logs. info|debug |
| string | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _NicFirmwareStorageSpec:

NicFirmwareStorageSpec
~~~~~~~~~~~~~~~~~~~~~~

(*Appears on:* :ref:`NicConfigurationOperatorSpec <NicConfigurationOperatorSpec>`)

NicFirmwareStorageSpec contains configuration for the NIC firmware storage

.. container:: md-typeset__scrollwrap

.. container:: md-typeset__table

+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===================================================================================================+===================================================================================================+
| ``create`` | Create specifies whether to create a new PVC or use an existing one |
| bool | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``pvcName`` | PVCName is the name of the PVC to mount as NIC Firmware storage. Default value: |
| string | “nic-fw-storage-pvc” |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``storageClassName`` | StorageClassName is the name of a storage class to be used to store NIC FW binaries during NIC FW |
| string | upgrade. If not provided, the cluster-default storage class will be used |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``availableStorageSize`` | storage size for the NIC Configuration Operator to request. Default value: 1Gi |
| string | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _OFEDDriverSpec:

OFEDDriverSpec
Expand Down
8 changes: 6 additions & 2 deletions docs/customizations/helm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ General Parameters
- bool
- `true`
- Deploy Node Feature Discovery operator.
* - nicConfigurationOperator
- object
- `{"enabled":false}`
- NIC Configuration Operator helm chart is deprecated and will be deleted in future releases. Use NIC Cluster Policy to deploy the NIC Configuration Operator instead.
* - nicConfigurationOperator.enabled
- bool
- `false`
Expand Down Expand Up @@ -425,7 +429,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.configDaemon.image.tag
- string
- `"v0.1.17"`
- `"v0.1.18"`
-
* - nic-configuration-operator-chart.operator.image.name
- string
Expand All @@ -437,7 +441,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.operator.image.tag
- string
- `"v0.1.17"`
- `"v0.1.18"`
-

====================
Expand Down
Loading