Skip to content

docs(dpf): update BF4 deployment example to use bluefield_software #3373

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abvarshney-nv wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −3
Open

docs(dpf): update BF4 deployment example to use bluefield_software #3373

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions docs/manuals/dpf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,10 +574,18 @@ node_label_key = "carbide.nvidia.com/controlled.node.v2"
# BF4 generic is opt-in. Add this table to provision BF4 DPUs via a second
# DPUDeployment alongside BF3. All identifiers must differ from BF3's.
[dpf.deployments.bf4_generic]
bfb_url = "https://content.mellanox.com/BlueField/BFBs/Ubuntu24.04/bf-bundle-<bf4-version>.bfb"
flavor_name = "carbide-dpu-flavor-bf4"
deployment_name = "nico-deployment-bf4"
# NOTE: bfb_url must NOT be set here. BF4 uses bluefield_software instead.
flavor_name = "dpu-flavor-bf4"
deployment_name = "dpu-deployment-bf4"
node_label_key = "carbide.nvidia.com/controlled.node.bf4"

[dpf.deployments.bf4_generic.bluefield_software]
# Shared across all PSIDs
os_iso = "https://artifacts.example.com/bfb.3.3.x.iso"

# PSID -> PLDM firmware bundle URL.
[dpf.deployments.bf4_generic.bluefield_software.pldm_fw_bundle]
"MT_000000xxxx" = "https://artifacts.example.com/bf4/mt_000000xxxx.pldm"
Comment on lines +577 to +588

@coderabbitai coderabbitai Bot Jul 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Complete the BF4 documentation contract.

The example correctly switches BF4 to bluefield_software, but the surrounding documentation remains misleading:

  • The earlier deployment description still says each deployment has its own BFB, although BF4 uses BlueFieldSoftware.
  • The field-reference table omits bluefield_software.os_iso and bluefield_software.pldm_fw_bundle, so operators cannot discover or validate the new required fields there.
  • Document that the current configuration requires exactly one PSID-to-PLDM bundle entry.

Please update those references in this change. As per path instructions, documentation must remain technically correct and consistent with current deployment behavior.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/manuals/dpf.md` around lines 577 - 588, The BF4 documentation is
inconsistent with its BlueFieldSoftware configuration contract. Update the
earlier deployment description to state that deployments use either a
per-deployment BFB or BlueFieldSoftware, add bluefield_software.os_iso and
bluefield_software.pldm_fw_bundle to the field-reference table with accurate
requirements, and explicitly document that exactly one PSID-to-PLDM bundle entry
is currently required.

Source: Path instructions

```

Per-deployment field reference:
Expand Down
Loading