Skip to content

docs: Document nico-admin-cli boot-interface commands#3606

Open
kfelternv wants to merge 1 commit into
NVIDIA:mainfrom
kfelternv:docs/sync-20260716
Open

docs: Document nico-admin-cli boot-interface commands#3606
kfelternv wants to merge 1 commit into
NVIDIA:mainfrom
kfelternv:docs/sync-20260716

Conversation

@kfelternv

@kfelternv kfelternv commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

What this PR does

Adds the nico-admin-cli boot-interface command family to docs/provisioning/boot-interfaces-and-dpu-modes.md:

  • Section 4 now documents show, candidates, and set with their actual Core RPCs and argument shapes.
  • Section 8 points troubleshooting readers to the read-only show and candidates views.

The commands landed in #3341 but were missing from this hand-maintained guide. This change complements #3270, which documents the older hidden machine boot-interfaces alias and the broader data model, and #3410, which adds the generated command-reference pages.

Also checked for docs impact: #3509 (the renamed field is not referenced), #3294 (the guide does not claim OS image fields are mutable), #3237 (the REST-first guidance is confined to error text), and the recent metrics/refactor PRs (documented in their owning changes).

How we verified it

Revision: 9fca9570bceefa5ab47240388c50aa1193b805f2 on macOS 26.5.1 with Rust 1.96.0, Fern CLI 5.57.0, and rumdl 0.2.34.

  • cargo build -p nico-admin-cli passed.
  • The exact binary's boot-interface show --help, boot-interface candidates --help, and boot-interface set --help output matched every command name, positional argument, --reboot option, read-only claim, and RPC mapping in the guide.
  • cargo test -p nico-admin-cli boot_interface passed all 17 focused tests.
  • uvx rumdl check --config docs/.rumdl.toml docs/provisioning/boot-interfaces-and-dpu-modes.md reported only the two pre-existing MD029 findings at lines 267-268, outside this diff.
  • npx -y fern-api@5.57.0 docs md check validated all 116 MDX files.
  • npx -y fern-api@5.57.0 check reported 0 errors and the expected unauthenticated missing-redirects warning.
  • A local fern docs dev preview returned HTTP 200 for the Boot Interfaces and DPU Modes page. The rendered HTML contained all three new command rows and a working Section 4 anchor.
  • git diff --check f5887367067413d95b2ef8197f0dae658638f762...HEAD passed.

How to reproduce the verification

Prerequisites: Rust from the repository's pinned toolchain, Node.js 20 or newer, uvx, and rg.

git clone https://github.com/kfelternv/infra-controller.git
cd infra-controller
git checkout --detach 9fca9570bceefa5ab47240388c50aa1193b805f2

cargo build -p nico-admin-cli
target/debug/nico-admin-cli boot-interface show --help
target/debug/nico-admin-cli boot-interface candidates --help
target/debug/nico-admin-cli boot-interface set --help
cargo test -p nico-admin-cli boot_interface

uvx rumdl check --config docs/.rumdl.toml docs/provisioning/boot-interfaces-and-dpu-modes.md
npx -y fern-api@5.57.0 docs md check
npx -y fern-api@5.57.0 check
git diff --check f5887367067413d95b2ef8197f0dae658638f762...HEAD

Expected results: the build and 17 focused tests pass; each help page exposes the command and arguments documented in the guide; Fern reports 0 errors; rumdl reports only the two existing MD029 findings outside the diff; and the diff check is silent.

Start the local preview in one terminal:

npx -y fern-api@5.57.0 docs dev --port 3106

Then verify the rendered page in another terminal:

PAGE=http://localhost:3106/infra-controller/documentation/provisioning-day-0/boot-interfaces-and-dpu-modes
curl -fsS -o /dev/null -w '%{http_code}\n' "$PAGE"
HTML=$(curl -fsS "$PAGE")
for needle in 'boot-interface show' 'boot-interface candidates' 'boot-interface set' '#4-admin-cli-and-grpc-reference'; do
  rg -q "$needle" <<<"$HTML"
done

Expected result: HTTP 200 and all four assertions succeed.

Add the boot-interface command family (show, candidates, set) introduced in NVIDIA#3341 to the boot/DPU guide's admin-cli reference table, and point to it from the troubleshooting section.

boot-interface set is the same SetPrimaryInterface operation as managed-host set-primary-interface; show and candidates are read-only views over the GetMachineBootInterfaces RPC that surface the predicted/managed/explored/retained stores the guide already documents.

Source PR reviewed: NVIDIA#3341
@copy-pr-bot

copy-pr-bot Bot commented Jul 16, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Walkthrough

The documentation adds two read-only admin CLI commands for inspecting boot-interface state and candidates, and updates troubleshooting guidance to use them for comparing stores and identifying discrepancies.

Changes

Boot interface inspection

Layer / File(s) Summary
Inspection commands and troubleshooting guidance
docs/provisioning/boot-interfaces-and-dpu-modes.md
Documents boot-interface show <machine-id> and boot-interface candidates <machine-id> for inspecting effective interfaces, store details, candidate NICs, selection picks, and store disagreements. Updates troubleshooting instructions to reference both commands.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly states the main change: documenting nico-admin-cli boot-interface commands.
Description check ✅ Passed The description matches the diff and explains the documented boot-interface commands and troubleshooting updates.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@kfelternv
kfelternv marked this pull request as ready for review July 16, 2026 17:22
@kfelternv
kfelternv requested a review from polarweasel as a code owner July 16, 2026 17:22
@github-actions

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown

🔍 Container Scan Summary

No Grype artifacts were found to aggregate.

@kfelternv kfelternv changed the title docs: Sync Fern docs for recent changes docs: Document nico-admin-cli boot-interface commands Jul 16, 2026
@kfelternv
kfelternv requested a review from chet July 17, 2026 01:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant