docs: clarify legacy k3s sandbox resources by glenn-agent · Pull Request #5506 · NVIDIA/NemoClaw

glenn-agent · 2026-06-16T07:55:56Z

Summary

Clarify that the embedded k3s Sandbox CRD path applies to legacy non-Docker-driver installations.
Document the sandboxes.agents.x-k8s.io custom resource and agent-sandbox-controller relationship.
Cross-link the same clarification in the shared host-alias command reference.
Merge current main without rewriting the contributor's verified commit, and let the shared-page generator produce the OpenClaw, Hermes, and Deep Agents variants.

Contributor credit

The original documentation change was authored by @glenn-agent.
The maintainer merge commits preserve that commit and credit Glenn-Agent with Co-authored-by: trailers.

Testing

npm run docs:sync-agent-variants
npm run docs
npx vitest run --project integration test/agent-variant-docs.test.ts test/sync-agent-variant-docs.test.ts test/internal-commands-docs.test.ts (20 tests passed)
npx prek run --from-ref origin/main --to-ref HEAD
npx prek run --hook-stage pre-push --all-files

Signed-off-by: Glenn-Agent glenn_agent@163.com

Summary by CodeRabbit

Documentation
- Expanded deployment topology docs with clearer guidance for legacy Kubernetes-based installs, including how sandboxes are represented and reconciled in the cluster.
- Added an example verification flow so users can check sandbox status and confirm the related pod ownership.
- Updated the hosts-add command docs with a note explaining the legacy gateway topology and its embedded Kubernetes setup.

Signed-off-by: Glenn-Agent <glenn_agent@163.com>

copy-pr-bot · 2026-06-16T07:55:59Z

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 · 2026-06-16T07:56:25Z

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: e835492d-0788-4481-82d6-0a5b9320ade2

📥 Commits

Reviewing files that changed from the base of the PR and between 0fc7bd7 and 59ef317.

📒 Files selected for processing (1)

docs/reference/commands.mdx

✅ Files skipped from review due to trivial changes (1)

docs/reference/commands.mdx

📝 Walkthrough

Walkthrough

This PR expands the legacy k3s gateway documentation in the architecture and commands references, describing the embedded k3s cluster, the sandboxes.agents.x-k8s.io CRD, and agent-sandbox-controller reconciliation.

Changes

Legacy k3s Topology Documentation

Layer / File(s)	Summary
Legacy k3s topology in architecture and command references `docs/reference/architecture.mdx`, `docs/reference/commands.mdx`	Expands the architecture doc’s legacy gateway note into a detailed k3s topology description with `kubectl` verification examples, and adds a matching sentence to the `hosts-add` command description.

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

Suggested reviewers: jyaunches, cv

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the docs-only change to clarify legacy k3s sandbox resources.
Linked Issues check	✅ Passed	The docs now explain the sandboxes.agents.x-k8s.io CRD, Sandbox-to-pod reconciliation, and the legacy embedded k3s path requested in `#2423`.
Out of Scope Changes check	✅ Passed	The changes stay within documentation and directly support the requested Kubernetes sandbox clarification.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

wscurran · 2026-06-23T15:35:15Z

✨ Thanks for clarifying the embedded k3s Sandbox CRD path for legacy non-Docker-driver installs. This proposes a way to document the sandboxes.agents.x-k8s.io custom resource and controller relationship while cross-linking the clarification in host-alias command references.

Related open issues:

#2423 NemoClaw doc related to K8s not present

Merge current main without rewriting contributor history, retain the legacy k3s and Sandbox CRD clarification in the canonical source pages, and let the shared-page generator produce agent variants. Co-authored-by: Glenn-Agent <glenn_agent@163.com> Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>

apurvvkumaria · 2026-07-08T21:59:50Z

Maintainer salvage is now pushed at 0fc7bd7ac.

Preserved @glenn-agent's original verified commit and merged current main without rebasing or force-pushing.
Retained the legacy k3s, sandboxes.agents.x-k8s.io, and agent-sandbox-controller clarification in the canonical architecture.mdx and shared commands.mdx sources.
Removed the obsolete tracked Hermes copy from the PR resolution; the current generator now produces all agent variants from the shared source.
Added Co-authored-by: Glenn-Agent <glenn_agent@163.com> to the signed maintainer merge commit so the original author remains explicitly credited.

Validation completed:

docs variant sync passed;
full docs validation passed with 0 errors and the 2 existing warnings;
focused agent-variant and command-reference tests passed, 20/20;
scoped hooks and all pre-push type checks passed;
both commits are verified by GitHub.

All exact-head workflows have been approved and are running. @coderabbitai review

coderabbitai · 2026-07-08T22:00:07Z

@apurvvkumaria Thanks for the update and for preserving attribution to the original author. I'll review the latest commit at 0fc7bd7ac now.

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

apurvvkumaria · 2026-07-08T22:04:49Z

Exact-head follow-up for 0fc7bd7ac:

all 31 reported checks are green;
CodeRabbit completed and there are no unresolved review threads;
PR Review Advisor and E2E Advisor correctly skipped this docs-only change;
contributor DCO and both GitHub-verified commits pass;
GitHub reports the branch as mergeable.

The maintainer gate is blocked only because mergeStateStatus is BLOCKED while reviewDecision is REVIEW_REQUIRED. No merge was performed; the PR is ready for independent human approval.

Merge the newly advanced main branch without rewriting the contributor's verified history while retaining the canonical legacy k3s and Sandbox CRD documentation. Co-authored-by: Glenn-Agent <glenn_agent@163.com> Signed-off-by: Apurv Kumaria <akumaria@nvidia.com>

apurvvkumaria · 2026-07-08T22:07:56Z

main advanced after the first exact-head CI pass, so the contributor branch is now synchronized again at eec72810e.

The update is another signed, non-rebase merge with Co-authored-by: Glenn-Agent <glenn_agent@163.com>.
The PR still differs from current main only in docs/reference/architecture.mdx and the shared docs/reference/commands.mdx source.
Docs validation passed again with 0 errors and the 2 existing warnings.
The focused tests passed again, 20/20, and scoped plus pre-push hooks passed.
GitHub marks the new merge commit as verified.

All exact-head workflows have been approved. @coderabbitai review

coderabbitai · 2026-07-08T22:08:08Z

@apurvvkumaria Understood — I'll review the latest synchronized commit at eec72810e now.

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

apurvvkumaria · 2026-07-08T22:13:04Z

Final exact-head status for eec72810e:

synchronized with current main at fed460434;
all 29 reported checks are green, with no pending or failing checks;
CodeRabbit completed and there are no unresolved review threads;
contributor DCO passes and all three commits are GitHub-verified;
the PR retains v0.0.79 and was not tagged for v0.0.78.

The final maintainer gate is blocked only because GitHub reports mergeStateStatus: BLOCKED with reviewDecision: REVIEW_REQUIRED. No merge was performed; this is ready for independent human approval.

cv

Exact-head independent review at eec7281 is clean. The legacy k3s, sandboxes.agents.x-k8s.io, openshell namespace, controller, and pod ownership claims match current NemoClaw behavior, pinned OpenShell definitions, and the linked live evidence. The diff is docs-only; all 29 checks are green, CodeRabbit has no unresolved findings, DCO passes, and all commits are Verified. The BLOCKED merge state is the independent-review requirement, not a conflict.

Signed-off-by: Carlos Villela <cvillela@nvidia.com>

## Summary Adds the pre-tag v0.0.79 release notes entry to `docs/about/release-notes.mdx` so the release plan can be generated after docs merge. The entry summarizes the merged v0.0.79 release train across inference, diagnostics, runtime hardening, policies, onboarding recovery, and release validation. ## Changes - Added the v0.0.79 release notes section with linked follow-up documentation for OpenRouter onboarding, managed vLLM changes, completion and logging, Deep Agents runtime limits, policy updates, onboarding recovery, and release validation. - Source summary: - #6461 -> `docs/about/release-notes.mdx`: Documents OpenRouter onboarding support and links to inference/provider references. - #6271 and #6272 -> `docs/about/release-notes.mdx`: Documents shell completion and structured logging highlights. - #6465, #6539, #6570, and #6528 -> `docs/about/release-notes.mdx`: Documents status route-drift, orphaned sandbox, gateway cleanup, and DGX Spark express-install diagnostics. - #6523, #6551, #6484, #6488, #6324, and #6542 -> `docs/about/release-notes.mdx`: Documents managed vLLM, Qwen3.6 tool parser, compaction, and timeout/readiness improvements. - #6559, #6538, #6560, #6568, #6552, #6567, and #6587 -> `docs/about/release-notes.mdx`: Documents runtime, credential, proxy, PID namespace, TOML, and provider-state hardening. - #6541, #5415, #6246, #6496, and #6573 -> `docs/about/release-notes.mdx`: Documents GitHub policy, Gmail policy, MCP allowlist, WhatsApp, and messaging-variant updates. - #6253, #6572, #6444, #6536, and #5860 -> `docs/about/release-notes.mdx`: Documents onboarding resume and create-step recovery improvements. - #6508, #6527, #5506, #6588, #6446, #6447, #6582, #6296, #6367, #6397, and #6505 -> `docs/about/release-notes.mdx`: Documents docs, release-risk, and E2E validation updates. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates  - [ ] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [x] Tests not applicable — justification: Release-note prose only. - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Verification  - [x] PR description includes the DCO sign-off declaration and every commit appears as `Verified` in GitHub - [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or `npm run check:diff` passed when hooks were skipped or unavailable - [x] Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: Tests not applicable, release-note prose only. - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — command/result: - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) Docs validation note: `npm run docs:check-agent-variants && npm run docs:check-routes && git diff --check` passed. Full `npm run docs` is currently blocked before Fern validation because the pinned `fern-api@5.65.2` package is unavailable from npm (`ETARGET No matching version found`). ---  Signed-off-by: Julie Yaunches <jyaunches@nvidia.com>  ## Summary by CodeRabbit * **Documentation** * Added release notes for v0.0.79 with a new summary of recent improvements, including onboarding and inference options, operator/CLI diagnostics, sandbox recovery hardening, runtime limits, network policy behavior, and release validation updates. * Added updated references and links for the latest release.

