docs: Sync Fern docs for recent changes#3306
Conversation
PR NVIDIA#3143 added a 'network-segment create' subcommand to nico-admin-cli. Update the Flat VPC / zero-DPU guide, which previously stated no such subcommand existed and that runtime segment creation required calling the CreateNetworkSegment gRPC endpoint directly.
|
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. |
WalkthroughThe VPC manual now documents ChangesHostInband Runtime Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3306.docs.buildwithfern.com/infra-controller |
🔍 Container Scan SummaryNo Grype artifacts were found to aggregate. |
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`:
- Line 75: The “Create an additional HostInband segment after Day 0” row in the
runtime-only table is mixing a restart-based path with a post-Day-0 workflow.
Update the markdown so the `TOML ([networks]) + API restart` option is moved
back to the Day-0 section or removed from this row, and keep only the
runtime-safe `nico-admin-cli` path here. Check the surrounding HostInband
segment guidance and the “Configuring HostInband Network Segments” reference to
keep the table consistent.
- Around line 200-206: The HostInband CLI description makes --gateway sound
required, but the command only enforces --subdomain-id and treats --gateway as
optional. Update the nico-admin-cli network-segment create wording to describe
--gateway as conditional/optional for HostInband segments, and keep the rest of
the flag guidance aligned with the command contract and help text.
🪄 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: c344b1c0-e499-44e3-befe-6d200980da6e
📒 Files selected for processing (1)
docs/manuals/vpc/flat_vpcs_zero_dpu.md
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a26f7d1803
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
What this PR does
Correct
docs/manuals/vpc/flat_vpcs_zero_dpu.mdto reflect thenico-admin-cli network-segment createsubcommand. The guide previously statedthat no such subcommand existed and that runtime
HostInbandsegment creationrequired calling the
CreateNetworkSegmentgRPC endpoint directly.The updated page now gives operators the real CLI command and the required
host-inbandinputs.Source PRs reviewed
Reviewed the 80 PRs merged in
NVIDIA/infra-controllerbetween 2026-07-02 and2026-07-09. This docs change is driven by:
feat(cli): Support network segment creation from CLI(addsnetwork-segment create).Considered but not requiring a docs edit here: #3145 (
vpc createon the adminCLI; the guide's
nicoclicoverage-gap note is about the tenant REST wrapper,not the admin CLI) and #3150 (REST endpoint restructure; the OpenAPI spec is
regenerated in-PR and no prose docs reference the old routes).
How we verified it
Tested revision
cdd338a5a2a2f119e5aaeb401d5e3980a3a03421from a cleancheckout on macOS 26.5.1 arm64 with the repository-pinned Rust 1.96.0 toolchain
and Node.js 25.5.0.
Hands-on verification:
cargo run --package nico-admin-cli -- network-segment create --help.The real help output listed
host-inbandas a--segment-typevalue,showed
--gatewayas optional, and exposed--name,--prefix, and--subdomain-id. The command's runtime dispatch requires the global--cloud-unsafe-opacknowledgment, whose help explicitly warns againstproduction use.
fern-api@4.81.0package. The changed page returned HTTP 200 and renderedthe restart-applied TOML/runtime CLI distinction, the required
--cloud-unsafe-op=<username>warning, conditional--gatewayguidance,and the
2-configuring-hostinband-network-segmentssection anchor. Thestale "no create command" and mandatory-gateway wording were absent.
Supporting checks:
fern check: 0 errors.rumdl0.2.29 reported the same seven pre-existing MD040/MD029 findings onboth
origin/mainand the PR revision; the edited region added no finding.git diff --check origin/main...HEAD: passed.fern docs broken-links --strictstill reports 27 pre-existing errors inother pages; none are in the changed Flat VPC page.
How to reproduce the verification
Prerequisites: macOS arm64, Rustup, Node.js/npm, and
rg.git clone https://github.com/kfelternv/infra-controller.git cd infra-controller git checkout cdd338a5a2a2f119e5aaeb401d5e3980a3a03421 CARGO_TERM_COLOR=never NO_COLOR=1 \ cargo run --package nico-admin-cli -- network-segment create --helpExpected CLI checkpoints:
--segment-typelistshost-inband.--name,--prefix,--gateway, and--subdomain-id;--gatewayis not part of the required usage set.nico-admin-cli --helpdocuments--cloud-unsafe-op <USERNAME>and itsnon-production warning.
Validate and render the documentation:
In another shell:
Expected result: HTTP 200 and one match from each content check.
Risk / notes
docs/playbooks/force_delete.mdstill usesthe old
-cAPI-URL flag in one example; docs: correct nico-admin-cli API URL flag from -c to -a #3114 renamed it to-aeverywhereelse. A separate one-line fix.