docs(dpf): update BF4 deployment example to use bluefield_software#3373
Open
abvarshney-nv wants to merge 1 commit into
Open
docs(dpf): update BF4 deployment example to use bluefield_software#3373abvarshney-nv wants to merge 1 commit into
abvarshney-nv wants to merge 1 commit into
Conversation
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3373.docs.buildwithfern.com/infra-controller |
Contributor
Summary by CodeRabbit
WalkthroughThe BF4 generic deployment example now states that ChangesBF4 deployment documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with 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.
Inline comments:
In `@docs/manuals/dpf.md`:
- Around line 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.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 9f20d65e-76e7-48a8-ac22-e5815fbd34d5
📒 Files selected for processing (1)
docs/manuals/dpf.md
Comment on lines
+577
to
+588
| # 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" |
Contributor
There was a problem hiding this comment.
🎯 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_isoandbluefield_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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
update BF4 deployment example to use bluefield_software
Related issues
Type of Change
Breaking Changes
Testing
Additional Notes