@glenn-agent

## Summary - Clarify that the embedded k3s `Sandbox` CRD path applies to legacy non-Docker-driver installations. - Document the `sandboxes.agents.x-k8s.io` custom resource and `agent-sandbox-controller` relationship. - Cross-link the same clarification in the shared host-alias command reference. - Merge current `main` without rewriting the contributor's verified commit, and let the shared-page generator produce the OpenClaw, Hermes, and Deep Agents variants. Fixes NVIDIA#2423 ## Contributor credit The original documentation change was authored by @glenn-agent. The maintainer merge commits preserve that commit and credit Glenn-Agent with `Co-authored-by:` trailers. ## Testing - `npm run docs:sync-agent-variants` - `npm run docs` - `npx vitest run --project integration test/agent-variant-docs.test.ts test/sync-agent-variant-docs.test.ts test/internal-commands-docs.test.ts` (20 tests passed) - `npx prek run --from-ref origin/main --to-ref HEAD` - `npx prek run --hook-stage pre-push --all-files` Signed-off-by: Glenn-Agent <glenn_agent@163.com>  ## Summary by CodeRabbit * **Documentation** * Expanded deployment topology docs with clearer guidance for legacy Kubernetes-based installs, including how sandboxes are represented and reconciled in the cluster. * Added an example verification flow so users can check sandbox status and confirm the related pod ownership. * Updated the `hosts-add` command docs with a note explaining the legacy gateway topology and its embedded Kubernetes setup.  Signed-off-by: Glenn-Agent <glenn_agent@163.com> Signed-off-by: Apurv Kumaria <akumaria@nvidia.com> Signed-off-by: Carlos Villela <cvillela@nvidia.com> Co-authored-by: Apurv Kumaria <akumaria@nvidia.com> Co-authored-by: Carlos Villela <cvillela@nvidia.com>

