API reference

disableboolean

Disable ensures the BFB Registry is not deployed when set to true.

portinteger

Port is the port on which the BFB Registry will listen

apiVersionstring

operator.dpu.nvidia.com/v1alpha1

kindstring

DPFOperatorConfig

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPFOperatorConfigSpec

statusDPFOperatorConfigStatus

apiVersionstring

operator.dpu.nvidia.com/v1alpha1

kindstring

DPFOperatorConfigList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPFOperatorConfig array

overridesOverrides

networkingNetworking

{ controlPlaneMTU:1500 }

imagePullSecretsstring array

List of secret names which are used to pull images for DPF system components and DPUServices.
These secrets must be in the same namespace as the DPF Operator Config and should be created before the config is created.
System reconciliation will not proceed until these secrets are available.

dpuServiceControllerDPUServiceControllerConfiguration

DPUServiceController is the configuration for the DPUServiceController

provisioningControllerProvisioningControllerConfiguration

ProvisioningController is the configuration for the ProvisioningController

serviceSetControllerServiceSetControllerConfiguration

ServiceSetController is the configuration for the ServiceSetController

dpuDetectorDPUDetectorConfiguration

DPUDetector is the configuration for the DPUDetector.

multusMultusConfiguration

Multus is the configuration for Multus

sriovDevicePluginSRIOVDevicePluginConfiguration

SRIOVDevicePlugin is the configuration for the SRIOVDevicePlugin

flannelFlannelConfiguration

Flannel is the configuration for Flannel

ovsCNIOVSCNIConfiguration

OVSCNI is the configuration for OVSCNI

nvipamNVIPAMConfiguration

NVIPAM is the configuration for NVIPAM

sfcControllerSFCControllerConfiguration

SFCController is the configuration for the SFCController

kamajiClusterManagerKamajiClusterManagerConfiguration

KamajiClusterManager is the configuration for the kamaji-cluster-manager

staticClusterManagerStaticClusterManagerConfiguration

StaticClusterManager is the configuration for the static-cluster-manager

ovsHelperOVSHelperConfiguration

OVSHelper is the configuration for the OVSHelper

conditionsCondition array

Conditions exposes the current state of the OperatorConfig.

observedGenerationinteger

ObservedGeneration records the Generation observed on the object the last time it was patched.

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the component.

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the DPUService controller

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

disableboolean

Disable ensures the component is not deployed when set to true.

imageFlannelImages

Images overrides the container images used by flannel

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by the Flannel
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

flannelCNIstring

FlannelCNI must be set if FlannelImages is set.

MinLength: 1

kubeFlannelstring

KubeFlannel must be set if FlannelImages is set.

MinLength: 1

bfbRegistryAddressstring

BFBRegistryAddress is the address of the BFB Registry

MinLength: 1

bfbRegistryBFBRegistryConfiguration

BFBRegistry is the configuration for the BFB Registry

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the HostedControlPlaneManager.

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by Multus

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by Multus
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by NVIPAM

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by NVIPAM
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

controlPlaneMTUinteger

ControlPlaneMTU is the MTU value to be set on the management network.
The default is 1500.

1500

Maximum: 9216
Minimum: 1000

highSpeedMTUinteger

HighSpeedMTU is the MTU value to be set on the high-speed interface.
The default is 1500.

1500

Maximum: 9216
Minimum: 1000

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the OVS CNI

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by the OVS CNI
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the OVS Helper

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by the OVS Helper
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

pausedboolean

Paused disables all reconciliation of the DPFOperatorConfig when set to true.

dpuCNIBinPathstring

DPUCNIBinPath is the path at which the CNI binaries will be installed to on the DPU.
This is /opt/cni/bin by default.
This setting does not change where kubelet is configured to use the CNI from.

dpuCNIPathstring

DPUCNIConfigPath is the path to which the CNI config files will be installed on the DPU.
This is /etc/cni/net.d by default.
This setting does not change where kubelet is configured to read the CNI config from.

dpuOpenvSwitchRunPathstring

DPUOpenvSwitchPath is the path at which the openvSwitch run directory can be found on the DPU.
This is /var/run/openvswitch by default.
This setting does not change where components are installed. Installation location fixed in the BFB.

dpuOpenvSwitchBinPathstring

DPUOpenvSwitchBinPath is the path at which the openvSwitch bin directory can be found on the DPU node.
This is /usr/bin/ by default.
This setting does not change where components are installed. Installation location fixed in the BFB.

dpuOpenvSwitchSystemSharedPathstring

DPUOpenvSwitchSystemSharedLibPath is the path at which the system lib used by OVS components can be found on the DPU.
This is /lib by default.
This setting does not change where components are installed. Installation location fixed in the BFB.

kubernetesAPIServerVIPstring

KubernetesAPIServerVIP is the VIP the Kubernetes API server is accessible at.
This setting enables specific underlying components deployed directly or indirectly by the DPF Operator to reach
the Kubernetes API Server when the ClusterIP Kubernetes Service is not functional.
If set, it should be set to an IP to ensure that components work even if DNS is not available in the cluster.

kubernetesAPIServerPortinteger

KubernetesAPIServerPort is the port the Kubernetes API server is accessible at.
This setting is usually used together with the kubernetesAPIServerVIP setting. It enables specific underlying
components deployed directly or indirectly by the DPF Operator to reach the Kubernetes API Server when the
ClusterIP Kubernetes Service is not functional.

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the Provisioning controller

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

bfCFGTemplateConfigMapstring

BFCFGTemplateConfigMap is the name of a configMap containing a template for the BF.cfg file used by the DPU controller.
By default the provisioning controller use a hardcoded BF.cfg e.g.

Note: Replacing the bf.cfg is an advanced use case. The default bf.cfg is designed for most use cases.

bfbPVCNamestring

BFBPersistentVolumeClaimName is the name of the PersistentVolumeClaim used by dpf-provisioning-controller

MinLength: 1

dmsTimeoutinteger

DMSTimeout is the max time in seconds within which a DMS API must respond, 0 is unlimited

Minimum: 1

customCASecretNamestring

CustomCASecretName indicates the name of the Kubernetes secret object
which containing the custom CA certificate

installInterfaceProvisioningInstallInterface

InstallInterface is the interface through which the BFB is installed

installViaGNOIInstallViaGNOI

InstallViaGNOI is the interface used to install the BFB via GNOI

installViaRedfishInstallViaRedfish

InstallViaRedfish is the interface used to install the BFB via Redfish

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the SFC Controller

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by the SFC Controller
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

secureFlowDeletionTimeoutDuration

SecureFlowDeletionTimeout controls the timeout for which the API server is unreachable after which all the flows
are deleted to prevent unintended packet leaks. It has effect when is greater than zero.
Value must be in units accepted by Go time.ParseDuration

.

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the SRIOV Device Plugin

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by the SRIOV Device Plugin
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image overrides the container image used by the ServiceSetController

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

deployInTargetClusterboolean

DeployInCluster deploys the component in the same cluster as the DPF Operator if set to true.

helmChartHelmChart

HelmChart overrides the helm chart used by the ServiceSet controller.
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

disableboolean

Disable ensures the component is not deployed when set to true.

imageImage

Image is the container image used by the StaticControlPlaneManager
Image overrides the container image used by the HostedControlPlaneManager.

Pattern: ^((?:(?:(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])(?:\.(?:[a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]))*\|\[(?:[a-fA-F0-9:]+)\])(?::[0-9]+)?/)?[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*(?:/[a-z0-9]+(?:(?:[._]\|__\|[-]+)[a-z0-9]+)*)*)(?::([\w][\w.-]\{0,127\}))?(?:@([A-Za-z][A-Za-z0-9]*(?:[-_+.][A-Za-z][A-Za-z0-9]*)*[:][[:xdigit:]]\{32,\}))?$

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

