docs: separate host DPU policy from observed device mode#3473
Open
chet wants to merge 1 commit into
Open
Conversation
Contributor
|
Note Currently processing new changes in this PR. This may take a few minutes, please wait... ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (9)
WalkthroughThe documentation adopts ChangesDPU policy documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Contributor
Author
|
@coderabbitai full_review, thanks! |
Contributor
|
ʘ‿ʘ ✅ Action performedFull review finished. |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3473.docs.buildwithfern.com/infra-controller |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
![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: 2
🤖 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/vpc/flat_vpcs_zero_dpu.md`:
- Around line 103-143: Update all listed documentation sites to use the existing
DpuMode/dpu_mode contract until the policy rename lands: replace dpu_policy,
HostDpuPolicy, and --dpu-policy guidance with the current dpu_mode/DpuMode names
and CLI values, while preserving legacy behavior descriptions. Apply the
corresponding updates in docs/manuals/vpc/flat_vpcs_zero_dpu.md (lines 103-143,
73-74, and 416-418), docs/glossary.md (lines 54-61 and 159),
docs/provisioning/ingesting-hosts.md (line 192),
docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.md
(lines 19-20, 117-131, and 164), and expected-machine-patch.md (lines 20-21,
123-137, and 170).
In `@docs/provisioning/boot-interfaces-and-dpu-modes.md`:
- Around line 53-73: The guide must match the implemented DPU-policy contract:
document legacy dpu_mode and --dpu-mode names with their mappings, and use
accepted CLI flags and payload fields. Update
docs/provisioning/boot-interfaces-and-dpu-modes.md lines 53-73, 97, 115,
129-137, 148-152, 161-165, 174-181, and 197-200; retain
ExpectedMachine.dpu_mode, correct the add and patch flags, update all zero-DPU,
NIC-mode, and managed-DPU payloads, and correct the admin-CLI reference table.
🪄 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: 25e4efc6-d359-4d69-8126-1474e6bbb303
📒 Files selected for processing (9)
docs/development/new_hardware_support.mddocs/glossary.mddocs/index.ymldocs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.mddocs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-patch.mddocs/manuals/vpc/flat_vpcs_zero_dpu.mddocs/observability/core_metrics.mddocs/provisioning/boot-interfaces-and-dpu-modes.mddocs/provisioning/ingesting-hosts.md
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/provisioning/boot-interfaces-and-dpu-modes.md`:
- Around line 63-67: Update the `manage` row in the JSON/TOML and CLI policy
table so it describes DPU lifecycle management without requiring DPU/Admin boot.
State that DPU/Admin is the default boot path only when no plain-NIC primary
interface is declared, while preserving the existing inheritance behavior for
per-host `manage` declarations.
🪄 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: d30fb5b5-5753-4503-8729-5437ce1d358d
📒 Files selected for processing (9)
docs/development/new_hardware_support.mddocs/glossary.mddocs/index.ymldocs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.mddocs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-patch.mddocs/manuals/vpc/flat_vpcs_zero_dpu.mddocs/observability/core_metrics.mddocs/provisioning/boot-interfaces-and-dpu-modes.mddocs/provisioning/ingesting-hosts.md
The provisioning, ingestion, Flat VPC, glossary, metrics, and admin CLI docs now use `HostDpuPolicy::{Manage, UseAsNic, Ignore}` for desired behavior and `BlueFieldOperatingMode::{Dpu, Nic}` for observed hardware state.
Existing `dpu_mode` fields, flags, values, and protobuf/Redfish names are called out as backwards-compatible boundaries rather than the canonical vocabulary.
This supports NVIDIA#3472
Signed-off-by: Chet Nichols III <chetn@nvidia.com>
Contributor
Author
|
@coderabbitai full_review, thanks! |
Contributor
|
ʘ‿ʘ ✅ Action performedFull review finished. |
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.
The provisioning, ingestion, Flat VPC, glossary, metrics, and admin CLI docs now use
HostDpuPolicy::{Manage, UseAsNic, Ignore}for desired behavior andBlueFieldOperatingMode::{Dpu, Nic}for observed hardware state.Existing
dpu_modefields, flags, values, and protobuf/Redfish names are called out as backwards-compatible boundaries rather than the canonical vocabulary.This is the separately reviewed documentation companion to #3453 and should merge after that code PR.
Validation:
cargo make format-nightlycargo make clippycargo make carbide-lintsgit diff --checkThis supports #3472