Network Operator API reference v1alpha1
Packages:
configuration.net.nvidia.com/v1alpha1
Package v1alpha1 contains API Schema definitions for the configuration.net v1alpha1 API group
Resource Types:
ConfigurationTemplateSpec
(Appears on: NicConfigurationTemplateSpec, NicDeviceConfigurationSpec)
ConfigurationTemplateSpec is a set of configurations for the NICs
Field |
Description |
---|---|
|
Number of VFs to be configured |
|
LinkType to be configured, Ethernet|Infiniband |
|
PCI performance optimization settings |
|
RoCE optimization settings |
|
GPU Direct optimization settings |
FirmwareTemplateSpec
(Appears on: NicDeviceSpec, NicFirmwareTemplateSpec)
FirmwareTemplateSpec specifies a FW update policy for a given FW source ref
Field |
Description |
---|---|
|
NicFirmwareSourceRef refers to existing NicFirmwareSource CR on where to get the FW from |
|
UpdatePolicy indicates whether the operator needs to validate installed FW or upgrade it |
GpuDirectOptimizedSpec
(Appears on: ConfigurationTemplateSpec)
GpuDirectOptimizedSpec specifies GPU Direct optimization settings
Field |
Description |
---|---|
|
Optimize GPU Direct |
|
GPU direct environment, e.g. Baremetal |
LinkTypeEnum (string
alias)
(Appears on: ConfigurationTemplateSpec)
LinkTypeEnum described the link type (Ethernet / Infiniband)
NicConfigurationTemplate
NicConfigurationTemplate is the Schema for the nicconfigurationtemplates API
Field |
Description |
---|---|
|
Refer to the Kubernetes API documentation for the fields of the |
Defines the desired state of NICs |
|
|
Defines the observed state of NicConfigurationTemplate |
NicConfigurationTemplateSpec
(Appears on: NicConfigurationTemplate)
NicConfigurationTemplateSpec defines the desired state of NicConfigurationTemplate
Field |
Description |
---|---|
|
NodeSelector contains labels required on the node. When empty, the template will be applied to matching devices on all nodes. |
|
NIC selector configuration |
|
(Optional) ResetToDefault specifies whether node agent needs to perform a reset flow The following operations will be performed: * Nvconfig reset of all non-volatile configurations - Mstconfig -d reset for each PF - Mstconfig -d set ADVANCED_PCI_SETTINGS=1 * Node reboot - Applies new NIC NV config - Will undo any runtime configuration previously performed for the device/driver |
|
Configuration template to be applied to matching devices |
NicDevice
NicDevice is the Schema for the nicdevices API
Field |
Description |
---|---|
|
Refer to the Kubernetes API documentation for the fields of the |
|
|
|
NicDeviceConfigurationSpec
(Appears on: NicDeviceSpec)
NicDeviceConfigurationSpec contains desired configuration of the NIC
Field |
Description |
---|---|
|
ResetToDefault specifies whether node agent needs to perform a reset flow. In NIC Configuration Operator template v0.1.14 BF2/BF3 DPUs (not SuperNics) FW reset flow isn’t supported. The following operations will be performed: * Nvconfig reset of all non-volatile configurations - Mstconfig -d reset for each PF - Mstconfig -d set ADVANCED_PCI_SETTINGS=1 * Node reboot - Applies new NIC NV config - Will undo any runtime configuration previously performed for the device/driver |
|
Configuration template applied from the NicConfigurationTemplate CR |
NicDevicePortSpec
(Appears on: NicDeviceStatus)
NicDevicePortSpec describes the ports of the NIC
Field |
Description |
---|---|
|
PCI is a PCI address of the port, e.g. 0000:3b:00.0 |
|
NetworkInterface is the name of the network interface for this port, e.g. eth1 |
|
RdmaInterface is the name of the rdma interface for this port, e.g. mlx5_1 |
NicDeviceSpec
(Appears on: NicDevice)
NicDeviceSpec defines the desired state of NicDevice
Field |
Description |
---|---|
|
Configuration specifies the configuration requested by NicConfigurationTemplate |
|
Firmware specifies the fw upgrade policy requested by NicFirmwareTemplate |
NicDeviceStatus
(Appears on: NicDevice)
NicDeviceStatus defines the observed state of NicDevice
Field |
Description |
---|---|
|
Node where the device is located |
|
Type of device, e.g. ConnectX7 |
|
Serial number of the device, e.g. MT2116X09299 |
|
Part number of the device, e.g. MCX713106AEHEA_QP1 |
|
Product Serial ID of the device, e.g. MT_0000000221 |
|
Firmware version currently installed on the device, e.g. 22.31.1014 |
|
List of ports for the device |
|
List of conditions observed for the device |
NicFirmwareSource
NicFirmwareSource is the Schema for the nicfirmwaresources API
Field |
Description |
---|---|
|
Refer to the Kubernetes API documentation for the fields of the |
|
NicFirmwareSourceSpec
(Appears on: NicFirmwareSource)
NicFirmwareSourceSpec represents a list of url sources for FW
Field |
Description |
---|---|
|
(Optional) BinUrlSources represents a list of url sources for ConnectX Firmware |
|
(Optional) BFBUrlSource represents a url source for BlueField Bundle |
NicFirmwareSourceStatus
(Appears on: NicFirmwareSource)
NicFirmwareSourceStatus represents the status of the FW from given sources, e.g. version available for PSIDs
Field |
Description |
---|---|
|
State represents the firmware processing state |
|
Reason shows an error message if occurred |
|
Versions is a map of available FW binaries versions to PSIDs a PSID should have only a single FW version available for it |
|
BFBVersions represents the FW versions available in the provided BFB bundle |
NicFirmwareTemplate
NicFirmwareTemplate is the Schema for the nicfirmwaretemplates API
Field |
Description |
---|---|
|
Refer to the Kubernetes API documentation for the fields of the |
|
NicFirmwareTemplateSpec
(Appears on: NicFirmwareTemplate)
NicFirmwareTemplateSpec defines the FW templates and node/nic selectors for it
Field |
Description |
---|---|
|
NodeSelector contains labels required on the node. When empty, the template will be applied to matching devices on all nodes. |
|
NIC selector configuration |
|
Firmware update template |
NicSelectorSpec
(Appears on: NicConfigurationTemplateSpec, NicFirmwareTemplateSpec)
NicSelectorSpec is a desired configuration for NICs
Field |
Description |
---|---|
|
Type of the NIC to be selected, e.g. 101d,1015,a2d6 etc. |
|
Array of PCI addresses to be selected, e.g. “0000:03:00.0” |
|
Serial numbers of the NICs to be selected, e.g. MT2116X09299 |
NicTemplateStatus
(Appears on: NicConfigurationTemplate, NicFirmwareTemplate)
NicTemplateStatus defines the observed state of NicConfigurationTemplate and NicFirmwareTemplate
Field |
Description |
---|---|
|
NicDevice CRs matching this configuration / firmware template |
PciPerformanceOptimizedSpec
(Appears on: ConfigurationTemplateSpec)
PciPerformanceOptimizedSpec specifies PCI performance optimization settings
Field |
Description |
---|---|
|
Specifies whether to enable PCI performance optimization |
|
Specifies the PCIe Max Accumulative Outstanding read bytes |
|
Specifies the size of a single PCI read request in bytes |
QosSpec
(Appears on: RoceOptimizedSpec)
QosSpec specifies Quality of Service settings
Field |
Description |
---|---|
|
Trust mode for QoS settings, e.g. trust-dscp |
|
Priority-based Flow Control configuration, e.g. “0,0,0,1,0,0,0,0” |
RoceOptimizedSpec
(Appears on: ConfigurationTemplateSpec)
RoceOptimizedSpec specifies RoCE optimization settings
Field |
Description |
---|---|
|
Optimize RoCE |
|
Quality of Service settings |