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 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.
Contributing
This repository follows the following conventions.
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 |
|
cmd
|
|
|
hack
|
|
|
internal
|
|
|
argocd/api/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. |
|
cniprovisioner/utils/networkhelper/mock
Package mock_networkhelper is a generated GoMock package.
|
Package mock_networkhelper is a generated GoMock package. |
|
kamaji/api/v1alpha1
Package v1alpha1 contains code that was copied from the upstream Kamaji@v1.0.0 types.
|
Package v1alpha1 contains code that was copied from the upstream Kamaji@v1.0.0 types. |
|
ovsutils
Package ovsutils is a generated GoMock package.
|
Package ovsutils is a generated GoMock package. |
|
sfccontroller/controllers
Package controller is a generated GoMock package.
|
Package controller is a generated GoMock package. |
|
utils/ovsclient/mock
Package mock_ovsclient is a generated GoMock package.
|
Package mock_ovsclient is a generated GoMock package. |
|
test
|
|