API reference

namestring

Name is the endpoint resource name for the device plugin.
Should contain only alphanumeric characters, underscores and hyphens.
The full extended resource name will be constructed as resource-prefix/name.
Example: pods_vf, ovnk_mgmt_vf

MinLength: 1
Pattern: ^[a-zA-Z0-9_-]+$
Required: {}

resourcePrefixstring

ResourcePrefix is the resource prefix used by the device plugin to prefix the resource name.
If not set, the default resource prefix will be used.

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
Optional: {}

typeDevicePluginResourceType

Type specifies the type of the device plugin resource.

Enum: [vf]
Required: {}

optionsDevicePluginResourceOptions

Options contains additional options for the device plugin resource.

Optional: {}

rangesVFRange array

Ranges specifies the VF ranges on PFs to be included in this resource.

MinItems: 1
Required: {}

isRdmaboolean

IsRdma indicates whether RDMA is enabled for this resource.

Optional: {}

vf

DevicePluginResourceTypeVF represents a Virtual Function resource.

apiVersionstring

noderesources.dpu.nvidia.com/v1alpha1

kindstring

NodeSRIOVDevicePluginConfig

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specNodeSRIOVDevicePluginConfigSpec

statusNodeSRIOVDevicePluginConfigStatus

apiVersionstring

noderesources.dpu.nvidia.com/v1alpha1

kindstring

NodeSRIOVDevicePluginConfigList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsNodeSRIOVDevicePluginConfig array

devicePluginResourcesDevicePluginResource array

DevicePluginResources is the list of device plugin resource configurations.

MinItems: 1
Required: {}

conditionsCondition array

Conditions exposes the current state of the NodeSRIOVDevicePluginConfig.

observedGenerationinteger

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

pfIndexinteger

PFIndex is the index of the Physical Function.

Minimum: 0
Required: {}

startinteger

Start is the starting VF index (inclusive).
If not set, the range starts from VF 0.

Minimum: 0
Optional: {}

endinteger

End is the ending VF index (inclusive).
If not set, the range extends to the last VF on the PF.

Minimum: 0
Optional: {}

disableboolean

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

Optional: {}

portinteger

Port is the port on which the BFB Registry will listen

Optional: {}

disableboolean

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

Optional: {}

replicasinteger

Replicas is the number of replicas for the controller deployment.
This is used for High Availability. Leader election is enabled by default.

1

Maximum: 3
Minimum: 1
Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

installerDefaultOverridesConfiguration

Installer contains the configuration for the CNI-Installer component.
It contains the image for the controller and its resource requirements.

Optional: {}

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

Optional: {}

networkingNetworking

{ controlPlaneMTU:1500 }

Optional: {}

monitoringMonitoringConfiguration

Monitoring is the configuration for monitoring resources.

Optional: {}

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.

Optional: {}

dpuServiceControllerDPUServiceControllerConfiguration

DPUServiceController is the configuration for the DPUServiceController

Optional: {}

provisioningControllerProvisioningControllerConfiguration

ProvisioningController is the configuration for the ProvisioningController

serviceSetControllerServiceSetControllerConfiguration

ServiceSetController is the configuration for the ServiceSetController

Optional: {}

dpuDetectorDPUDetectorConfiguration

DPUDetector is the configuration for the DPUDetector.

Optional: {}

multusMultusConfiguration

Multus is the configuration for Multus

Optional: {}

sriovDevicePluginSRIOVDevicePluginConfiguration

SRIOVDevicePlugin is the configuration for the SRIOVDevicePlugin

Optional: {}

flannelFlannelConfiguration

Flannel is the configuration for Flannel

Optional: {}

ovsCNIOVSCNIConfiguration

OVSCNI is the configuration for OVSCNI

Optional: {}

nvipamNVIPAMConfiguration

NVIPAM is the configuration for NVIPAM

Optional: {}

cniInstallerCNIInstallerConfiguration

CNIInstaller is the configuration for the cni-installer

Optional: {}

sfcControllerSFCControllerConfiguration

SFCController is the configuration for the SFCController

Optional: {}

kamajiClusterManagerKamajiClusterManagerConfiguration

KamajiClusterManager is the configuration for the kamaji-cluster-manager

