diff --git a/docs/getting-started-kubernetes.rst b/docs/getting-started-kubernetes.rst index 108daae..16f5eb0 100644 --- a/docs/getting-started-kubernetes.rst +++ b/docs/getting-started-kubernetes.rst @@ -535,7 +535,7 @@ The ``host-device-net.yaml`` configuration file for such a deployment: name: hostdev-net spec: networkNamespace: "default" - resourceName: "nvidia.com/hostdev" + resourceName: "hostdev" ipam: | { "type": "whereabouts", @@ -562,7 +562,7 @@ The ``host-device-net-ocp.yaml`` configuration file for such a deployment in the name: hostdev-net spec: networkNamespace: "default" - resourceName: "nvidia.com/hostdev" + resourceName: "hostdev" ipam: | { "type": "whereabouts", @@ -2650,27 +2650,30 @@ Configure and apply the NicConfigurationTemplate CR: .. code-block:: yaml apiVersion: configuration.net.nvidia.com/v1alpha1 - kind: NICConfigurationTemplate + kind: NicConfigurationTemplate metadata: - name: connectx6dx-config - namespace: nvidia-network-operator + name: connectx6-config + namespace: nic-configuration-operator spec: nodeSelector: feature.node.kubernetes.io/network-sriov.capable: "true" nicSelector: - # nicType selector is mandatory, the rest are optional. Only a single type can be specified. - nicType: 1015 - pciAddress: + # nicType selector is mandatory the rest are optional. Only a single type can be specified. + nicType: 101b + pciAddresses: - "0000:03:00.0" - “0000:04:00.0” + serialNumbers: + - "MT2116X09299" resetToDefault: false # if set, template is ignored, device configuration should reset template: + # numVfs and linkType fields are mandatory, the rest are optional numVfs: 2 linkType: Ethernet pciPerformanceOptimized: enabled: true maxAccOutRead: 44 - maxReadRequest: 5 + maxReadRequest: 4096 roceOptimized: enabled: true qos: @@ -2680,11 +2683,15 @@ Configure and apply the NicConfigurationTemplate CR: enabled: true env: Baremetal rawNvConfig: - THIS_IS_A_SPECIAL_NVCONFIG_PARAM: "55" - SOME_ADVANCED_NVCONFIG_PARAM: "true" + - name: THIS_IS_A_SPECIAL_NVCONFIG_PARAM + value: "55" + - name: SOME_ADVANCED_NVCONFIG_PARAM + value: "true" .. note:: It's not possible to apply more than one template to a single device. In this case, no template will be applied and an error event will be emitted for the corresponding NicDevice CR. +.. note:: To use the NIC Configuration Operator functionality together with SR-IOV Network Operator, numVfs and linkType need to match both in NicConfigurationTemplate and SriovNetworkNodePolicy CRs matching the same NICs. + For more information about the CRD API, refer to `API documentation `_. For more information, which FW parameter each settings corresponds to, refer to `Configuration details doc section `_. diff --git a/docs/getting-started-openshift.rst b/docs/getting-started-openshift.rst index 646d19a..18c06dc 100644 --- a/docs/getting-started-openshift.rst +++ b/docs/getting-started-openshift.rst @@ -286,7 +286,7 @@ The `host-device-net.yaml`` configuration file for such a deployment: name: hostdev-net spec: networkNamespace: "default" - resourceName: "nvidia.com/hostdev" + resourceName: "hostdev" ipam: | { "type": "whereabouts",