docs: Rename infra-controller-core references to infra-controller#2357
docs: Rename infra-controller-core references to infra-controller#2357kfelternv wants to merge 4 commits into
Conversation
|
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. |
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/openapi/spec.yaml (1)
57-57: Make the Site config reference immutable (avoidmain+#L30fragility)The link in
docs/openapi/spec.yamlpoints atblob/main/...nico-api-site-config.toml#L30, which can drift as the file changes and the line anchor will break on edits. This repo checkout has nov*tags available to switch to, so the production-grade fix is to link to a specific immutable commit SHA (or at minimum remove the#L30anchor and link to the file without an anchor).🤖 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/openapi/spec.yaml` at line 57, The documentation link in docs/openapi/spec.yaml currently points to the live branch with a fragile line anchor ("nico-api-site-config.toml#L30"); update that reference to be immutable by replacing the blob/main URL with a blob/<commit-sha> URL that points to the exact commit containing nico-api-site-config.toml, or at minimum remove the "`#L30`" fragment so the link points to the file without a line anchor; ensure the sentence still references the "nico-api-site-config.toml" file.
🤖 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/rack_level_admin.md`:
- Line 133: The markdown link for the PATCH
/v2/org/{org}/carbide/rack/{id}/power entry points to the firmware-update-rack
doc but should point to the rack power control doc; update the link target in
the line containing "[PATCH /v2/org/{org}/carbide/rack/{id}/power]" so the URL
path/slug references the rack power control endpoint (replace the
"firmware-update-rack" slug with the correct power-control/rack-power slug), and
confirm the link text and supported states (`on`, `off`, `cycle`, `forceoff`,
`forcecycle`) remain accurate.
---
Nitpick comments:
In `@docs/openapi/spec.yaml`:
- Line 57: The documentation link in docs/openapi/spec.yaml currently points to
the live branch with a fragile line anchor ("nico-api-site-config.toml#L30");
update that reference to be immutable by replacing the blob/main URL with a
blob/<commit-sha> URL that points to the exact commit containing
nico-api-site-config.toml, or at minimum remove the "`#L30`" fragment so the link
points to the file without a line anchor; ensure the sentence still references
the "nico-api-site-config.toml" file.
🪄 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: a9fd9558-0cfe-48f1-8867-e2af973eb285
📒 Files selected for processing (22)
docs/README.mddocs/architecture/health_aggregation.mddocs/architecture/infiniband/nic_selection.mddocs/architecture/overview.mddocs/architecture/redfish_workflow.mddocs/configuration/tenant_management.mddocs/development.mddocs/development/vm_pxe_client.mddocs/getting-started/installation-options/day0-ip-network-config.mddocs/getting-started/installation-options/reference-install.mddocs/getting-started/quick-start.mddocs/index.mddocs/manuals/building_nico_containers.mddocs/manuals/nico-admin-cli.mddocs/manuals/nicocli-reference.mddocs/manuals/nvlink_partitioning.mddocs/manuals/rack_level_admin.mddocs/manuals/repair/overview.mddocs/openapi/getting_started.mddocs/openapi/spec.yamldocs/release-notes.mdhelm-prereqs/README.md
| - [GET /v2/org/{org}/carbide/rack/validation](https://docs.nvidia.com/infra-controller/rest-api-reference/api-reference/rack/validate-racks): Validate components of all racks in the specified site by comparing the expected inventory data to the actual inventory data. | ||
| - [GET /v2/org/{org}/carbide/rack/{rack_id}/validation](https://docs.nvidia.com/infra-controller/rest-api-reference/api-reference/rack/validate-rack): Validate components of the specified rack by comparing the expected inventory data to the actual inventory data. | ||
| - [PATCH /v2/org/{org}/carbide/rack/power](https://docs.nvidia.com/infra-controller/rest-api-reference/api-reference/rack/power-control-racks): Control power of all or selected racks in the site. Supported power states are `on`, `off`, `cycle`, `forceoff`, `forcecycle`. | ||
| - [PATCH /v2/org/{org}/carbide/rack/{id}/power](https://docs.nvidia.com/infra-controller/rest-api-reference/api-reference/rack/firmware-update-rack): Control power of the specified rack. Supported power states are `on`, `off`, `cycle`, `forceoff`, `forcecycle`. |
There was a problem hiding this comment.
Incorrect endpoint link for rack power control.
The link points to firmware-update-rack but the description states "Control power of the specified rack." This endpoint URL should reference the power control endpoint, not the firmware update endpoint.
🔧 Proposed fix
-- [PATCH /v2/org/{org}/carbide/rack/{id}/power](https://docs.nvidia.com/infra-controller/rest-api-reference/api-reference/rack/firmware-update-rack): Control power of the specified rack. Supported power states are `on`, `off`, `cycle`, `forceoff`, `forcecycle`.
+- [PATCH /v2/org/{org}/carbide/rack/{id}/power](https://docs.nvidia.com/infra-controller/rest-api-reference/api-reference/rack/power-control-rack): Control power of the specified rack. Supported power states are `on`, `off`, `cycle`, `forceoff`, `forcecycle`.🤖 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/rack_level_admin.md` at line 133, The markdown link for the
PATCH /v2/org/{org}/carbide/rack/{id}/power entry points to the
firmware-update-rack doc but should point to the rack power control doc; update
the link target in the line containing "[PATCH
/v2/org/{org}/carbide/rack/{id}/power]" so the URL path/slug references the rack
power control endpoint (replace the "firmware-update-rack" slug with the correct
power-control/rack-power slug), and confirm the link text and supported states
(`on`, `off`, `cycle`, `forceoff`, `forcecycle`) remain accurate.
🔐 TruffleHog Secret Scan✅ No secrets or credentials found! Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉 🕐 Last updated: 2026-06-10 08:38:55 UTC | Commit: 3aa7e8f |
🔍 Container Scan Summary
Per-CVE detail lives in the per-service |
thossain-nv
left a comment
thossain-nv
left a comment
There was a problem hiding this comment.
Looks good @kfelternv, adding a few more changes would make it more cohesive.
| | `NCX_IMAGE_REGISTRY` | **Yes** | Base image registry for all Infra Controller images (e.g. `my-registry.example.com/ncx`). Used for Infra Controller Core (`<registry>/nvmetal-nico`) and Infra Controller REST (`<registry>/nico-rest-*`). | | ||
| | `NCX_CORE_IMAGE_TAG` | **Yes** | Infra Controller Core (infra-controller-core) image tag (e.g. `v2025.12.30`). | | ||
| | `NCX_REST_IMAGE_TAG` | **Yes** | Infra Controller REST (infra-controller-rest) image tag (e.g. `v1.0.4`). | | ||
| | `NCX_CORE_IMAGE_TAG` | **Yes** | Infra Controller Core image tag (e.g. `v2025.12.30`). | |
There was a problem hiding this comment.
We should update these to match https://github.com/NVIDIA/infra-controller/blob/main/README.md
| nico-prereqs (this Helm chart - nico-system namespace) | ||
| NCX Core (../helm - ncx-core.yaml values) | ||
| NCX REST (ncx-infra-controller-rest/helm/charts/nico-rest) | ||
| NCX REST (rest-api/helm/charts/nico-rest) |
There was a problem hiding this comment.
Probably a good idea to switch these to NICo Core and NICo REST
|
🌿 Preview your docs: https://nvidia-preview-pull-request-2357.docs.buildwithfern.com/infra-controller |
4 participants
Resolves #1763 Updates documentation to match new unified monorepo