WIP: NVIDIA-918: Add NVIDIA DPF Operator documentation - #117002
WIP: NVIDIA-918: Add NVIDIA DPF Operator documentation#117002Shivank-rh wants to merge 2 commits into
Conversation
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>
|
@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. DetailsIn response to this:
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. |
|
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 Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
@gaurav-nelson Took an initial pass at generating reformatted docs! |
|
/ok-to-test |
| include::modules/nw-dpf-management-cluster-setup.adoc[leveloffset=+1] | ||
|
|
||
| [id="configuring-worker-nodes_{context}"] | ||
| == Configuring worker nodes |
There was a problem hiding this comment.
🤖 [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. |
There was a problem hiding this comment.
🤖 [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 |
There was a problem hiding this comment.
🤖 [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 |
There was a problem hiding this comment.
🤖 [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 |
There was a problem hiding this comment.
🤖 [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>
|
@Shivank-rh: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
|
Closing this in favor of #117142 I wasn't able to push to this branch, even though i have maintainer rights: |
Summary
networking/networking_operators/dpf_operator/, 59 modules inmodules/, 2 images, topic map entryStructure
about-dpf-operatordpf-environment-setupdpf-operator-installationdpf-hosted-cluster-provisioningdpf-worker-nodes-provisioningdpf-validation-telemetrydpf-troubleshootingItems for reviewer
xref:placeholders — need anchor ID verificationTest plan
include::paths resolve🤖 Generated with Claude Code