From 67b23d1f3c7fde475b307d4393313f320924fe6a Mon Sep 17 00:00:00 2001 From: Fred Rolland Date: Sun, 3 Nov 2024 14:22:21 +0200 Subject: [PATCH 1/2] chore: fix lua link hack Signed-off-by: Fred Rolland --- hack/ref_links.lua | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/hack/ref_links.lua b/hack/ref_links.lua index 57390a7..083bb0c 100644 --- a/hack/ref_links.lua +++ b/hack/ref_links.lua @@ -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 From b11b276f7cf6cf2a9bbfce1859f62b1ea49ab85e Mon Sep 17 00:00:00 2001 From: Fred Rolland Date: Sun, 3 Nov 2024 14:23:29 +0200 Subject: [PATCH 2/2] chore: update for v24.10.0-beta.5 Signed-off-by: Fred Rolland --- docs/common/vars.rst | 8 +++--- docs/customizations/crds.rst | 55 +++++++++++++++++++++--------------- docs/customizations/helm.rst | 10 +++---- 3 files changed, 42 insertions(+), 31 deletions(-) diff --git a/docs/common/vars.rst b/docs/common/vars.rst index aa22d7b..edff952 100644 --- a/docs/common/vars.rst +++ b/docs/common/vars.rst @@ -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 @@ -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 diff --git a/docs/customizations/crds.rst b/docs/customizations/crds.rst index 3d3fd85..e5e9564 100644 --- a/docs/customizations/crds.rst +++ b/docs/customizations/crds.rst @@ -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 ` | | +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ - | ``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: @@ -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 `__ | operator | + | ``ofedDriver`` | OFEDDriver is a specialized driver for NVIDIA NICs which can replace the inbox driver that comes | + | :ref:`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 `__ | | + | ``rdmaSharedDevicePlugin`` | RdmaSharedDevicePlugin manages support IB and RoCE HCAs through the Kubernetes device plugin | + | :ref:`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 ` | | + | ``sriovDevicePlugin`` | SriovDevicePlugin manages SRIOV through the Kubernetes device plugin framework. The config field | + | :ref:`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 ` | | + | ``ibKubernetes`` | IBKubernetes provides a daemon that works in conjunction with the SR-IOV Network Device Plugin. | + | :ref:`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 ` | | + | ``secondaryNetwork`` | SecondaryNetwork Specifies components to deploy in order to facilitate a secondary network in | + | :ref:`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 ` | | + | ``nvIpam`` | NvIpam is an IPAM provider that dynamically assigns IP addresses with speed and performance in | + | :ref:`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 ` | | + | ``nicFeatureDiscovery`` | NicFeatureDiscovery works with NodeFeatureDiscovery to expose information about NVIDIA NICs. | + | :ref:`NICFeatureDiscoverySpec ` | https://github.com/Mellanox/nic-feature-discovery | +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ - | ``nvIpam`` | Configuration options for nv-ipam | - | :ref:`NVIPAMSpec ` | | + | ``docaTelemetryService`` | DOCATelemetryService exposes telemetry from NVIDIA networking components to prometheus. See: | + | :ref:`DOCATelemetryServiceSpec ` | https://docs.nvidia.com/doca/sdk/nvidia+doca+telemetry+service+guide/index.html | +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ - | ``nicFeatureDiscovery`` | Configuration options for nic-feature-discovery | - | :ref:`NICFeatureDiscoverySpec ` | | + | ``nodeAffinity`` | NodeAffinity rules to inject to the DaemonSets objects that are managed by the operator | + | `Kubernetes core/v1.NodeAffinity `__ | | +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ - | ``docaTelemetryService`` | Configuration options for DOCA Telemetry Service | - | :ref:`DOCATelemetryServiceSpec ` | | + | ``tolerations`` | Tolerations to inject to the DaemonSets objects that are managed by the operator | + | `[]Kubernetes core/v1.Toleration `__ | | +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ .. _NicClusterPolicyStatus: diff --git a/docs/customizations/helm.rst b/docs/customizations/helm.rst index 3fecdc9..dbf832e 100644 --- a/docs/customizations/helm.rst +++ b/docs/customizations/helm.rst @@ -289,7 +289,7 @@ SR-IOV Network Operator Helm chart customization options can be found `here