BFB

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specBFBSpec

statusBFBStatus

{ phase:Initializing }

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

BFBList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsBFB array

Initializing

BFB CR is created

Downloading

Downloading BFB file

Ready

Finished downloading BFB file, ready for DPU to use

Deleting

Delete BFB

Error

Error happens during BFB downloading

namestring

Specifies name of the bfb CR to use for this DPU

fileNamestring

Specifies the file name where the BFB is downloaded on the volume.

Pattern: ^[A-Za-z0-9\_\-\.]+\.bfb$

urlstring

The url of the bfb image to download.

Pattern: ^(http\|https)://.+\.bfb$

fileNamestring

Filename is the name of the file where the BFB can be accessed on its volume.
This is the same as .spec.Filename if set.

phaseBFBPhase

The current state of BFB.

Initializing

Enum: [Initializing Downloading Ready Deleting Error]

versionsBFBVersions

BFB versions - BSP, DOCA, UEFI and ATF
Holds detailed version information for each component within the BFB

bspstring

BSP (Board Support Package) version.
This field stores the version of the BSP, which provides essential
support and drivers for the hardware platform.

docastring

DOCA version
Specifies the version of NVIDIA's Data Center-on-a-Chip Architecture (DOCA),
a platform for developing applications on DPUs

uefistring

UEFI (Unified Extensible Firmware Interface) version.
Indicates the UEFI firmware version, which is responsible for booting
the operating system and initializing hardware components

atfstring

ATF (Arm Trusted Firmware) version.
Contains the version of ATF, which provides a secure runtime environment

keepalivedKeepalivedSpec

Keepalived configures the keepalived that will be deployed for the cluster control-plane

Pending

Creating

Ready

NotReady

Failed

nodeLabelsobject (keys:string, values:string)

NodeLabels specifies the labels to be added to the node.

pathstring

Path is the path of the file to be written.

operationDPUFlavorFileOp

Operation is the operation to be performed on the file.

Enum: [override append]

rawstring

Raw is the raw content of the file.

permissionsstring

Permissions are the permissions to be set on the file.

registryEndpointstring

RegistryEndpoint is the endpoint of the container registry.

ipstring

IP address in IPv4 format.

Format: ipv4

portinteger

Port number.

Minimum: 1

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPU

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUSpec

statusDPUStatus

{ phase:Initializing }

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUCluster

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUClusterSpec

statusDPUClusterStatus

{ phase:Pending }

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUClusterList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUCluster array

typestring

Type of the cluster with few supported values
static - existing cluster that is deployed by user. For DPUCluster of this type, the kubeconfig field must be set.
kamaji - DPF managed cluster. The kamaji-cluster-manager will create a DPU cluster on behalf of this CR.
$(others) - any string defined by ISVs, such type names must start with a prefix.

Pattern: kamaji\|static\|[^/]+/.*

maxNodesinteger

MaxNodes is the max amount of node in the cluster

1000

Maximum: 1000
Minimum: 1

versionstring

Version is the K8s control-plane version of the cluster

kubeconfigstring

Kubeconfig is the secret that contains the admin kubeconfig

clusterEndpointClusterEndpointSpec

ClusterEndpoint contains configurations of the cluster entry point

phaseClusterPhase

Pending

Enum: [Pending Creating Ready NotReady Failed]

conditionsCondition array

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUDevice

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUDeviceSpec

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUDeviceList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUDevice array

pciAddressstring

PCIAddress is the PCI address of the device in the host system.
It's used to identify the device and should be unique.
This value is immutable and should not be changed once set.
Example: "0000-03-00", "03-00"

Pattern: ^([0-9a-fA-F]\{4\}[-])?[0-9a-fA-F]\{2\}[-][0-9a-fA-F]\{2\}$

psidstring

PSID is the Product Serial ID of the device.
It's used to track the device's lifecycle and for inventory management.
This value is immutable and should not be changed once set.
Example: "MT_0001234567"

Pattern: ^MT_\d\{10\}$

opnstring

OPN is the Ordering Part Number of the device.
It's used to track the device's compatibility with different software versions.
This value is immutable and should not be changed once set.
Example: "900-9D3B4-00SV-EA0"

Pattern: ^\d\{3\}-[A-Z0-9]\{5\}-[A-Z0-9]\{4\}-[A-Z0-9]\{3\}$

bmcIpstring

BMCIP is the IP address of the BMC (Base Management Controller) on the device.
This is used for remote management and monitoring of the device.
This value is immutable and should not be changed once set.
Example: "10.1.2.3"

Format: ipv4

numberOfPFsinteger

NumberOfPFs is the number of PFs on the device.
This value is immutable and should not be changed once set.
Example: 1

1

Minimum: 1

pf0Namestring

PF0Name is the name of the PF0 on the device.
This value is immutable and should not be changed once set.
Example: "eth0"

parametersstring array

Parameters are the sysctl parameters to be set.

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUFlavor

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUFlavorSpec

override

append

kernelParametersstring array

KernelParameters are the kernel parameters to be set in the grub configuration.

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUFlavorList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUFlavor array

devicestring

Device is the device to which the configuration applies. If not specified, the configuration applies to all.

parametersstring array

Parameters are the parameters to be set for the device.

hostPowerCycleRequiredboolean

HostPowerCycleRequired indicates if the host needs to be power cycled after applying the configuration.

rawConfigScriptstring

RawConfigScript is the raw configuration script for OVS.

grubDPUFlavorGrub

Grub contains the grub configuration for the DPUFlavor.

sysctlDPUFLavorSysctl

Sysctl contains the sysctl configuration for the DPUFlavor.

nvconfigDPUFlavorNVConfig array

NVConfig contains the configuration for the DPUFlavor.

ovsDPUFlavorOVS

OVS contains the OVS configuration for the DPUFlavor.

bfcfgParametersstring array

BFCfgParameters are the parameters to be set in the bf.cfg file.

configFilesConfigFile array

ConfigFiles are the files to be written on the DPU.

containerdConfigContainerdConfig

ContainerdConfig contains the configuration for containerd.

dpuResourcesResourceList

DPUResources indicates the minimum amount of resources needed for a BFB with that flavor to be installed on a
DPU. Using this field, the controller can understand if that flavor can be installed on a particular DPU. It
should be set to the total amount of resources the system needs + the resources that should be made available for
DPUServices to consume.

systemReservedResourcesResourceList

SystemReservedResources indicates the resources that are consumed by the system (OS, OVS, DPF system etc) and are
not made available for DPUServices to consume. DPUServices can consume the difference between DPUResources and
SystemReservedResources. This field must not be specified if dpuResources are not specified.

dpuModeDpuModeType

Specifies the DPU Mode type: one of dpu,zero-trust,nic

Enum: [dpu zero-trust nic]

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPU array

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUNode

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUNodeSpec

statusDPUNodeStatus

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUNodeList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUNode array

nodeRebootMethodNodeRebootMethod

Defines the method for rebooting the host.
One of the following options can be chosen for this field:
- "external": Reboot the host via an external means, not controlled by the
DPU controller.
- "script": Reboot the host by executing a custom script.
- "gNOI": Use the DPU's DMS interface to reboot the host.
"gNOI" is the default value.

{ gNOI:map[] }

nodeDMSAddressDMSAddress

The IP address and port where the DMS is exposed. Only applicable if dpuInstallInterface is set to gNOI.

dpusDPURef array

A map containing names of each DPUDevice attached to the node.

conditionsCondition array

Conditions represent the latest available observations of an object's state.

Type: array

dpuInstallInterfacestring

The name of the interface which will be used to install the bfb image, can be one of gNOI,redfish

Enum: [gNOI redfish]

kubeNodeRefstring

