README
¶
DOCA Platform Framework (DPF)
Overview
DOCA Platform Framework (DPF) is a system that provisions and orchestrates NVIDIA BlueField DPUs in cloud environments.
Key Features
- Kubernetes Integration: Streamlines DPU provisioning and management via Kubernetes APIs.
- DPU Service Orchestration: Enables efficient deployment and orchestration of services on DPUs.
- Cluster Management: Simplifies the management of DPUs within Kubernetes clusters.
Hardware support
DPF supports dual port NVIDIA BlueField-3 DPUs.
BlueField DPUs are installed as PCI devices in servers to manage various types of network traffic, such as data center communication and storage traffic, through dedicated ports. They feature arm64 CPUs running Linux OS and NVIDIA DOCA Software components.
Refer to Prerequisites for detailed hardware requirements:
Documentation
-
System overview: High-level description of DPF components and functionality.
-
System architecture: Detailed explanation of DPF components and their interactions.
-
User guide: Guides on installing and utilizing DPF effectively for specific use-cases.
-
Release notes: Features and known issues for specific DPF versions.
API reference
Comprehensive DPF API documentation is available here.
Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
dpuservice/v1alpha1
Package v1alpha1 contains API Schema definitions for the svc.dpf v1alpha1 API group +kubebuilder:object:generate=true +groupName=svc.dpu.nvidia.com
|
Package v1alpha1 contains API Schema definitions for the svc.dpf v1alpha1 API group +kubebuilder:object:generate=true +groupName=svc.dpu.nvidia.com |
|
noderesources/v1alpha1
Package v1alpha1 contains API Schema definitions for the noderesources v1alpha1 API group +kubebuilder:object:generate=true +groupName=noderesources.dpu.nvidia.com
|
Package v1alpha1 contains API Schema definitions for the noderesources v1alpha1 API group +kubebuilder:object:generate=true +groupName=noderesources.dpu.nvidia.com |
|
operator/v1alpha1
Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.dpu.nvidia.com
|
Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group +kubebuilder:object:generate=true +groupName=operator.dpu.nvidia.com |
|
provisioning/v1alpha1
Package v1alpha1 contains API Schema definitions for the provisioning.dpu v1alpha1 API group +kubebuilder:object:generate=true +groupName=provisioning.dpu.nvidia.com
|
Package v1alpha1 contains API Schema definitions for the provisioning.dpu v1alpha1 API group +kubebuilder:object:generate=true +groupName=provisioning.dpu.nvidia.com |
|
storage/v1alpha1
Package v1alpha1 contains API Schema definitions for the storage v1alpha1 API group +kubebuilder:object:generate=true +groupName=storage.dpu.nvidia.com
|
Package v1alpha1 contains API Schema definitions for the storage v1alpha1 API group +kubebuilder:object:generate=true +groupName=storage.dpu.nvidia.com |
|
vpc/v1alpha1
Package v1alpha1 contains API Schema definitions for the storage v1alpha1 API group +kubebuilder:object:generate=true +groupName=vpc.dpu.nvidia.com
|
Package v1alpha1 contains API Schema definitions for the storage v1alpha1 API group +kubebuilder:object:generate=true +groupName=vpc.dpu.nvidia.com |
|
cmd
|
|
|
cniinstaller
command
|
|
|
dpf-kms-plugin
command
|
|
|
dpf-ovs-cni
command
|
|
|
dpfctl
command
|
|
|
dpu-hw-agent
command
Command dpu-hw-agent is the agent-side SPIRE NodeAttestor plugin for DPU node attestation.
|
Command dpu-hw-agent is the agent-side SPIRE NodeAttestor plugin for DPU node attestation. |
|
dpu-hw-server
command
Command dpu-hw-server is the server-side SPIRE NodeAttestor plugin for DPU node attestation.
|
Command dpu-hw-server is the server-side SPIRE NodeAttestor plugin for DPU node attestation. |
|
dpuagent
command
|
|
|
dpudetector
command
|
|
|
dpuservice
command
|
|
|
dummydpuservice
command
|
|
|
hostagent
command
|
|
|
ipallocator
command
|
|
|
kamaji-cluster-manager
command
|
|
|
nodesriovdeviceplugin/controller
command
|
|
|
operator
command
|
|
|
provisioning
command
|
|
|
provisioning/certreloader
command
Command certreloader watches the bfb-registry server-certificate directory and triggers an nginx graceful reload (SIGHUP via `nginx -s reload`) whenever the mounted certificate changes.
|
Command certreloader watches the bfb-registry server-certificate directory and triggers an nginx graceful reload (SIGHUP via `nginx -s reload`) whenever the mounted certificate changes. |
|
provisioning/pldmunpackserver
command
|
|
|
servicechainset
command
|
|
|
sfc-controller
command
|
|
|
static-cluster-manager
command
|
|
|
storage/snap-csi-plugin
command
|
|
|
storage/snap-host-controller
command
|
|
|
storage/snap-node-driver
command
|
|
|
hack
|
|
|
tools/resource-collector
command
|
|
|
tools/dpfdev
module
|
|
|
internal
|
|
|
cni/dpf-ovs-cni/pkg/ipam/mock
Package mock_ipam is a generated GoMock package.
|
Package mock_ipam is a generated GoMock package. |
|
cni/dpf-ovs-cni/pkg/ovsdb/mock
Package mock_ovsdb is a generated GoMock package.
|
Package mock_ovsdb is a generated GoMock package. |
|
dpfctl/bmcdump
Package bmcdump collects BlueField BMC diagnostic dumps for DPUDevices.
|
Package bmcdump collects BlueField BMC diagnostic dumps for DPUDevices. |
|
dpfctl/util
Package util contains shared dpfctl helpers.
|
Package util contains shared dpfctl helpers. |
|
features
Package features defines DPF-wide feature gates.
|
Package features defines DPF-wide feature gates. |
|
kmsplugin/config
Package config parses the plugin configuration from command-line flags.
|
Package config parses the plugin configuration from command-line flags. |
|
kmsplugin/server
Package server implements the Kubernetes KMS v2 gRPC service on top of a pluggable encryption Backend.
|
Package server implements the Kubernetes KMS v2 gRPC service on top of a pluggable encryption Backend. |
|
kmsplugin/vault
Package vault implements the Vault Transit backend used by the KMS plugin.
|
Package vault implements the Vault Transit backend used by the KMS plugin. |
|
provisioning/controllers/dpu/state/redfish/diag
Package diag translates Redfish task / SEL telemetry into operator-actionable hints.
|
Package diag translates Redfish task / SEL telemetry into operator-actionable hints. |
|
provisioning/dpuagent/spiffe
Package spiffe implements the DPU Agent SPIFFE heartbeat writer.
|
Package spiffe implements the DPU Agent SPIFFE heartbeat writer. |
|
provisioning/dpuflavortemplate
Package dpuflavortemplate renders a DPUFlavorTemplate body into a concrete DPUFlavor using per-device values from DPUDevice.spec.values.
|
Package dpuflavortemplate renders a DPUFlavorTemplate body into a concrete DPUFlavor using per-device values from DPUDevice.spec.values. |
|
provisioning/utils/nvconfig
Package nvconfig holds NVConfig parameter parsing shared by the provisioning controllers and the DPU agent.
|
Package nvconfig holds NVConfig parameter parsing shared by the provisioning controllers and the DPU agent. |
|
spire
Package spire holds the SPIFFE/SPIRE identifier builders shared across the DPF provisioning controllers.
|
Package spire holds the SPIFFE/SPIRE identifier builders shared across the DPF provisioning controllers. |
|
spire/attestor
Package attestor enables the SPIRE Kubernetes workload attestor on a DPU.
|
Package attestor enables the SPIRE Kubernetes workload attestor on a DPU. |
|
spire/dpu_hw/agent
Package agent implements the agent half of the dpu_hw SPIRE NodeAttestor.
|
Package agent implements the agent half of the dpu_hw SPIRE NodeAttestor. |
|
spire/dpu_hw/server
Package server implements the server half of the dpu_hw SPIRE NodeAttestor.
|
Package server implements the server half of the dpu_hw SPIRE NodeAttestor. |
|
spire/identity
Package identity normalizes DPU hardware serials and builds agent SPIFFE IDs.
|
Package identity normalizes DPU hardware serials and builds agent SPIFFE IDs. |
|
storage/snap/csi-plugin/utils/mount/mock
Package mock_mount is a generated GoMock package.
|
Package mock_mount is a generated GoMock package. |
|
storage/snap/csi-plugin/utils/nvme/mock
Package mock_nvme is a generated GoMock package.
|
Package mock_nvme is a generated GoMock package. |
|
storage/snap/csi-plugin/utils/pci/mock
Package mock_pci is a generated GoMock package.
|
Package mock_pci is a generated GoMock package. |
|
storage/snap/node-driver/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
pkg
|
|
|
dpuheartbeat
Package dpuheartbeat provides the canonical freshness check for the DPU Agent's SPIFFE heartbeat.
|
Package dpuheartbeat provides the canonical freshness check for the DPU Agent's SPIFFE heartbeat. |
|
ecpf/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
openflow
Package openflow is a generated GoMock package.
|
Package openflow is a generated GoMock package. |
|
ovsutils
Package ovsutils is a generated GoMock package.
|
Package ovsutils is a generated GoMock package. |
|
utils/networkhelper/mock
Package mock_networkhelper is a generated GoMock package.
|
Package mock_networkhelper is a generated GoMock package. |
|
test
|
|
|
apivalidation
apivalidation package is used to test the API validations of DPF
|
apivalidation package is used to test the API validations of DPF |
|
mock/dms
command
|
|
|
mock/dms/pkg/certs
Package certs implements utilities for managing certificates for the mock DMS server.
|
Package certs implements utilities for managing certificates for the mock DMS server. |
|
mock/fake-fs-storage-vendor-dpu-plugin
command
Binary fake-fs-storage-vendor-dpu-plugin is a test-only stand-in for fs-storage-vendor-dpu-plugin, the vendor plugin that runs on the DPU and turns a DPUVolume into a filesystem device SNAP can emulate.
|
Binary fake-fs-storage-vendor-dpu-plugin is a test-only stand-in for fs-storage-vendor-dpu-plugin, the vendor plugin that runs on the DPU and turns a DPUVolume into a filesystem device SNAP can emulate. |
|
mock/md5sum
command
|
|
|
utils/snap
Package snap holds the assertions the SNAP storage tests make: on the DPF storage objects the stack produces (DPUStorageVendor through DPUVolumeAttachment) and on the VirtioFS mount the workload ends up with.
|
Package snap holds the assertions the SNAP storage tests make: on the DPF storage objects the stack produces (DPUStorageVendor through DPUVolumeAttachment) and on the VirtioFS mount the workload ends up with. |
|
third_party
|
|
|
forked/argoproj/argo-cd/pkg/apis/application/v1alpha1
Package v1alpha1 contains code that was copied from the upstream ArgoCD types.
|
Package v1alpha1 contains code that was copied from the upstream ArgoCD types. |
|
forked/github.com/clastix/kamaji/api/v1alpha1
Package v1alpha1 contains API Schema definitions for the kamaji v1alpha1 API group +kubebuilder:object:generate=true +groupName=kamaji.clastix.io
|
Package v1alpha1 contains API Schema definitions for the kamaji v1alpha1 API group +kubebuilder:object:generate=true +groupName=kamaji.clastix.io |
|
forked/github.com/spiffe/spire-controller-manager/api/v1alpha1
Package v1alpha1 contains API Schema definitions for the spire v1alpha1 API group +kubebuilder:object:generate=true +groupName=spire.spiffe.io
|
Package v1alpha1 contains API Schema definitions for the spire v1alpha1 API group +kubebuilder:object:generate=true +groupName=spire.spiffe.io |
|
forked/nvidia-external-attacher/api/storage/v1alpha1
+k8s:deepcopy-gen=package
|
+k8s:deepcopy-gen=package |
|
forked/nvidia-external-attacher/client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
forked/nvidia-external-attacher/client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
forked/nvidia-external-attacher/client/clientset/versioned/typed/storage/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
forked/nvidia-external-attacher/client/clientset/versioned/typed/storage/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
Click to show internal directories.
Click to hide internal directories.