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 |
|
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
|
|
|
dpfctl
command
|
|
|
dpucniprovisioner
command
|
|
|
dpudetector
command
|
|
|
dpuservice
command
|
|
|
dummydpuservice
command
|
|
|
ipallocator
command
|
|
|
kamaji-cluster-manager
command
|
|
|
operator
command
|
|
|
ovnkubernetesresourceinjector
command
|
|
|
provisioning
command
|
|
|
servicechainset
command
|
|
|
sfc-controller
command
|
|
|
static-cluster-manager
command
|
|
|
storage/snap-controller
command
|
|
|
storage/snap-csi-plugin
command
|
|
|
storage/snap-host-controller
command
|
|
|
storage/snap-node-driver
command
|
|
|
hack
|
|
|
tools/dpfdev
command
|
|
|
tools/resource-collector
command
|
|
|
internal
|
|
|
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. |
|
utils/ovsclient/mock
Package mock_ovsclient is a generated GoMock package.
|
Package mock_ovsclient is a generated GoMock package. |
|
pkg
|
|
|
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
|
|
|
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/md5sum
command
|
|
|
third_party
|
|
|
api/argocd/api/application/v1alpha1
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
|
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. |
|
api/kamaji/api/v1alpha1
Package v1alpha1 contains API Schema definitions for the kamaji v1alpha1 API group +kubebuilder:object:generate=true +groupName=kamaji.clastix.io nolint
|
Package v1alpha1 contains API Schema definitions for the kamaji v1alpha1 API group +kubebuilder:object:generate=true +groupName=kamaji.clastix.io nolint |
|
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.