Skip to content

WIP: NVIDIA-918: Add NVIDIA DPF Operator documentation - #117002

Closed
Shivank-rh wants to merge 2 commits into
openshift:mainfrom
Shivank-rh:NVIDIA-918-dpf-operator-docs
Closed

WIP: NVIDIA-918: Add NVIDIA DPF Operator documentation#117002
Shivank-rh wants to merge 2 commits into
openshift:mainfrom
Shivank-rh:NVIDIA-918-dpf-operator-docs

Conversation

@Shivank-rh

Copy link
Copy Markdown

Summary

  • Converts the NVIDIA DPF (DOCA Platform Framework) v26.4 installation manual into modular AsciiDoc
  • DPF enables hardware-accelerated OVN-Kubernetes networking by offloading data plane operations to NVIDIA BlueField-3 DPUs on OpenShift 4.22
  • 7 assemblies in networking/networking_operators/dpf_operator/, 59 modules in modules/, 2 images, topic map entry

Structure

Assembly Content
about-dpf-operator Architecture overview, component placement, requirements
dpf-environment-setup Management cluster setup, prerequisite operators
dpf-operator-installation DPF Operator install, DPU resources, DPU services
dpf-hosted-cluster-provisioning DPU hosted cluster via dpf-hcp-provisioner
dpf-worker-nodes-provisioning OVN-K CNI adjustments, adding workers, DPU provisioning
dpf-validation-telemetry Traffic validation, DTS observability
dpf-troubleshooting DPU provisioning issues, unsupported OVN-K features

Items for reviewer

  • TOC bits need to be added by the reviewer
  • TODO comments flag areas needing engineering verification: BFB registry auth, TP vs GA in Ch 12
  • Cross-references to existing OCP docs use xref: placeholders — need anchor ID verification
  • Source uses "management cluster" and "host cluster" interchangeably — standardized on "management cluster"

Test plan

  • Verify all include:: paths resolve
  • Verify topic map renders correctly
  • Review Vale compliance
  • Cross-check code examples against DPF v26.4 source

🤖 Generated with Claude Code

Convert the NVIDIA DPF (DOCA Platform Framework) v26.4 installation manual
into modular AsciiDoc for openshift-docs. DPF enables hardware-accelerated
OVN-Kubernetes networking by offloading data plane operations to NVIDIA
BlueField-3 DPUs on OpenShift 4.22.

Content:
- 7 assemblies in networking/networking_operators/dpf_operator/
- 59 modules (44 procedure, 10 reference, 5 concept) in modules/
- 2 architecture diagram images
- Topic map entry after the existing DPU Operator section

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 30, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 30, 2026

Copy link
Copy Markdown

@Shivank-rh: This pull request references NVIDIA-918 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the epic to target the "5.0.0" version, but no target version was set.

Details

In response to this:

Summary

  • Converts the NVIDIA DPF (DOCA Platform Framework) v26.4 installation manual into modular AsciiDoc
  • DPF enables hardware-accelerated OVN-Kubernetes networking by offloading data plane operations to NVIDIA BlueField-3 DPUs on OpenShift 4.22
  • 7 assemblies in networking/networking_operators/dpf_operator/, 59 modules in modules/, 2 images, topic map entry

Structure

Assembly Content
about-dpf-operator Architecture overview, component placement, requirements
dpf-environment-setup Management cluster setup, prerequisite operators
dpf-operator-installation DPF Operator install, DPU resources, DPU services
dpf-hosted-cluster-provisioning DPU hosted cluster via dpf-hcp-provisioner
dpf-worker-nodes-provisioning OVN-K CNI adjustments, adding workers, DPU provisioning
dpf-validation-telemetry Traffic validation, DTS observability
dpf-troubleshooting DPU provisioning issues, unsupported OVN-K features

Items for reviewer

  • TOC bits need to be added by the reviewer
  • TODO comments flag areas needing engineering verification: BFB registry auth, TP vs GA in Ch 12
  • Cross-references to existing OCP docs use xref: placeholders — need anchor ID verification
  • Source uses "management cluster" and "host cluster" interchangeably — standardized on "management cluster"

Test plan

  • Verify all include:: paths resolve
  • Verify topic map renders correctly
  • Review Vale compliance
  • Cross-check code examples against DPF v26.4 source

🤖 Generated with Claude Code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 30, 2026
@openshift-ci

openshift-ci Bot commented Jul 30, 2026

Copy link
Copy Markdown

Hi @Shivank-rh. Thanks for your PR.

I'm waiting for a openshift member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work.

Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@Shivank-rh

Copy link
Copy Markdown
Author

@gaurav-nelson Took an initial pass at generating reformatted docs!

@gaurav-nelson

Copy link
Copy Markdown
Contributor

/ok-to-test

@openshift-ci openshift-ci Bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 31, 2026
include::modules/nw-dpf-management-cluster-setup.adoc[leveloffset=+1]

[id="configuring-worker-nodes_{context}"]
== Configuring worker nodes

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.AssemblyContents: Content other than additional resources cannot follow include directives.

toc::[]

[role="_abstract"]
The `dpf-hcp-provisioner-operator` automates the creation and lifecycle management of a HyperShift hosted cluster for DPU nodes. This operator abstracts the complexity of setting up a hosted control plane for the DPU cluster.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] RedHat.TermsErrors: Use 'hosted control planes' rather than 'HyperShift'. For more information, see RedHat.TermsErrors.

include::modules/nw-dpf-installing-dpf-operator.adoc[leveloffset=+1]

[id="creating-dpf-resources_{context}"]
== Creating DPF resources

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.AssemblyContents: Content other than additional resources cannot follow include directives.

include::modules/nw-dpf-running-traffic-validation.adoc[leveloffset=+2]

[id="dpu-telemetry_{context}"]
== Configuring DPU telemetry

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.AssemblyContents: Content other than additional resources cannot follow include directives.

include::modules/nw-dpf-enabling-ovnk-dpu-host-mode.adoc[leveloffset=+2]

[id="adding-worker-nodes_{context}"]
== Adding worker nodes

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.AssemblyContents: Content other than additional resources cannot follow include directives.

Move inline section headings from 4 assembly files into dedicated concept
modules to satisfy AsciiDocDITA.AssemblyContents rule. Replace 'HyperShift'
with 'hosted control planes' in dpf-hosted-cluster-provisioning.adoc.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@openshift-ci

openshift-ci Bot commented Jul 31, 2026

Copy link
Copy Markdown

@Shivank-rh: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@gaurav-nelson

Copy link
Copy Markdown
Contributor

Closing this in favor of #117142

I wasn't able to push to this branch, even though i have maintainer rights:

git push Shivank-rh NVIDIA-918-dpf-operator-docs -f
error: Authentication error: Authentication required: You must have push access to verify locks
error: failed to push some refs to 'github.com:Shivank-rh/openshift-docs.git'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants