Skip to content
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.

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

chore: Update for v24.10.0-beta.5 #122

Merged
merged 2 commits into from
Nov 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/common/vars.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. |network-operator-version| replace:: v24.10.0-beta.4
.. |helm-chart-version| replace:: 24.10.0-beta.4
.. |network-operator-version| replace:: v24.10.0-beta.5
.. |helm-chart-version| replace:: 24.10.0-beta.5
.. |ocp-channel| replace:: v24.10
.. |mofed-version| replace:: 24.10-0.5.5.0-0
.. |mofed-version| replace:: 24.10-0.6.2.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.4
.. |sriovnetop-version| replace:: network-operator-24.10.0-beta.5
.. |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: 33 additions & 22 deletions docs/customizations/crds.rst
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) |
| bool | |
| ``useCdi`` | Enables use of container device interface (CDI) NOTE: NVIDIA Network Operator does not configure |
| bool | container runtime to enable CDI. |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _DrainSpec:
Expand Down Expand Up @@ -636,35 +636,46 @@ NicClusterPolicySpec defines the desired state of NicClusterPolicy
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===================================================================================================+===================================================================================================+
| ``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 |
| ``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/ |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``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>`__ | |
| ``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 |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``ofedDriver`` | Configuration options for OFED driver |
| :ref:`OFEDDriverSpec <OFEDDriverSpec>` | |
| ``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 |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``rdmaSharedDevicePlugin`` | Configuration options for RDMA shared device plugin |
| :ref:`DevicePluginSpec <DevicePluginSpec>` | |
| ``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 |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``sriovDevicePlugin`` | Configuration options for SRIOV 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 |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``ibKubernetes`` | Configuration options for ib-kubernetes |
| :ref:`IBKubernetesSpec <IBKubernetesSpec>` | |
| ``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 |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``secondaryNetwork`` | Configuration options for secondary network |
| :ref:`SecondaryNetworkSpec <SecondaryNetworkSpec>` | |
| ``nicFeatureDiscovery`` | NicFeatureDiscovery works with NodeFeatureDiscovery to expose information about NVIDIA NICs. |
| :ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>` | https://github.com/Mellanox/nic-feature-discovery |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nvIpam`` | Configuration options for nv-ipam |
| :ref:`NVIPAMSpec <NVIPAMSpec>` | |
| ``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 |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nicFeatureDiscovery`` | Configuration options for nic-feature-discovery |
| :ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>` | |
| ``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>`__ | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``docaTelemetryService`` | Configuration options for DOCA Telemetry Service |
| :ref:`DOCATelemetryServiceSpec <DOCATelemetryServiceSpec>` | |
| ``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>`__ | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _NicClusterPolicyStatus:
Expand Down
10 changes: 5 additions & 5 deletions docs/customizations/helm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,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.4"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator:network-operator-24.10.0-beta.5"`
-
* - sriov-network-operator.images.ovsCni
- string
Expand All @@ -305,15 +305,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.4"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-config-daemon:network-operator-24.10.0-beta.5"`
-
* - 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.4"`
- `"nvcr.io/nvstaging/mellanox/sriov-network-operator-webhook:network-operator-24.10.0-beta.5"`
-
* - sriov-network-operator.operator.admissionControllers
- yaml
Expand Down Expand Up @@ -421,7 +421,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.configDaemon.image.tag
- string
- `"v0.1.4"`
- `"v0.1.5"`
-
* - nic-configuration-operator-chart.operator.image.name
- string
Expand All @@ -433,7 +433,7 @@ NIC Configuration Operator Helm chart customization options can be found `here <
-
* - nic-configuration-operator-chart.operator.image.tag
- string
- `"v0.1.4"`
- `"v0.1.5"`
-

=======================
Expand Down
9 changes: 9 additions & 0 deletions hack/ref_links.lua
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ function Link(el)
if href:match("^https://godoc") then
return el -- Do nothing, return the original link
end
if href:match("^https://network.nvidia.com") then
return el -- Do nothing, return the original link
end
if href:match("^https://github.com") then
return el -- Do nothing, return the original link
end
if href:match("^https://docs.nvidia.com") then
return el -- Do nothing, return the original link
end
-- Check if the link is "#mellanox.com%2fv1alpha1"
if href:match("mellanox%.com%%2fv*") then
-- Update the href to be the correct path
Expand Down