## Summary Adds the pre-tag v0.0.79 release notes entry to `docs/about/release-notes.mdx` so the release plan can be generated after docs merge. The entry summarizes the merged v0.0.79 release train across inference, diagnostics, runtime hardening, policies, onboarding recovery, and release validation. ## Changes - Added the v0.0.79 release notes section with linked follow-up documentation for OpenRouter onboarding, managed vLLM changes, completion and logging, Deep Agents runtime limits, policy updates, onboarding recovery, and release validation. - Source summary: - NVIDIA#6461 -> `docs/about/release-notes.mdx`: Documents OpenRouter onboarding support and links to inference/provider references. - NVIDIA#6271 and NVIDIA#6272 -> `docs/about/release-notes.mdx`: Documents shell completion and structured logging highlights. - NVIDIA#6465, NVIDIA#6539, NVIDIA#6570, and NVIDIA#6528 -> `docs/about/release-notes.mdx`: Documents status route-drift, orphaned sandbox, gateway cleanup, and DGX Spark express-install diagnostics. - NVIDIA#6523, NVIDIA#6551, NVIDIA#6484, NVIDIA#6488, NVIDIA#6324, and NVIDIA#6542 -> `docs/about/release-notes.mdx`: Documents managed vLLM, Qwen3.6 tool parser, compaction, and timeout/readiness improvements. - NVIDIA#6559, NVIDIA#6538, NVIDIA#6560, NVIDIA#6568, NVIDIA#6552, NVIDIA#6567, and NVIDIA#6587 -> `docs/about/release-notes.mdx`: Documents runtime, credential, proxy, PID namespace, TOML, and provider-state hardening. - NVIDIA#6541, NVIDIA#5415, NVIDIA#6246, NVIDIA#6496, and NVIDIA#6573 -> `docs/about/release-notes.mdx`: Documents GitHub policy, Gmail policy, MCP allowlist, WhatsApp, and messaging-variant updates. - NVIDIA#6253, NVIDIA#6572, NVIDIA#6444, NVIDIA#6536, and NVIDIA#5860 -> `docs/about/release-notes.mdx`: Documents onboarding resume and create-step recovery improvements. - NVIDIA#6508, NVIDIA#6527, NVIDIA#5506, NVIDIA#6588, NVIDIA#6446, NVIDIA#6447, NVIDIA#6582, NVIDIA#6296, NVIDIA#6367, NVIDIA#6397, and NVIDIA#6505 -> `docs/about/release-notes.mdx`: Documents docs, release-risk, and E2E validation updates. ## Type of Change - [ ] Code change (feature, bug fix, or refactor) - [ ] Code change with doc updates - [x] Doc only (prose changes, no code sample modifications) - [ ] Doc only (includes code sample changes) ## Quality Gates  - [ ] Tests added or updated for changed behavior - [ ] Existing tests cover changed behavior — justification: - [x] Tests not applicable — justification: Release-note prose only. - [x] Docs updated for user-facing behavior changes - [ ] Docs not applicable — justification: - [ ] Sensitive paths changed (security, policy, credentials, preflight, onboarding, inference, runner, sandbox, or messaging) - [ ] Sensitive-path review completed or maintainer-approved waiver recorded — reviewer/approval link/justification: - [ ] Non-success, skipped, or missing CI check accepted by maintainer — check name, approval link, and follow-up issue: ## Verification  - [x] PR description includes the DCO sign-off declaration and every commit appears as `Verified` in GitHub - [x] Normal `pre-commit`, `commit-msg`, and `pre-push` hooks passed, or `npm run check:diff` passed when hooks were skipped or unavailable - [x] Targeted behavior tests pass for the current change set, or tests are marked not applicable above — command/result or justification: Tests not applicable, release-note prose only. - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — command/result: - [x] Quality Gates section completed with required justifications or waivers - [x] No secrets, API keys, or credentials committed - [ ] `npm run docs` builds without warnings (doc changes only) - [x] Doc pages follow the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md) (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) Docs validation note: `npm run docs:check-agent-variants && npm run docs:check-routes && git diff --check` passed. Full `npm run docs` is currently blocked before Fern validation because the pinned `fern-api@5.65.2` package is unavailable from npm (`ETARGET No matching version found`). ---  Signed-off-by: Julie Yaunches <jyaunches@nvidia.com>  ## Summary by CodeRabbit * **Documentation** * Added release notes for v0.0.79 with a new summary of recent improvements, including onboarding and inference options, operator/CLI diagnostics, sandbox recovery hardening, runtime limits, network policy behavior, and release validation updates. * Added updated references and links for the latest release.

docs: clarify legacy k3s sandbox resources

8ee4c4f

Signed-off-by: Glenn-Agent <glenn_agent@163.com>

wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance labels Jun 23, 2026

This was referenced Jul 3, 2026

fix(onboard): diagnose incomplete custom plugin images #6250

Closed

docs: add deepagents doc variant #6344

Merged

docs: define lifecycle and plugin taxonomy #6498

Closed

apurvvkumaria added the v0.0.79 label Jul 8, 2026

apurvvkumaria self-assigned this Jul 8, 2026

cv approved these changes Jul 9, 2026

View reviewed changes

merge(main): sync PR NVIDIA#5506 with latest main

59ef317

Signed-off-by: Carlos Villela <cvillela@nvidia.com>

apurvvkumaria merged commit 48e4967 into NVIDIA:main Jul 9, 2026
30 of 32 checks passed

jyaunches mentioned this pull request Jul 9, 2026

docs: prepare v0.0.79 release notes #6594

Merged

21 tasks

Navigation Menu

Uh oh!

docs: clarify legacy k3s sandbox resources - #5506

docs: clarify legacy k3s sandbox resources#5506
apurvvkumaria merged 4 commits into
NVIDIA:mainfrom
glenn-agent:docs/legacy-k3s-crd-2423

glenn-agent commented Jun 16, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

copy-pr-bot Bot commented Jun 16, 2026

Uh oh!

coderabbitai Bot commented Jun 16, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

wscurran commented Jun 23, 2026

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

coderabbitai Bot commented Jul 8, 2026 •

edited

Loading

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

coderabbitai Bot commented Jul 8, 2026 •

edited

Loading

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

cv left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

glenn-agent commented Jun 16, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Contributor credit

Testing

Summary by CodeRabbit

Uh oh!

copy-pr-bot Bot commented Jun 16, 2026

Uh oh!

coderabbitai Bot commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

wscurran commented Jun 23, 2026

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

coderabbitai Bot commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

coderabbitai Bot commented Jul 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apurvvkumaria commented Jul 8, 2026

Uh oh!

cv left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

glenn-agent commented Jun 16, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jun 16, 2026 •

edited

Loading

coderabbitai Bot commented Jul 8, 2026 •

edited

Loading

coderabbitai Bot commented Jul 8, 2026 •

edited

Loading