docs(site-explorer): document the mlx-devices NIC-firmware report#3650
docs(site-explorer): document the mlx-devices NIC-firmware report#3650chet wants to merge 1 commit into
Conversation
A BlueField flipped to NIC mode runs with its Arm OS down, so `dpu versions` never sees its NIC firmware -- `site-explorer mlx-devices` exists exactly for that gap, reporting part number, serial, firmware, and mode from the host BMC's explored Redfish PCIe inventory. It shipped without a single mention in docs/, so this adds the operator-facing story and the generated CLI reference. The DPU Lifecycle Management manual's Firmware Upgrades section gains an auditing subsection beside the existing `dpu versions` snippet, covering the NIC-mode motivation and the `--nic-mode-only`/`--expected-version` filters. The generated corpus gains `site-explorer-mlx-devices.md` plus the parent page's subcommand row via `cargo make gen-cli-docs`, scoped to just these two pages -- a full regen dirties ~595 other stale pages (the corpus has no CI gate), which is follow-up material rather than this PR. This supports NVIDIA#3643 Signed-off-by: Chet Nichols III <chetn@nvidia.com>
|
@coderabbitai full_review, thanks! |
|
🐇🔍 ✅ Action performedFull review finished. |
WalkthroughAdds documentation for Changesmlx-devices documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related issues
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3650.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}
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/nico-admin-cli/commands/site-explorer/site-explorer-mlx-devices.md`:
- Around line 12-14: Update the mlx-devices command synopsis to show the
required arguments for --host and --expected-version, matching the OPTIONS
section by rendering them with HOST and EXPECTED_VERSION placeholders. Preserve
the existing optional flags and ordering.
- Around line 36-38: Correct the generated description text in the site explorer
MLX devices documentation by changing “This used by measured boot” to “This is
used by measured boot.”.
🪄 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: c7b90b93-d17a-4744-bb4e-560463933207
📒 Files selected for processing (3)
docs/dpu-management/dpu-lifecycle-management.mddocs/manuals/nico-admin-cli/commands/site-explorer/site-explorer-mlx-devices.mddocs/manuals/nico-admin-cli/commands/site-explorer/site-explorer.md
| **nico-admin-cli site-explorer mlx-devices** \[**--host**\] | ||
| \[**--nic-mode-only**\] \[**--expected-version**\] \[**--extended**\] | ||
| \[**--sort-by**\] \[**-h**\|**--help**\] |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Show required option arguments in the synopsis.
--host and --expected-version are rendered as valueless flags here, although the OPTIONS section requires <HOST> and <EXPECTED_VERSION>. Update the synopsis so generated usage is copy-paste accurate.
Proposed fix
-**nico-admin-cli site-explorer mlx-devices** \[**--host**\]
-\[**--nic-mode-only**\] \[**--expected-version**\] \[**--extended**\]
+**nico-admin-cli site-explorer mlx-devices** \[**--host** *\<HOST\>*\]
+\[**--nic-mode-only**\] \[**--expected-version** *\<EXPECTED_VERSION\>*\] \[**--extended**\]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| **nico-admin-cli site-explorer mlx-devices** \[**--host**\] | |
| \[**--nic-mode-only**\] \[**--expected-version**\] \[**--extended**\] | |
| \[**--sort-by**\] \[**-h**\|**--help**\] | |
| **nico-admin-cli site-explorer mlx-devices** \[**--host** *\<HOST\>*\] | |
| \[**--nic-mode-only**\] \[**--expected-version** *\<EXPECTED_VERSION\>*\] \[**--extended**\] | |
| \[**--sort-by**\] \[**-h**\|**--help**\] |
🤖 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/nico-admin-cli/commands/site-explorer/site-explorer-mlx-devices.md`
around lines 12 - 14, Update the mlx-devices command synopsis to show the
required arguments for --host and --expected-version, matching the OPTIONS
section by rendering them with HOST and EXPECTED_VERSION placeholders. Preserve
the existing optional flags and ordering.
Source: Path instructions
| This used by measured boot, where basic output contains just what you | ||
| probably care about, and "extended" output also dumps out all the | ||
| internal UUIDs that are used to associate instances. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the grammar in the generated description.
This used by measured boot should be This is used by measured boot.
Proposed fix
-This used by measured boot, where basic output contains just what you
+This is used by measured boot, where basic output contains just what you📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| This used by measured boot, where basic output contains just what you | |
| probably care about, and "extended" output also dumps out all the | |
| internal UUIDs that are used to associate instances. | |
| This is used by measured boot, where basic output contains just what you | |
| probably care about, and "extended" output also dumps out all the | |
| internal UUIDs that are used to associate instances. |
🤖 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/nico-admin-cli/commands/site-explorer/site-explorer-mlx-devices.md`
around lines 36 - 38, Correct the generated description text in the site
explorer MLX devices documentation by changing “This used by measured boot” to
“This is used by measured boot.”.
Source: Path instructions
1 participant
site-explorer mlx-devicesis the only way to see NIC firmware for a BlueField in NIC mode (its Arm OS is down, sodpu versionsnever sees it) -- and it had zero docs presence. This adds an auditing subsection to the DPU Lifecycle Management manual beside the existingdpu versionssnippet, plus the generated CLI reference page and parent-page subcommand row (regen scoped to these two pages; the corpus has ~595 other stale pages and no CI gate -- follow-up material).This supports #3643