MCPcopy Index your code
hub / github.com/NVIDIA/doca-platform

github.com/NVIDIA/doca-platform @v26.4.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v26.4.0 ↗ · + Follow
6,699 symbols 24,596 edges 862 files 3,889 documented · 58%
What it actually does AI analysis from the code graph — generated when you open this
loading…
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: - Zero Trust Mode - Host Trusted Mode

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.

Extension points exported contracts — how you extend this code

Operation (Interface)
Operation is the interface for all operations. The same optCtx instance is passed to all operations, which can be used t [23 …
internal/provisioning/dpuagent/operations/type.go
Runnable (Interface)
Runnable is an interface expected by Runner from the service [11 implementers]
internal/storage/snap/csi-plugin/utils/runner/runner.go
Component (Interface)
Component describes the responsibilities of an item in the Inventory. [8 implementers]
internal/operator/inventory/inventory.go
DeprecatedImageComponentConfigurable (Interface)
Validation is the same as the implementation at https://github.com/containers/image/blob/93fa49b0f1fb78470512e0484012ca7 [13 …
api/operator/v1alpha1/componentconfig_common.go
ClientOption (Interface)
(no doc) [24 implementers]
pkg/dpucluster/config.go
DPUServiceObject (Interface)
DPUServiceObject is an interface implemented by common DPUService* related objects enabling common functions in the reco [4 …
api/dpuservice/v1alpha1/common.go
NetworkHelper (Interface)
NetworkHelper is a helper that can be used to configure networking related settings on the system. go:generate mockgen - [3 …
pkg/utils/networkhelper/types.go
TestFileSystem (Interface)
Test Strategy Documentation * This test suite follows these principles: 1. Unit Tests: Each function is tested in isolat [3 …
pkg/vfmac/vfmac_test.go

Core symbols most depended-on inside this repo

Create
called by 1111
internal/dpuservice/controllers/dpuready_controller.go
String
called by 467
internal/provisioning/dpuagent/operations/sysctl/sysctl.go
Run
called by 331
internal/storage/snap/csi-plugin/utils/runner/runner.go
Error
called by 310
internal/utils/utils.go
Error
called by 280
internal/storage/snap/storage-vendor-dpu-plugin/fs-storage-vendor-dpu-plugin/storage_vendor_dpu_rpc.go
String
called by 276
internal/operator/inventory/common.go
Error
called by 258
internal/provisioning/controllers/dpu/util/dpu_in_provisioning_map.go
Create
called by 232
pkg/ovsutils/mock_ovs.go

Shape

Method 3,219
Function 2,412
Struct 910
Interface 77
TypeAlias 61
FuncType 20

Languages

Go100%

Modules by API surface

api/dpuservice/v1alpha1/zz_generated.deepcopy.go210 symbols
api/provisioning/v1alpha1/zz_generated.deepcopy.go176 symbols
api/grpc/nvidia/storage/plugins/v1/storage_plugin.pb.go167 symbols
api/storage/v1alpha1/zz_generated.deepcopy.go98 symbols
api/operator/v1alpha1/componentconfig_types.go96 symbols
api/operator/v1alpha1/zz_generated.deepcopy.go92 symbols
pkg/ovsutils/mock_ovs.go76 symbols
internal/dpuservice/controllers/dpuready_controller.go68 symbols
internal/provisioning/controllers/dpu/state/redfish/client/client.go62 symbols
api/grpc/nvidia/storage/plugins/v1/storage_plugin_grpc.pb.go62 symbols
pkg/dpucluster/cache.go57 symbols
internal/dpuservice/controllers/dpuservice_controller.go51 symbols

For agents

$ claude mcp add doca-platform \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact