Skip to content

Commit

Permalink
task: update documentation for test-netops-docs-workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
@heyvister1
heyvister1 committed Nov 12, 2024
1 parent d7d51ac commit dfe718c
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 58 deletions.
8 changes: 4 additions & 4 deletions docs/common/vars.rst
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. |network-operator-version| replace:: v24.10.0-beta.5
.. |helm-chart-version| replace:: 24.10.0-beta.5
.. |network-operator-version| replace:: v24.10.0-beta.3
.. |helm-chart-version| replace:: 24.10.0-beta.3
.. |ocp-channel| replace:: v24.10
.. |mofed-version| replace:: 24.10-0.6.2.0-0
.. |mofed-version| replace:: 24.10-0.4.6.0-0
.. |mofed-init-container-version| replace:: v0.0.2
.. |sriov-device-plugin-version| replace:: v3.7.0
.. |k8s-rdma-shared-dev-plugin-version| replace:: sha-4f3eb2224b8b5f97be3f17441ddee8d41753b7d5
Expand All @@ -12,7 +12,7 @@
.. |whereabouts-version| replace:: v0.7.0
.. |nvidia-ipam-version| replace:: v0.2.0
.. |nic-feature-discovery-version| replace:: v0.0.1
.. |sriovnetop-version| replace:: network-operator-24.10.0-beta.5
.. |sriovnetop-version| replace:: network-operator-24.10.0-beta.3
.. |sriovnetop-sriov-cni-version| replace:: v2.8.1
.. |sriovnetop-ib-sriov-cni-version| replace:: v1.1.1
.. |sriovnetop-sriov-device-plugin-version| replace:: v3.7.0
Expand Down
55 changes: 22 additions & 33 deletions docs/customizations/crds.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ DevicePluginSpec describes configuration options for device plugin 1. Image info
| ``ImageSpecWithConfig`` | Image information for the device plugin and optional configuration |
| :ref:`ImageSpecWithConfig <ImageSpecWithConfig>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``useCdi`` | Enables use of container device interface (CDI) NOTE: NVIDIA Network Operator does not configure |
| bool | container runtime to enable CDI. |
| ``useCdi`` | Enables use of container device interface (CDI) |
| bool | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _DrainSpec:
Expand Down Expand Up @@ -636,46 +636,35 @@ NicClusterPolicySpec defines the desired state of NicClusterPolicy
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===================================================================================================+===================================================================================================+
| ``ofedDriver`` | OFEDDriver is a specialized driver for NVIDIA NICs which can replace the inbox driver that comes |
| :ref:`OFEDDriverSpec <OFEDDriverSpec>` | with an OS. See https://network.nvidia.com/support/mlnx-ofed-matrix/ |
| ``nodeAffinity`` | Additional nodeAffinity rules to inject to the DaemonSets objects that are managed by the |
| `Kubernetes core/v1.NodeAffinity <https://godoc.org/k8s.io/api/core/v1#NodeAffinity>`__ | operator |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``rdmaSharedDevicePlugin`` | RdmaSharedDevicePlugin manages support IB and RoCE HCAs through the Kubernetes device plugin |
| :ref:`DevicePluginSpec <DevicePluginSpec>` | framework. The config field is a json representation of the RDMA shared device plugin |
| | configuration. See https://github.com/Mellanox/k8s-rdma-shared-dev-plugin |
| ``tolerations`` | Additional tolerations to inject to the DaemonSets objects that are managed by the operator |
| `[]Kubernetes core/v1.Toleration <https://godoc.org/k8s.io/api/core/v1#Toleration>`__ | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``sriovDevicePlugin`` | SriovDevicePlugin manages SRIOV through the Kubernetes device plugin framework. The config field |
| :ref:`DevicePluginSpec <DevicePluginSpec>` | is a json representation of the RDMA shared device plugin configuration. See |
| | https://github.com/k8snetworkplumbingwg/sriov-network-device-plugin |
| ``ofedDriver`` | Configuration options for OFED driver |
| :ref:`OFEDDriverSpec <OFEDDriverSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``ibKubernetes`` | IBKubernetes provides a daemon that works in conjunction with the SR-IOV Network Device Plugin. |
| :ref:`IBKubernetesSpec <IBKubernetesSpec>` | It acts on Kubernetes pod object changes and reads the pod’s network annotation. From there it |
| | fetches the corresponding network CRD and reads the PKey. This is done in order to add the newly |
| | generated GUID or the predefined GUID in the GUID field of the CRD. This is then passed in |
| | cni-args to that PKey for pods with mellanox.infiniband.app annotation. See: |
| | https://github.com/Mellanox/ib-kubernetes |
| ``rdmaSharedDevicePlugin`` | Configuration options for RDMA shared device plugin |
| :ref:`DevicePluginSpec <DevicePluginSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``secondaryNetwork`` | SecondaryNetwork Specifies components to deploy in order to facilitate a secondary network in |
| :ref:`SecondaryNetworkSpec <SecondaryNetworkSpec>` | Kubernetes. It consists of the following optionally deployed components: - Multus-CNI: Delegate |
| | CNI plugin to support secondary networks in Kubernetes - CNI plugins: Currently only |
| | containernetworking-plugins is supported - IPAM CNI: Currently only Whereabout IPAM CNI is |
| | supported as a part of the secondaryNetwork section. - IPoIB CNI: Allows the user to create IPoIB |
| | child link and move it to the pod |
| ``sriovDevicePlugin`` | Configuration options for SRIOV device plugin |
| :ref:`DevicePluginSpec <DevicePluginSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nvIpam`` | NvIpam is an IPAM provider that dynamically assigns IP addresses with speed and performance in |
| :ref:`NVIPAMSpec <NVIPAMSpec>` | mind. Note: NvIPam requires certificate management e.g. cert-manager or OpenShift cert |
| | management. See https://github.com/Mellanox/nvidia-k8s-ipam |
| ``ibKubernetes`` | Configuration options for ib-kubernetes |
| :ref:`IBKubernetesSpec <IBKubernetesSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nicFeatureDiscovery`` | NicFeatureDiscovery works with NodeFeatureDiscovery to expose information about NVIDIA NICs. |
| :ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>` | https://github.com/Mellanox/nic-feature-discovery |
| ``secondaryNetwork`` | Configuration options for secondary network |
| :ref:`SecondaryNetworkSpec <SecondaryNetworkSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``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 |
| ``nvIpam`` | Configuration options for nv-ipam |
| :ref:`NVIPAMSpec <NVIPAMSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``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>`__ | |
| ``nicFeatureDiscovery`` | Configuration options for nic-feature-discovery |
| :ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``tolerations`` | Tolerations to inject to the DaemonSets objects that are managed by the operator |
| `[]Kubernetes core/v1.Toleration <https://godoc.org/k8s.io/api/core/v1#Toleration>`__ | |
| ``docaTelemetryService`` | Configuration options for DOCA Telemetry Service |
| :ref:`DOCATelemetryServiceSpec <DOCATelemetryServiceSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _NicClusterPolicyStatus:
Expand Down
30 changes: 9 additions & 21 deletions docs/customizations/helm.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ General Parameters
- Type
- Default
- Description
* - deployCR
- bool
- `false`
- Deploy ``NicClusterPolicy`` custom resource according to the provided parameters.
* - imagePullSecrets
- list
- `[]`
Expand Down Expand Up @@ -105,22 +109,6 @@ General Parameters
- object
- `{}`
- Configure node selector settings for the operator.
* - operator.ofedDriver.initContainer.enable
- bool
- `true`
- Deploy init container.
* - operator.ofedDriver.initContainer.image
- string
- `"network-operator-init-container"`
- Init container image name.
* - operator.ofedDriver.initContainer.repository
- string
- `"ghcr.io/mellanox"`
- Init container image repository.
* - operator.ofedDriver.initContainer.version
- string
- `"v0.0.2"`
- Init container image version.
* - operator.repository
- string
- `"nvcr.io/nvstaging/mellanox"`
Expand Down Expand Up @@ -289,7 +277,7 @@ SR-IOV Network Operator Helm chart customization options can be found `here <htt
-
* - sriov-network-operator.images.operator
- string
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator:network-operator-24.10.0-beta.5"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator:network-operator-24.10.0-beta.3"`
-
* - sriov-network-operator.images.ovsCni
- string
Expand All @@ -305,15 +293,15 @@ SR-IOV Network Operator Helm chart customization options can be found `here <htt
-
* - sriov-network-operator.images.sriovConfigDaemon
- string
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-config-daemon:network-operator-24.10.0-beta.5"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-config-daemon:network-operator-24.10.0-beta.3"`
-
* - sriov-network-operator.images.sriovDevicePlugin
- string
- `"ghcr.io/k8snetworkplumbingwg/sriov-network-device-plugin:v3.7.0"`
-
* - sriov-network-operator.images.webhook
- string
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-webhook:network-operator-24.10.0-beta.5"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-webhook:network-operator-24.10.0-beta.3"`
-
* - sriov-network-operator.operator.admissionControllers
- yaml
Expand Down Expand Up @@ -421,7 +409,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.configDaemon.image.tag
- string
- `"v0.1.5"`
- `"v0.1.1"`
-
* - nic-configuration-operator-chart.operator.image.name
- string
Expand All @@ -433,7 +421,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.operator.image.tag
- string
- `"v0.1.5"`
- `"v0.1.1"`
-

=======================
Expand Down

0 comments on commit dfe718c

Please sign in to comment.