DOCA Documentation v3.4.0

DOCA Framework

This page provides an overview of the NVIDIA DOCA Framework including details on its architecture, installation packages, and software components.

DOCA Software Download

Visit DOCA Downloads page to download the relevant software.

DOCA SDK

DOCA Overview

This page provides an overview of the structure of NVIDIA DOCA documentation.

Release Notes

This page contains information on new features, bug fixes, and known issues.

User Types

This page provides a quick introduction to the NVIDIA® BlueField® family of networking platforms (i.e., DPUs and SuperNICs), its DOCA software components, and BlueField user types.

NVIDIA DOCA EULA

This page provides the NVIDIA DOCA SDK end-user license agreement.

DOCA Legal Notices and 3rd Party Licenses

This page provides links to the legal notices, licenses, and third-party attribution documents for the software components included in this NVIDIA DOCA release.

Quick Start

Developer Quick Start Guide

This page details the basic steps to bring up the NVIDIA DOCA development environment and to build and run the DOCA reference applications provided along with the DOCA software framework package.

Installation and Setup

DOCA Profiles

This page provides an introduction to the various supported DOCA profiles.

MLNX_OFED to DOCA-OFED Transition Guide

This page covers what users must know about the DOCA-Host unified software stack for NVIDIA networking products.

Installation Guide for Linux

This page details the necessary steps to set up NVIDIA DOCA in your Linux environment.

Developer Guide

This page details the recommended steps to set up an NVIDIA DOCA development environment.

DOCA Programming Guides

These pages are intended for developers wishing to utilize DOCA SDK to develop application on top of NVIDIA BlueField networking platforms.

DOCA Reference Applications

This page provides an overview of the example DOCA applications implemented on top of NVIDIA BlueField.

App Shield Agent

This page provides process introspection system implementation on top of NVIDIA® BlueField®.

Bifurcated Driver Model

This page provides an example of a Bifurcated Driver Model implementation using a multi-port eSwitch on top of the NVIDIA® BlueField® DPU.

DMA Copy

This page provides an example of a DMA Copy implementation on top of NVIDIA BlueField.

DPA All-to-all

This page explains the all-to-all collective operation example when accelerated using the DPA in NVIDIA BlueField-3.

East-west Overlay Encryption

This page describes IPsec based strongSwan solution on top of NVIDIA BlueField.

Ethernet L2 Forwarding

This page provides an Ethernet L2 Forwarding implementation on top of the NVIDIA BlueField DPU.

File Compression

This page provides a file compression implementation on top of the NVIDIA BlueField.

File Integrity

This page provides a file integrity implementation on top of NVIDIA BlueField.

GPU Packet Processing

This page provides a description of the GPU packet processing application to demonstrate using the DOCA GPUNetIO, DOCA Ethernet, and DOCA Flow libraries to implement a GPU traffic analyzer.

IP Fragmentation

This page provides an implementation of IP fragmentation application on top of NVIDIA® BlueField®-3 DPU.

IPsec Security Gateway

This page provides an IPsec security gateway implementation on top of NVIDIA BlueField.

NVMe Emulation

This page provides an NVMe emulation implementation on top of the NVIDIA BlueField DPU.

PCC

This page provides a DOCA PCC implementation on top of NVIDIA BlueField.

PSP Gateway

This page describes the usage of the NVIDIA DOCA PSP Gateway sample application on top of an NVIDIA BlueField networking platform or NVIDIA ConnectX SmartNIC.

Secure Channel

This page provides a secure channel implementation on top of NVIDIA BlueField.

Simple Forward VNF

This page provides a Simple Forward implementation on top of NVIDIA BlueField.

SNAP Virtio-fs

This page describes the DOCA SNAP Virtio-fs Application which leverages DOCA DevEmu APIs and NFS backends via libnfs to provide high-performance, hardware-accelerated file system emulation.

Storage

This page outlines NVIDIA DOCA storage applications that demonstrate how to develop data storage implementations on the NVIDIA® BlueField® platform.

Stream Receive Performance

This page outlines the implementation of the DOCA Stream Receive Performance application, built on top of the NVIDIA® BlueField® DPU.

Switch

This page provides an example of switch implementation on top of NVIDIA BlueField.

Accelerated UPF

This page provides a reference implementation of an accelerated data path of UPF on top of the NVIDIA® BlueField-3®.

UROM RDMO

This page provides a DOCA Remote Direct Memory Operation implementation on top of NVIDIA BlueField using Unified Communication X (UCX).

YARA Inspection

This page provides YARA inspection implementation on top of NVIDIA BlueField.

Pipeline Language Runtime Controller Gateway SHM

This page describes the usage of the NVIDIA DOCA Pipeline Language (DPL) Runtime Controller Gateway SHM sample application.

DPU GPU Remote Offload

This page provides a reference implementation for developing a GPU offload application on top of NVIDIA® BlueField® DPUs and NVIDIA GPUs using the DOCA Comch and DOCA GPUNetIO libraries.

Time Sync

This page provides an example of a Time Sync implementation on top of NVIDIA® BlueField® DPU.

Telemetry

This page provides a reference to the reference applications relating to DOCA Telemetry functionality.

DOCA Tools

This page provides an overview of the set of tools provided by DOCA and their purpose.

DOCA Bench

This page describes a tool which allows users to evaluate the performance of DOCA applications, with reasonable accuracy for real-world applications.

Capabilities Print Tool

This page provides instruction on the usage of the DOCA Capabilities Print Tool.

Comm Channel Admin Tool

This page provides instructions on the usage of the DOCA Comm Channel Admin Tool.

DPA Tools

This page lists a set of executables that enable the DPA application developer and the system administrator to manage and monitor DPA resources and to debug DPA applications.

Flow Tune

This page provides a powerful, one-stop-shop solution, providing visibility and analysis capabilities for DOCA Flow programs.

Ngauge

This page provides instructions on the usage of the ngauge tool.

Perftest

This page describes DOCA Perftest, an RDMA benchmarking tool designed for compute clusters that enables fine-tuned evaluation of bandwidth, message rate, and latency across various RDMA operations and complex multi-node scenarios.

Pipeline Language Developer Tools

These pages describe the NVIDIA DOCA Pipeline Language (DPL) Developer Tools, which are used to inspect and debug DPL programs on NVIDIA® BlueField® DPUs.

PCC Counter

This page provides instruction on the usage of the PCC Counter tool.

Socket Relay

This page describes DOCA Socket Relay architecture, usage, etc.

Telemetry Utils

This page provides instructions on the usage of the doca_telemetry_utils tool.

doca-hugepages Tool

This page provides an overview of the doca-hugepages tool, including its purpose, usage instructions, command syntax, and integration guidelines for managing hugepage allocations in NVIDIA DOCA environments.

DOCA Services

This page provides an overview of the set of services provided by DOCA and their purpose.

Container Deployment

This page provides an overview and deployment configuration of DOCA containers for NVIDIA BlueField.

DOCA Argus Service

This page provides installation, configuration, and usage instructions for the DOCA Argus Service.

DOCA BlueMan Service

This page provides instructions on how to use the DOCA BlueMan service on top of NVIDIA BlueField.

DOCA Firefly Service

This page provides instructions on how to use the DOCA Firefly service container on top of NVIDIA BlueField.

DOCA Flow Inspector Service

This page provides instructions on how to use the DOCA Flow Inspector service container on top of NVIDIA BlueField.

DOCA HBN Service

This page provides instructions on how to use the DOCA HBN Service container on top of NVIDIA BlueField.

DOCA Management Service

This page provides instructions on how to use the DOCA Management Service on top of NVIDIA BlueField Networking Platform or ConnectX Network Adapters.

DOCA Pipeline Language Services Guide

This page outlines the DOCA Pipeline Language (DPL) approach to packet processing programmability for NVIDIA BlueField. DPL introduces a software development solution based on a domain-specific programming language (DSL), supported by a set of DOCA services.

DOCA SNAP Service

This page provides instructions on using DOCA SNAP services on top of the NVIDIA BlueField-3 DPU.

DOCA Telemetry Service

This page provides instructions on how to use the DOCA Telemetry Service (DTS) container on top of NVIDIA BlueField.

DOCA UROM Service

This page provides instructions on how to use the DOCA Telemetry Service (DTS) container on top of NVIDIA BlueField.

DOCA Virtio-net Service

This page provides instructions on how to use the DOCA virtio-net service container on top of BlueField-3 networking platform.

DOCA Virtio-net Service Guide

This page provides instructions on how to use the DOCA Telemetry Service (DTS) container on top of NVIDIA BlueField.

OpenvSwitch Acceleration (OVS in DOCA)

These pages describe OVS within DOCA, particularly OVS-DOCA, a virtual switch service tailored for NVIDIA NICs and DPUs. It leverages ASAP² technology for accelerated data-path processing, ensuring optimal performance and features through its architecture and integration with DOCA libraries.

API References

Provides pointer to API References for DOCA documentation.

Miscellaneous (Runtime)

Glossary

This page provides a list of terms and acronyms and in the DOCA documentation.

Crypto Acceleration

This page shows the ability of NVIDIA BlueField to accelerate crypto operations.

DOCA Services Fluent Logger

This page provides instructions on how to use the logging infrastructure for DOCA services on top of NVIDIA BlueField.

DPU CLI

This page provides quick access to a useful set of CLI commands and utilities on the NVIDIA BlueField environment.

Switching

These pages provides a comprehensive guide to the hardware-accelerated switching capabilities of NVIDIA® BlueField® and NVIDIA® ConnectX® platforms, including configurations for switchdev mode, representor models, and network features such as vDPA, bridge offload, and link aggregation.

OpenSSL

This page provides instructions on using DOCA SHA for OpenSSL implementations.

Scalable Functions (SFs)

This page provides an overview and configuration of scalable functions (sub-functions, or SFs) for NVIDIA BlueField.

TLS Offload

This page provides an overview and configuration steps of TLS hardware offloading via kernel-TLS, using hardware capabilities of NVIDIA BlueField.

Troubleshooting

This page provides troubleshooting information for common issues and misconfigurations encountered when using DOCA for NVIDIA BlueField.

Virtual Functions (VFs)

This page provides an overview and configuration of virtual functions for NVIDIA® BlueField® and demonstrates a use case for running the DOCA applications over x86 host.

BlueField SR-IOV

This page explains the NVIDIA BlueField SR-IOV solution, detailing how to configure asymmetric Virtual Functions (VFs) per Embedded CPU Function (ECPF) and host Physical Function (PF) to enable scalable network virtualization.

fTPM over OP-TEE

This page provides an overview and configuration instructions for using fTPM over the OP-TEE on BlueField-3 DPUs (and higher) to deliver secure, hardware-isolated cryptographic services and protected storage without requiring a separate dedicated chip.