The name of the Kubernetes Node object that this DPUNode represents.
This field is optional and only relevant if the x86 host is part of the DPF Kubernetes cluster.

Initializing

DPUInitializing is the first phase after the DPU is created.

Node Effect

DPUNodeEffect means the controller will handle the node effect provided by the user.

Pending

DPUPending means the controller is waiting for the BFB to be ready.

Prepare BFB

DPUPrepareBFB means the controller is preparing the BFB and bf.cfg to be installed to DPU

Config FW Parameters

DPUConfigFWParameters means the controller will manipulate DPU firmware, e.g., set DPU mode, check firmware version

Initialize Interface

DPUInitializeInterface means the controller will intitialize the interface used to provision the DPUs, e.g., create the DMS pod, set up RedFish account.

OS Installing

DPUOSInstalling means the controller will provision the DPU through the DMS gNOI interface.

DPU Cluster Config

DPUClusterConfig means the node configuration and Kubernetes Node join procedure are in progress .

Host Network Configuration

DPUHostNetworkConfiguration means the host network configuration is running.

Ready

DPUReady means the DPU is ready to use.

Error

DPUError means error occurred.

Deleting

DPUDeleting means the DPU CR will be deleted, controller will do some cleanup works.

Rebooting

DPURebooting means the host of DPU is rebooting.

Checking Host Reboot Required

DPUCheckingHostRebootNeed means the checking of whether the host required a reboot.

namestring

Name of the DPU device.

MinLength: 1

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUSet

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUSetSpec

statusDPUSetStatus

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUSetList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUSet array

strategyDPUSetStrategy

The rolling update strategy to use to updating existing DPUs with new ones.

dpuNodeSelectorLabelSelector

Select the DPUNodes with specific labels

dpuSelectorobject (keys:string, values:string)

Select the DPU with specific labels

dpuTemplateDPUTemplate

Object that describes the DPU that will be created if insufficient replicas are detected

dpuStatisticsobject (keys:DPUPhase, values:integer)

DPUStatistics is a map of DPUPhase to the number of DPUs in that phase.

typeStrategyType

Can be "OnDelete" or "RollingUpdate".

OnDelete

Enum: [OnDelete RollingUpdate]

rollingUpdateRollingUpdateDPU

Rolling update config params. Present only if StrategyType = RollingUpdate.

dpuNodeNamestring

Specifies the DPUNode this DPU belongs to

dpuDeviceNamestring

Specifies the name of the DPUDevice this DPU is associated with

MinLength: 1

bfbstring

Specifies name of the bfb CR to use for this DPU

pciAddressstring

The PCI device related DPU
Example: "0000-03-00", "03-00"

Pattern: ^([0-9a-fA-F]\{4\}[-])?[0-9a-fA-F]\{2\}[-][0-9a-fA-F]\{2\}$

nodeEffectNodeEffect

Specifies how changes to the DPU should affect the Node

{ drain:true }

clusterK8sCluster

Specifies details on the K8S cluster to join

dpuFlavorstring

DPUFlavor is the name of the DPUFlavor that will be used to deploy the DPU.

bmcIPstring

BMCIP is the ip address of the DPU BMC

phaseDPUPhase

The current state of DPU.

Initializing

Enum: [Initializing Node Effect Pending Config FW Parameters Prepare BFB OS Installing DPU Cluster Config Host Network Configuration Ready Error Deleting Rebooting Initialize Interface Checking Host Reboot Required]

conditionsCondition array

bfbFilestring

BFBFile is the path to the BFB file

bfCFGFilestring

BFCFGFile is the path to the bf.cfg

bfbVersionstring

bfb version of this DPU

pciDevicestring

pci device information of this DPU

requiredResetboolean

whether require reset of DPU

firmwareFirmware

the firmware information of DPU

addressesNodeAddress array

The DPU node's IP addresses

dpuInstallInterfacestring

the name of the interface which will be used to install the bfb image,
and communicate with DPU, can be one of gNOI,redfish

Enum: [gNOI redfish]

annotationsobject (keys:string, values:string)

Annotations specifies annotations which are added to the DPU.

specDPUTemplateSpec

Spec specifies the DPU specification.

bfbBFBReference

Specifies a BFB CR

nodeEffectNodeEffect

Specifies how changes to the DPU should affect the Node

{ drain:true }

clusterClusterSpec

Specifies details on the K8S cluster to join

dpuFlavorstring

DPUFlavor is the name of the DPUFlavor that will be used to deploy the DPU.

dpu

zero-trust

nic

bmcstring

BMC is the used BMC firmware version

nicstring

NIC is the used NIC firmware version

uefistring

UEFI is the used UEFI firmware version

namestring

Name is the name of the DPUs Kubernetes cluster

namespacestring

Namespace is the tenants namespace name where the Kubernetes cluster will be deployed

nodeLabelsobject (keys:string, values:string)

NodeLabels define the labels that will be added to the nodes.

vipstring

VIP is the virtual IP owned by the keepalived instances

virtualRouterIDinteger

VirtualRouterID is the virtual_router_id in keepalived.conf

Maximum: 255
Minimum: 1

interfacestring

Interface specifies on which interface the VIP should be assigned

MinLength: 1

nodeSelectorobject (keys:string, values:string)

NodeSelector is used to specify a subnet of control plane nodes to deploy keepalived instances.
Note: keepalived instances are always deployed on control plane nodes

taintTaint

Add specify taint on the DPU node

noEffectboolean

Do not do any action on the DPU node

customLabelobject (keys:string, values:string)

Add specify labels on the DPU node

drainboolean

Drain the K8s host node by NodeMaintenance operator

customActionstring

Name of a config map which contains a pod yaml definition to run which will apply the nodeEffect.
The pod is expected to exit when node effect is done, if pod terminates with error then DPU would move to an error phase

holdboolean

Places annotation wait-for-external-nodeeffect and waits for it to be removed
this is the default behavior in a non K8S environment

gNOIGNOI

Use the DPU's DMS interface to reboot the host.

externalExternal

Reboot the host via an external means, not controlled by the DPU controller.

scriptScript

Reboot the host by executing a custom script. This field defined which ConfigMap store the custom script.
The ConfigMap should include a pod template of Job object under the pod-template key.
That pod template will be put in a Job object to be executed.

maxUnavailableIntOrString

MaxUnavailable is the maximum number of DPUs that can be unavailable during the update.

namestring

MinLength: 1

OnDelete

New DPU CR will only be created when you manually delete old DPU CR.

RollingUpdate

Gradually scale down the old DPUs and scale up the new one.

nvmeNsIDinteger

The namespace ID within the NVME controller

nvmeUUIDstring

The nvme namespace UUID

csiDriverNamestring

storageClassNamestring

pvcRefObjectRef

requestQuantity

limitQuantity

filesystemTagstring

Filesystem tag identified by SNAP on the host (used for the mount). Relevant for volume of type filesystem

kindstring

apiVersionstring

namestring

namespacestring

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

SVVolumeAttachment

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specVolumeAttachmentSpec

statusVolumeAttachmentStatus

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

SVVolumeAttachmentList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsSVVolumeAttachment array

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

StoragePolicy

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specStoragePolicySpec

statusStoragePolicyStatus

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

StoragePolicyList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsStoragePolicy array

storageVendorsstring array

List of storage vendors

storageParametersobject (keys:string, values:string)

List of storage parameters supported by the policy, values are string only

storageSelectionAlgStorageSelectionAlgType

Algorithm used to select the storage vendor. Default: LocalNVolumes

LocalNVolumes

Enum: [Random LocalNVolumes]

stateStorageVendorState

A storage policy is valid if all provided storage vendors have a StorageVendor object with a valid storage class object

Enum: [Valid Invalid]

messagestring

Informative message when the state is invalid

Random

Random selection across the vendors defined in the StoragePolicy list.

LocalNVolumes

Load-balancing on the number of volumes belonging to the StoragePolicy.
The vendor (in the StoragePolicy list) with the minimal number of volumes should be selected.

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

StorageVendor

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specStorageVendorSpec

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

StorageVendorList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsStorageVendor array

storageClassNamestring

Storage vendor class name, deployed on the DPU K8S cluster.

pluginNamestring

Storage vendor DPU plugin name

Valid

Vaild means all provided storage vendors (storageVendors)
have a StorageVendor object with a valid storage class object

Invalid

Invalid means one or more provided storage vendors (storageVendors) do not
have a StorageVendor object with a valid storage class object

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

Volume

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specVolumeSpec

statusVolumeStatus

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

VolumeAttachment

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specVolumeAttachmentSpec

statusVolumeAttachmentStatus

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

VolumeAttachmentList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsVolumeAttachment array

nodeNamestring

The name of the node that the volume should be attached to

sourceVolumeSource

Reference to the NV-Volume object

volumeAttachmentRefObjectRef

Reference to the SV-VolumeAttachment object

parametersobject (keys:string, values:string)

Opaque static publish properties of the volume returned by the plugin

storageAttachedboolean

Indicates the volume is successfully attached to the target storage system

messagestring

The last error encountered during the attach operation, if any

dpuVolumeAttachmentStatusDPU

Details about the DPU attachment

attachedboolean

Indicates the volume is successfully attached to the DPU node

pciDeviceAddressstring

PCI device address in the following format: (bus:device.function)

deviceNamestring

The name of the device that was created by the storage vendor plugin

bdevAttrsBdevAttrs

The attributes of the underlying block device

fsdevAttrsFSdevAttrs

The attributes of the underlying filesystem device

apiVersionstring

storage.dpu.nvidia.com/v1alpha1

kindstring

VolumeList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsVolume array

capacityRangeCapacityRange

The capacity of the required storage space in bytes

accessModesPersistentVolumeAccessMode array

Contains the types of access modes required

volumeModePersistentVolumeMode

volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.

volumeRefObjectRef

Reference to the NV-Volume object

storageParametersobject (keys:string, values:string)

List of storage parameters supported by the policy, values are string only

requestVolumeRequest

The capacity of the required storage space in bytes

storagePolicyRefObjectRef

Reference to the StoragePolicy object

storagePolicyParametersobject (keys:string, values:string)

List of storage parameters supported by the policy, values are string only

volumeVolumeSpecDPU

Describe volume information in DPU cluster

idstring

capacityQuantity

accessModesPersistentVolumeAccessMode array

reclaimPolicyPersistentVolumeReclaimPolicy

Enum: [Delete Retain]

storageVendorNamestring

storageVendorPluginNamestring

volumeAttributesobject (keys:string, values:string)

csiReferenceCSIReference

InProgress

InProgress means the some of related resource is still in progress

Available

Available means that all related resources are created

stateVolumeState

The state of a Volume object

Enum: [InProgress Available]

repoURLstring

RepoURL specifies the URL to the repository that contains the application Helm chart.
The URL must begin with either 'oci://' or 'https://', ensuring it points to a valid
OCI registry or a web-based repository.

Pattern: ^(oci://\|https://).+$

pathstring

Path is the location of the chart inside the repo.

versionstring

Version is a semver tag for the Chart's version.

MinLength: 1

chartstring

Chart is the name of the helm chart.

releaseNamestring

ReleaseName is the name to give to the release generate from the DPUService.

namestring

Name is a unique identifier for the port within the DPUService.
This name is used for reference inside the service.

MinLength: 1
Pattern: ^[a-z0-9-]+$

portinteger

Port is the port number that will be exposed by the service.
Must be within the valid range of TCP/UDP ports (1-65535).

protocolProtocol

Protocol specifies the transport protocol used by the port.
Supported values: TCP, UDP

Enum: [TCP UDP]

nodePortinteger

NodePort is the external port assigned on each node in the cluster.
If not set, Kubernetes will automatically allocate a NodePort.

Constraints:
- Can only be set when ServiceType is "NodePort".
- Must be within the clusters valid NodePort range (Kubernetes default is 30000-32767).

serviceTypeServiceType

ServiceType specifies the type of Kubernetes Service to create.
All ports within this ConfigPorts will have the same ServiceType.
The value is immutable and cannot be changed after creation.
Supported values:
- "NodePort": Exposes ports externally on a node.
- "ClusterIP": Exposes ports internally within the cluster.
- "None": Internal-only service with no cluster IP.
Default: "NodePort"

NodePort

Enum: [NodePort ClusterIP None]

portsConfigPort array

Ports defines the list of port configurations that will be exposed by the DPUService.
Each port must specify a name, port number, and protocol.

Constraints:
- If ServiceType is "NodePort", ports may optionally specify a NodePort.
- If ServiceType is "None" or "ClusterIP", ports cannot specify a NodePort.

apiVersionstring

svc.dpu.nvidia.com/v1alpha1

kindstring

DPUDeployment

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUDeploymentSpec

statusDPUDeploymentStatus

apiVersionstring

svc.dpu.nvidia.com/v1alpha1

kindstring

DPUDeploymentList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUDeployment array

serviceDPUDeploymentService

Service holds configuration that helps configure the Service Function Chain and identify a port associated with
a DPUService

serviceInterfaceServiceIfc

ServiceInterface holds configuration that helps configure the Service Function Chain and identify a user defined
port

namestring

Name is the name of the service as defined in the DPUDeployment Spec

interfacestring

Interface name is the name of the interface as defined in the DPUServiceTemplate

ipamIPAM

IPAM defines the IPAM configuration that is configured in the Service Function Chain

serviceTemplatestring

ServiceTemplate is the name of the DPUServiceTemplate object to be used for this Service. It must be in the same
namespace as the DPUDeployment.

serviceConfigurationstring

ServiceConfiguration is the name of the DPUServiceConfiguration object to be used for this Service. It must be
in the same namespace as the DPUDeployment.

dpusDPUs

DPUs contains the DPU related configuration

servicesobject (keys:string, values:DPUDeploymentServiceConfiguration)

Services contains the DPUDeploymentService related configuration. The key is the deploymentServiceName and the value is its
configuration. All underlying objects must specify the same deploymentServiceName in order to be able to be consumed by the
DPUDeployment.

serviceChainsServiceChains

ServiceChains contains the configuration related to the DPUServiceChains that the DPUDeployment creates.

revisionHistoryLimitinteger

The maximum number of revisions that can be retained during upgrades.
Defaults to 10.

10

conditionsCondition array

Conditions reflect the status of the object

observedGenerationinteger

ObservedGeneration records the Generation observed on the object the last time it was patched.

portsDPUDeploymentPort array

Ports contains the ports of the switch

MaxItems: 50
MinItems: 1

apiVersionstring

svc.dpu.nvidia.com/v1alpha1

kindstring

DPUService

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUServiceSpec

statusDPUServiceStatus

apiVersionstring

svc.dpu.nvidia.com/v1alpha1

kindstring

DPUServiceChain

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUServiceChainSpec

statusDPUServiceChainStatus

apiVersionstring

svc.dpu.nvidia.com/v1alpha1

kindstring

DPUServiceChainList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUServiceChain array

clusterSelectorLabelSelector

Select the Clusters with specific labels, ServiceChainSet CRs will be created only for these Clusters

templateServiceChainSetSpecTemplate

Template describes the ServiceChainSet that will be created for each selected Cluster.

conditionsCondition array

Conditions reflect the status of the object

observedGenerationinteger

ObservedGeneration records the Generation observed on the object the last time it was patched.

apiVersionstring

svc.dpu.nvidia.com/v1alpha1

kindstring

DPUServiceConfiguration

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUServiceConfigurationSpec