Skip to content

docs: add one-line expected machine add example#2627

Open
nvda-jake wants to merge 2 commits into
NVIDIA:mainfrom
nvda-jake:docs/expected-machine-add-one-liner
Open

docs: add one-line expected machine add example#2627
nvda-jake wants to merge 2 commits into
NVIDIA:mainfrom
nvda-jake:docs/expected-machine-add-one-liner

Conversation

@nvda-jake

Copy link
Copy Markdown

docs: add one-line expected machine add example

Summary

  • Updates docs/provisioning/ingesting-hosts.md in the "Add Expected Machines Table" section.
  • Adds a copy-pasteable one-line carbide-admin-cli expected-machine add example for adding a single expected machine.
  • Keeps the existing expected_machines.json / em replace-all workflow documented for full-table loads.
  • Clarifies that expected-machine add is for individual hosts and replace-all is for defining the complete table from JSON.

Testing

  • Docs-only change; no runtime tests run.

@nvda-jake nvda-jake requested a review from Coco-Ben as a code owner June 16, 2026 15:13
@copy-pr-bot

copy-pr-bot Bot commented Jun 16, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 7e7daf01-ba76-4ca6-8a9e-a81a08b988c8

📥 Commits

Reviewing files that changed from the base of the PR and between 335cda5 and b726037.

📒 Files selected for processing (1)
  • docs/provisioning/ingesting-hosts.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/provisioning/ingesting-hosts.md

Summary by CodeRabbit

  • Documentation
    • Updated the “Add Expected Machines” guide with a dedicated step for adding a single host, including an example expected-machine add command
    • Clarified ingestion eligibility guidance on when to use individual host updates versus replace-all for full expected-machines table replacement
    • Fixed formatting for the “Export” command example so the JSON snippet displays correctly

Walkthrough

Documentation update to ingesting-hosts.md adding an expected-machine add command example for single-host ingestion, clarifying the distinction between per-host add and bulk replace-all operations in the eligibility guidance, and correcting a code block boundary in the Export section.

Changes

Ingesting Hosts Documentation

Layer / File(s) Summary
Single-host add instruction and eligibility guidance
docs/provisioning/ingesting-hosts.md
Introduces a dedicated subsection with a concrete expected-machine add example command for individual host registration. Simultaneously refines the eligibility guidance to establish clear semantic boundaries: expected-machine add for incremental host additions versus replace-all when expected_machines.json is the authoritative source of truth for the complete table state.
Export section code block fix
docs/provisioning/ingesting-hosts.md
Corrects the code block boundary closure for the nico-admin-cli ... -f json em show output example in the Export section, ensuring syntactically precise documentation rendering.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the primary change: adding a one-line example for the expected-machine add command in the documentation.
Description check ✅ Passed The description is directly related to the changeset, providing clear context about the documentation updates to the ingesting-hosts.md file.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/ingesting-hosts.md`:
- Around line 146-150: The command in the bash example uses an incorrect binary
name and is missing the mandatory API URL flag. Replace carbide-admin-cli with
the correct binary name nico-admin-cli and add the required -c <api-url> flag
immediately after the binary name, before the expected-machine (or em)
subcommand. Refer to the canonical examples in
crates/admin-cli/src/expected_machines/add/args.rs to verify the correct syntax
structure where the API URL flag is positioned after the binary name.
🪄 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: 90e00ee3-8906-4c7e-9ffc-f36cf733c5ea

📥 Commits

Reviewing files that changed from the base of the PR and between ccd23ac and 2a0192e.

📒 Files selected for processing (1)
  • docs/provisioning/ingesting-hosts.md

Comment thread docs/provisioning/ingesting-hosts.md
Signed-off-by: Jake Bloom <jbloom@nvidia.com>
@nvda-jake nvda-jake force-pushed the docs/expected-machine-add-one-liner branch from 776d5a6 to 335cda5 Compare June 16, 2026 15:28
Comment thread docs/provisioning/ingesting-hosts.md Outdated
Signed-off-by: Jake Bloom <jbloom@nvidia.com>
@ianderson-nvidia

Copy link
Copy Markdown
Contributor

This is fine to add, but just as an FYI we auto-generate usage examples now - https://github.com/NVIDIA/infra-controller/blob/main/docs/manuals/nico-admin-cli/commands/expected-machine/expected-machine-add.md

@ianderson-nvidia

ianderson-nvidia commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

/ok to test b726037

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.

2 participants