Optional: {}

staticClusterManagerStaticClusterManagerConfiguration

StaticClusterManager is the configuration for the static-cluster-manager

Optional: {}

nodeSRIOVDevicePluginControllerNodeSRIOVDevicePluginControllerConfiguration

NodeSRIOVDevicePluginController is the configuration for the NodeSRIOVDevicePlugin controller.
This controller manages per-node SRIOV device plugin pods based on DPU configurations.
The controller is disabled by default.

Optional: {}

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.

versionstring

Version is the version of the DPF Operator that is currently deployed.

disableboolean

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

Optional: {}

imageImage

Image overrides the container image used by the DPUDetector Container.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field daemon instead.

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,\}))?$
Optional: {}

daemonDefaultOverridesConfiguration

Daemon contains the configuration for the DPU Detector component.
It contains the image for the controller and its resource requirements.

Optional: {}

disableboolean

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

Optional: {}

replicasinteger

Replicas is the number of replicas for the controller deployment.
This is used for High Availability. Leader election is enabled by default.

1

Maximum: 3
Minimum: 1
Optional: {}

imageImage

Image overrides the container image used by the DPUService controller.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field controller instead.

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,\}))?$
Optional: {}

controllerDefaultOverridesConfiguration

Controller contains the configuration for the DPU Service controller component.
It contains the image for the controller and its resource requirements.

Optional: {}

disableDPUReadyTaintsboolean

DisableDPUReadyTaints disables the DPU ready taints feature in the DPU Service Controller.
This feature adds taints to the worker nodes when the DPU is not ready.
This is useful when the DPU is used for networking and the node should not be scheduled until the DPU is ready.

Optional: {}

imageImage

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,\}))?$
Optional: {}

resourcesResourceRequirements

Resources defines the memory and CPU resource requests and limits for the component.
This field is optional, and if not set, the component will use the default resource.

Optional: {}

imageImage

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,\}))?$
Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

cniFlannelCNI

CNI is the configuration for the Flannel CNI component.
It contains the image for the CNI init container.
Note: The resources for the CNI container are not configurable.

Optional: {}

daemonFlannelDaemon

Daemon is the configuration for the Flannel Daemon component.
It contains the image for the Flannel Daemon container and its resource requirements.

Optional: {}

imageFlannelImages

Images overrides the container images used by flannel
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new fields cni and daemon instead.

Optional: {}

podCIDRstring

PodCIDR is the pod cidr for flannel.

Optional: {}

imageImage

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,\}))?$
Optional: {}

resourcesResourceRequirements

Resources defines the memory and CPU resource requests and limits for the component.
This field is optional, and if not set, the component will use the default resource.

Optional: {}

flannelCNIstring

FlannelCNI must be set if FlannelImages is set.

MinLength: 1
Required: {}

kubeFlannelstring

KubeFlannel must be set if FlannelImages is set.

MinLength: 1
Required: {}

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://).+$
Optional: {}

imageImage

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,\}))?$
Optional: {}

bfbRegistryAddressstring

BFBRegistryAddress is the address of the BFB Registry
Deprecated: Use RegistryConfiguration instead.

MinLength: 1

bfbRegistryBFBRegistryConfiguration

BFBRegistry is the configuration for the BFB Registry
Deprecated: Use RegistryConfiguration instead.

Optional: {}

skipDPUNodeDiscoveryboolean

SkipDPUNodeDiscovery is a flag to skip the DPU node discovery.

true

Optional: {}

disableboolean

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

Optional: {}

replicasinteger

Replicas is the number of replicas for the controller deployment.
This is used for High Availability. Leader election is enabled by default.

2

Maximum: 3
Minimum: 1
Optional: {}

imageImage

Image overrides the container image used by the Kamaji Cluster Manager.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field controller instead.

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,\}))?$
Optional: {}

controllerDefaultOverridesConfiguration

Controller contains the configuration for the Kamaji Cluster Manager component.
It contains the image for the controller and its resource requirements.

Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

daemonDefaultOverridesConfiguration

Daemon contains the configuration for the kube-state-metrics component.
It contains the image for kube-state-metrics and its resource requirements.

Optional: {}

disableboolean

Disable controls whether monitoring resources are installed.
When enabled (default), the controller:
- Creates ServiceMonitors for Kamaji clusters to scrape control-plane metrics.
- Deploys kube-state-metrics as a DPUService to expose metrics for custom resources.
- Deploys node-problem-detector as a DaemonSet on DPU nodes to detect and report node-level problems.
- Deploys opentelemetry-collector as a DaemonSet on DPU nodes to collect and forward logs.

Optional: {}

kubeStateMetricsKubeStateMetricsConfiguration

KubeStateMetrics is the configuration for kube-state-metrics

Optional: {}

nodeProblemDetectorNodeProblemDetectorConfiguration

NodeProblemDetector is the configuration for node-problem-detector

Optional: {}

openTelemetryCollectorOpenTelemetryCollectorConfiguration

OpenTelemetryCollector is the configuration for opentelemetry-collector

Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

imageImage

Image overrides the container image used by the Multus Container.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field cni instead.

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,\}))?$
Optional: {}

cniDefaultOverridesConfiguration

CNI contains the configuration for the Multus CNI component.
It contains the image for the controller and its resource requirements.

Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

imageImage

Image overrides the container image used by the NVIPAM controller.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field controller instead.

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,\}))?$
Optional: {}

controllerNVIPAMController

Controller contains the configuration for the NVIPAM controller component.
It contains the image for the controller and its resource requirements.

Optional: {}

nodeNVIPAMNode

Node contains the configuration for the NVIPAM node component.
It contains the image for the node and its resource requirements.

imageImage

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,\}))?$
Optional: {}

resourcesResourceRequirements

Resources defines the memory and CPU resource requests and limits for the component.
This field is optional, and if not set, the component will use the default resource.

Optional: {}

imageImage

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,\}))?$
Optional: {}

resourcesResourceRequirements

Resources defines the memory and CPU resource requests and limits for the component.
This field is optional, and if not set, the component will use the default resource.

Optional: {}

controlPlaneMTUinteger

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

1500

Maximum: 9216
Minimum: 1280
Optional: {}

highSpeedMTUinteger

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

1500

Maximum: 9216
Minimum: 1280
Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

daemonDefaultOverridesConfiguration

Daemon contains the configuration for the node-problem-detector component.
It contains the image for node-problem-detector and its resource requirements.

Optional: {}

disableboolean

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

Optional: {}

replicasinteger

Replicas is the number of replicas for the controller deployment.
This is used for High Availability. Leader election is enabled by default.

1

Maximum: 3
Minimum: 1
Optional: {}

controllerDefaultOverridesConfiguration

Controller contains the configuration for the NodeSRIOVDevicePlugin controller component.
It contains the image for the controller and its resource requirements.

Optional: {}

devicePluginNodeSRIOVDevicePluginSettings

DevicePlugin contains the configuration for the SRIOV device plugin pods
managed by this controller.

Optional: {}

imageImage

Image overrides the container image for 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,\}))?$
Optional: {}

initImageImage

InitImage overrides the container image for the init container
that generates device plugin configuration.

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,\}))?$
Optional: {}

defaultResourcePrefixstring

DefaultResourcePrefix is the default resource prefix for the SRIOV device plugin resources.
Defaults to "nvidia.com".

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

imageImage

Image overrides the container image used by the OVS CNI.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field cni instead.

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,\}))?$
Optional: {}

cniDefaultOverridesConfiguration

CNI contains the configuration for the OVS CNI component.
It contains the image for the controller and its resource requirements.

Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

daemonDefaultOverridesConfiguration

Daemon contains the configuration for the opentelemetry-collector component.
It contains the image for opentelemetry-collector and its resource requirements.

Optional: {}

loggingOpenTelemetryCollectorLoggingConfiguration

Logging contains the configuration for the opentelemetry-collector logging component.
If not specified, logging will not be streamed.

Optional: {}

endpointstring

Endpoint is the OTLP endpoint where the DPU cluster opentelemetry-collector sends data to.
This could be the management cluster's opentelemetry-collector endpoint.
If not specified, nothing will be forwarded from DPU clusters.

Required: {}

pausedboolean

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

Optional: {}

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.

Optional: {}

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.

Optional: {}

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.

Optional: {}

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.

Optional: {}

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.

Optional: {}

flannelSkipCNIConfigInstallationboolean

FlannelSkipCNIConfigInstallation controls whether Flannel should skip CNI config installation.
This is true by default, meaning Flannel does not manage its own CNI configuration.
Set to false if you want Flannel to install a CNI configuration.

Optional: {}

dpuOpenvSwitchSystemSharedLib64Pathstring

DPUOpenvSwitchSystemSharedLib64Path is the path at which the system lib64 used by OVS components can be found on the DPU.
If this field is not set, no lib64 volume mount will be configured in the SFC Controller component.
This setting does not change where components are installed. Installation location fixed in the BFB.

MinLength: 1
Optional: {}

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.

Optional: {}

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.

Optional: {}

argoCDNamespacestring

ArgoCDNamespace is the namespace where ArgoCD is deployed.
AppProjects and cluster secrets required by DPF will be created in this namespace.
Defaults to the namespace of the DPFOperatorConfig.

MaxLength: 63
MinLength: 1
Optional: {}

disableboolean

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

Optional: {}

replicasinteger

Replicas is the number of replicas for the controller deployment.
This is used for High Availability. Leader election is enabled by default.

2

Maximum: 3
Minimum: 1
Optional: {}

imageImage

Image overrides the container image used by the Provisioning controller.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field controller instead.

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,\}))?$
Optional: {}

controllerDefaultOverridesConfiguration

Controller contains the configuration for the Provisioning controller component.
It contains the image for the controller and its resource requirements.

Optional: {}

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. https://github.com/NVIDIA/doca-platform/blob/release-v24.10/internal/provisioning/controllers/dpu/bfcfg/bf.cfg.template
Note: Replacing the bf.cfg is an advanced use case. The default bf.cfg is designed for most use cases.
Deprecated: BFCFGTemplateConfigMap is deprecated and will be removed in a future release.
Use enableDynamicBFCFGTemplates instead for custom bf.cfg templates.

Optional: {}

enableDynamicBFCFGTemplatesboolean

EnableDynamicBFCFGTemplates enables runtime discovery of bf.cfg templates via ConfigMaps.
When enabled, the provisioning controller discovers ConfigMaps by matching labels for BFB
name/namespace and DPUCluster name/namespace. Mutually exclusive with bfCFGTemplateConfigMap.

Optional: {}

bfbPVCNamestring

BFBPersistentVolumeClaimName is the name of the PersistentVolumeClaim used by dpf-provisioning-controller
If not provided, the controller will use local host storage (hostPath)

Optional: {}

dmsTimeoutinteger

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

Minimum: 1
Optional: {}

customCASecretNamestring

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

Optional: {}

installInterfaceProvisioningInstallInterface

InstallInterface is the interface through which the BFB is installed

Optional: {}

registryRegistryConfiguration

Registry is the configuration for the BFB Registry

Optional: {}

maxDPUParallelInstallationsinteger

MaxDPUParallelInstallations specifies the maximum number of DPUs that can be provisioned concurrently.
A DPU is removed from the concurrent provisioning count as soon as it finishes the "OS Installing" phase and
enters the "Rebooting" phase of its provisioning lifecycle.

50

Minimum: 1
Optional: {}

multiDPUOperationsSyncWaitTimeDuration

MultiDPUOperationsSyncWaitTime is the wait time between DPUs sync operations on the same node.
It would take effect only on DPUNode objects which contain more than one DPU.

30s

Format: duration
Pattern: ^([0-9]+(h\|m\|s\|ms\|us\|µs\|ns))+$
Type: string
Optional: {}

maxUnavailableDPUNodesinteger

MaxUnavailableDPUNodes is the maximum number of DPUNodes that are unavailable during the node effect period.

50

Minimum: 1
Optional: {}

osInstallTimeoutDuration

OSInstallTimeout is the maximum time allowed for OS installation in zero-trust mode.
If the installation exceeds this timeout, the DPU will transition to an error state.

45m

Format: duration
Pattern: ^([0-9]+(h\|m\|s\|ms\|us\|µs\|ns))+$
Type: string
Optional: {}

nodeEffectRemovalTimeoutDuration

NodeEffectRemovalTimeout is the maximum time allowed for the Node Effect Removal phase.
If the DPUNodeMaintenance CR still has requestors after this timeout, the DPU will transition to an error state.
When set to "0s" (the default), the timeout is disabled and no time limit is enforced.

0s

Format: duration
Pattern: ^([0-9]+(h\|m\|s\|ms\|us\|µs\|ns))+$
Type: string
Optional: {}

hostAgentDNSPolicyDNSPolicy

HostAgentDNSPolicy sets the DNS policy for the hostagent pod.
Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'.
Defaults to 'ClusterFirstWithHostNet'.

Enum: [ClusterFirstWithHostNet ClusterFirst Default None]
Optional: {}

installViaGNOIInstallViaGNOI

InstallViaGNOI is the interface used to install the BFB via GNOI
Deprecated: Use InstallViaHostAgent instead.

Optional: {}

installViaHostAgentInstallViaHostAgent

InstallViaHostAgent is the interface used to install the BFB via HostAgent

Optional: {}

installViaRedfishInstallViaRedfish

InstallViaRedfish is the interface used to install the BFB via Redfish

Optional: {}

addressstring

Address is the address used to access the BFB Registry. The address must start with "http://".
By default, the BFB Registry can be accessed via its Service.
For non-kubernetes environments, this must be set due to the lack of kubelet on worker nodes.
For zero-trust environments, this must be set so that the BFB Registry can be accessed from DPU BMC.
Deprecated: Address is deprecated and will be removed in a future release.

Pattern: ^http://
Optional: {}

portinteger

Port is the port on which the registry instances will listen
Deprecated: Address is deprecated and will be removed in a future release.

Maximum: 65535
Minimum: 1
Optional: {}

loadBalancerAddressstring

LoadBalancerAddress is the address of the load balancer for the BFB Registry which the hostagent/redfish use to fetch the BFB and generated bf.cfg.
To enable the load balancer, you need to deploy your own load balancer controller and configure the LoadBalancerAddress field.
Then check the bfb-registry nodeport service and make your load balancer controller to distribute the requests to the bfb-registry nodeport.

Pattern: ^http://
Optional: {}

resourcesResourceRequirements

Resources defines the memory and CPU resource requests and limits for the component.
This field is optional, and if not set, the component will use the default resource.

Optional: {}

requestsResources

Requests defines the resource requests for the component.

limitsResources

Limits defines the resource limits for the component.

cpuQuantity

CPU is the amount of CPU requested by the component.

Optional: {}

memoryQuantity

Memory is the amount of Memory requested by the component.

Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

imageImage

Image overrides the container image used by the SFC controller.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field controller instead.

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,\}))?$
Optional: {}

controllerDefaultOverridesConfiguration

Controller contains the configuration for the SFC controller component.
It contains the image for the controller and its resource requirements.

Optional: {}

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 https://golang.org/pkg/time/#ParseDuration.

Optional: {}

disableboolean

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

Optional: {}

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://).+$
Optional: {}

imageImage

Image overrides the container image used by the SRIOV Device Plugin container.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field deviceplugin instead.

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,\}))?$
Optional: {}

devicepluginDefaultOverridesConfiguration

DevicePlugin contains the configuration for the SRIOV Device Plugin component.
It contains the image for the controller and its resource requirements.

Optional: {}

disableboolean

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

Optional: {}

replicasinteger

Replicas is the number of replicas for the controller deployment.
This is used for High Availability. Leader election is enabled by default.

1

Maximum: 3
Minimum: 1
Optional: {}

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://).+$
Optional: {}

imageImage

Image overrides the container image used by the ServiceChainSet Controller.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field controller instead.

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,\}))?$
Optional: {}

controllerDefaultOverridesConfiguration

Controller contains the configuration for the ServiceChainSet controller component.
It contains the image for the controller and its resource requirements.

Optional: {}

disableboolean

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

Optional: {}

replicasinteger

Replicas is the number of replicas for the controller deployment.
This is used for High Availability. Leader election is enabled by default.

1

Maximum: 3
Minimum: 1
Optional: {}

imageImage

Image overrides the container image used by the Static Cluster Manager.
Deprecated: This field is deprecated and will be removed with v26.7.0.
Use the new field controller instead.

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,\}))?$
Optional: {}

controllerDefaultOverridesConfiguration

Controller contains the configuration for the Static Cluster Manager controller component.
It contains the image for the controller and its resource requirements.

Optional: {}

taintTaint

Add specify taint on the DPU node

Optional: {}

noEffectboolean

Do not do any action on the DPU node

Optional: {}

customLabelobject (keys:string, values:string)

Add specify labels on the DPU node

Optional: {}

drainboolean

Drain the K8s host node by NodeMaintenance operator

Optional: {}

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.
The DPUNode's name will be exported as an environment variable, named as DPUNODE_NAME, to each container and init container in the pod.
The labels and annotations of DPUNode will be exported in /etc/dpu/dpf-pod-info/labels and /etc/dpu/dpf-pod-info/annotations accordingly; the volume name dpf-pod-info is used to mount the labels and annotations.
If any name confliction for env or volume, the controller will not export the name or labels/annotations of DPUNode accordingly.

Optional: {}

holdboolean

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

Optional: {}

forceboolean

Force is the flag to indicate if the node effect should be applied immediately.
If true, dpfOperatorConfig.multiDPUOperationsSyncWaitTime and dpfOperatorConfig.maxUnavailableDPUNodes will be ignored when applying node effect for DPUNodeMaintenance CR

false

Optional: {}

lastStartupTimeTime

LastStartupTime is the time when the DPU was last started

Optional: {}

initialBootIDstring

InitialBootID is the boot ID of the DPU OS during the first boot

rebootMethodRebootMethodType

RebootMethod is the type of reset/reboot set by the DPU agent
See enum values in RebootMethodType.
No default is set intentionally: nil means "check not run or not applicable"
(e.g. legacy flow, or agent has not run the check yet);
a non-nil value means the check ran and this is the result.

Enum: [Unknown NoAction PowerCycle SystemReboot SystemLevelReset FirmwareReset DPUWarmReboot]
Optional: {}

lastObservedPendingNvconfigPendingNVConfigState

LastObservedPendingNVConfig stores the last pending NVConfig parameters seen
during reboot-method discovery on this boot. It is used on the next boot to
ignore repeated parameters that remained unchanged across boots.

Optional: {}

rebootSequenceCountinteger

RebootSequenceCount is the length of the current non-NoAction RebootMethod sequence:
it increments on each agent run that reports a RebootMethod other than NoAction and
resets to 0 when the agent reports NoAction. Used with RebootMethod to bound host reboot loops.

Minimum: 0
Optional: {}

kubeletVersionstring

KubeletVersion represents the kubelet version running on the DPU.

conditionsCondition array

Conditions contains the conditions reported from inside the DPU

Optional: {}

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

BFB

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specBFBSpec

statusBFBStatus

{ phase:Initializing }

Optional: {}

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

MinLength: 1

fileNamestring

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

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

urlstring

The url of the bfb image to download.

Pattern: ^(http\|https)://.+$
Required: {}

versionsBFBVersions

Optionally specify BFB component versions. When set, these versions are
used directly in status instead of being extracted from the BFB file.
If set, all four fields (BSP, DOCA, UEFI, ATF) must be provided.

Optional: {}

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]
Required: {}

versionsBFBVersions

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

Optional: {}

observedGenerationinteger

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

conditionsCondition array

Conditions represent the latest available observations of BFB state

Optional: {}

bspstring

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

Optional: {}

docastring

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

Optional: {}

uefistring

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

Optional: {}

atfstring

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

Optional: {}

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

BlueFieldSoftware

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specBlueFieldSpec

statusBlueFieldSoftwareStatus

{ phase:Initializing }

Optional: {}

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

BlueFieldSoftwareList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsBlueFieldSoftware array

Initializing

BlueFieldSoftware CR is created

Downloading

Downloading BlueFieldSoftware components

Ready

Finished downloading BlueFieldSoftware components, ready for DPU to use

Deleting

Delete BlueFieldSoftware

Error

Error happens during BlueFieldSoftware downloading

phaseBlueFieldSoftwarePhase

The current state of BlueFieldSoftware.

Initializing

Enum: [Initializing Downloading Ready Deleting Error]
Required: {}

versionsBluefieldSoftwareVersions

Versions tracks the versions of the components

Optional: {}

downloadedComponentsDownloadedComponents

DownloadedComponents tracks which components have been successfully downloaded

Optional: {}

observedGenerationinteger

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

conditionsCondition array

Conditions represent the latest available observations of BlueFieldSoftware state

Optional: {}

pldmFwBundlestring

Optional: {}

osIsostring

Optional: {}

tmpFwComponentsTmpFwComponents

Optional: {}

fwBundleVersionstring

osISOVersionstring

tmpFwComponentsVersionsTmpFwComponentsVersions

keepalivedKeepalivedSpec

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

Optional: {}

Pending

Creating

Ready

NotReady

Failed

nodeLabelsobject (keys:string, values:string)

NodeLabels specifies the labels to be added to the node.

Optional: {}

selectorLabelSelector

Selector defines the selector of the DPUClusters the produced DPUs should join

Optional: {}

pathstring

Path is the path of the file to be written.

Optional: {}

operationDPUFlavorFileOp

Operation is the operation to be performed on the file.

Enum: [override append]
Optional: {}

rawstring

Raw is the raw content of the file.

Optional: {}

permissionsstring

Permissions are the permissions to be set on the file.

Optional: {}

registryEndpointstring

RegistryEndpoint is the endpoint of the container registry.

Optional: {}

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 }

Optional: {}

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUCluster

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUClusterSpec

Required: {}

statusDPUClusterStatus

{ phase:Pending }

Optional: {}

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\|[^/]+/.*
Required: {}

maxNodesinteger

MaxNodes is the max amount of node in the cluster

1000

Maximum: 1000
Minimum: 1
Optional: {}

kubeconfigstring

Kubeconfig is the secret that contains the admin kubeconfig

Optional: {}

clusterEndpointClusterEndpointSpec

ClusterEndpoint contains configurations of the cluster entry point

Optional: {}

phaseClusterPhase

Pending

Enum: [Pending Creating Ready NotReady Failed]

versionstring

Version is the K8s control-plane version of the cluster

Optional: {}

nodesCountinteger

NodesCount is the number of DPUs assigned to the cluster

Minimum: 0
Optional: {}

conditionsCondition array

Optional: {}

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUDevice

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUDeviceSpec

statusDPUDeviceStatus

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUDeviceList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUDevice array

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", "MT25066004C7"
Deprecated: This field is deprecated and will be removed in a future version. Use status.psid instead.

Optional: {}

serialNumberstring

SerialNumber is the serial number 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", "MT25066004C7"

MinLength: 1
Required: {}

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"
Deprecated: This field is deprecated and will be removed in a future version. Use status.opn instead.

Optional: {}

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
Optional: {}

bmcPortinteger

BMCPort is the port number 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: 443

443

Minimum: 1
Optional: {}

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
Optional: {}

pf0Namestring

PF0Name is the name of the PF0 on the device.
This value is immutable and should not be changed once set.
Example: "eth0"
Deprecated: This field is deprecated and will be removed in a future version. Use status.pf0Name instead.

Optional: {}

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 discovered and should not be changed once set.
Example: "MT_0001234567", "MT25066004C7"

Optional: {}

serialNumberstring

SerialNumber is the serial number of the device.
It's used to track the device's lifecycle and for inventory management.
This value is discovered and should not be changed once set.
Example: "MT_0001234567", "MT25066004C7"

Optional: {}

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 discovered and should not be changed once set.
Example: "900-9D3B4-00SV-EA0"

Optional: {}

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 discovered and should not be changed once set.
Example: "10.1.2.3"

Format: ipv4
Optional: {}

bmcPortinteger

BMCPort is the port number 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: 443

443

Minimum: 1
Optional: {}

pciAddressstring

PCIAddress is the PCI address of the device in the host system.
Example: "0000-03-00", "03-00"

Optional: {}

pf0Namestring

PF0Name is the name of the PF0 on the device.
Example: "eth0"

Optional: {}

pf0Macstring

PF0MAC is the MAC address of the PF0 on the device.
Example: "00:00:00:00:00:00"

Pattern: ^([0-9A-Fa-f]\{2\}[:-])\{5\}([0-9A-Fa-f]\{2\})$
Optional: {}

dpuTypeDPUType

DPUType is the type of the DPU.

Unknown

Enum: [Unknown BlueField2 BlueField3 BlueField4]
Optional: {}

dpuModeDpuModeType

DPUMode is the mode of the DPU.

dpu

Enum: [dpu nic]
Optional: {}

secureBootSecureBootStatus

SecureBoot indicates the current UEFI Secure Boot state.

Optional: {}

conditionsCondition array

Optional: {}

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUDiscovery

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUDiscoverySpec

statusDPUDiscoveryStatus

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUDiscoveryList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUDiscovery array

ipRangeSpecIPRangeValidationSpec

IPRange defines the range of IP addresses to scan

scanIntervalDuration

ScanInterval defines how often to perform the scan

1h

workersinteger

Workers defines the number of workers to use for the scan (default 1 worker for each 255 IPs in the range)

Optional: {}

lastScanTimeTime

LastScanTime is the timestamp of the last successful scan

foundDPUsinteger

FoundDPUs is the list of discovered DPU BMC IPs

parametersstring array

Parameters are the sysctl parameters to be set.

Optional: {}

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.

Optional: {}

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUFlavorList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUFlavor array

rawConfigScriptstring

RawConfigScript is the raw configuration script for OVS.

Optional: {}

grubDPUFlavorGrub

Grub contains the grub configuration for the DPUFlavor.

Optional: {}

sysctlDPUFLavorSysctl

Sysctl contains the sysctl configuration for the DPUFlavor.

Optional: {}

nvconfigNVConfig array

NVConfig contains the device-specific configuration (firmware settings, device parameters).
Each entry specifies a device (wildcard '', or port identifiers 'p0'/'P0'/'p1'/'P1') and its parameters.
If device is '' or unspecified (defaults to ''), it applies to all devices and must be the only entry.
Each device (including unspecified as '') must be unique across all nvconfig entries (case-insensitive).
Validation enforces: device enum values, parameter format (KEY=VALUE), case-insensitive uniqueness, and size limits.

MaxItems: 3
Optional: {}

ovsDPUFlavorOVS

OVS contains the OVS configuration for the DPUFlavor.

Optional: {}

bfcfgParametersstring array

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

Optional: {}

configFilesConfigFile array

ConfigFiles are the files to be written on the DPU.

Optional: {}

containerdConfigContainerdConfig

ContainerdConfig contains the configuration for containerd.

Optional: {}

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.

Optional: {}

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.

Optional: {}

dpuModeDpuModeType

Specifies the DPU Mode type: one of dpu,zero-trust.
When not specified, defaults to "zero-trust" if the DPF deployment uses Redfish install interface,
otherwise defaults to "dpu".

Enum: [dpu zero-trust nic]
Optional: {}

hostNetworkInterfaceConfigsNetworkInterfaceConfig array

HostNetworkInterfaceConfigs contains the configuration for the host-side network interfaces.

Optional: {}

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

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUNodeMaintenance

metadataObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

specDPUNodeMaintenanceSpec

statusDPUNodeMaintenanceStatus

apiVersionstring

provisioning.dpu.nvidia.com/v1alpha1

kindstring

DPUNodeMaintenanceList

metadataListMeta

Refer to Kubernetes API documentation for fields of metadata.

itemsDPUNodeMaintenance array

dpuNodeNamestring

DPUNodeName is the name of the DPUNode that is being maintained.

Required: {}

nodeEffectNodeEffect

NodeEffect is the effect to be applied to the node.

Optional: {}

requestorstring array

Requestor is the list of consumers for the maintenance.

Optional: {}

conditionsCondition array

Conditions reflect the status of the object

Optional: {}

nodeEffectSyncStartTimeTime

NodeEffectSyncStartTime is the time when the node effect sync started.

Optional: {}

multiDPUOperationsSyncWaitTimeDuration

MultiDPUOperationsSyncWaitTime is the wait time between DPUs on the same node.

Optional: {}

maxUnavailableDPUNodesinteger

MaxUnavailableDPUNodes is the maximum number of DPUNodes that are unavailable during the node effect period.

Minimum: 1
Optional: {}