docs: consolidate remote deployment on headless servers#7346
Conversation
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
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. |
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughChangesThe PR adds an end-to-end headless server deployment guide, exposes it for OpenClaw, Deep Agents, and Hermes, retires Brev deployment documentation, adds redirects, and introduces route and content-contract tests. Headless deployment
Estimated code review effort: 4 (Complex) | ~45 minutes Sequence Diagram(s)sequenceDiagram
participant Operator
participant SSHServer
participant Installer
participant OpenShell
Operator->>SSHServer: Connect over SSH
Operator->>Installer: Run unattended onboarding
Installer->>OpenShell: Create and configure sandbox
OpenShell-->>Operator: Return readiness and probe results
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
🌿 Preview your docs: https://nvidia-preview-pr-7346.docs.buildwithfern.com/nemoclaw |
Code Coverage OverviewLanguages: TypeScript TypeScript / code-coverage/pluginThe overall coverage in commit 79e13ca in the TypeScript / code-coverage/cliThe overall coverage in commit 79e13ca in the Show a code coverage summary of the most impacted files.
Updated |
PR Review Advisor — InformationalAdvisor assessment: Informational / high confidence Model lanes
Nemotron output stays in workflow artifacts and does not change the assessment above. Since last review: 0 prior items resolved · 0 still apply · 0 new items found E2E guidanceAdvisory only. E2E / PR Gate selects and runs jobs independently. Recommended E2E: 2 optional E2E recommendations
This automated review informs maintainers. Warnings and suggestions do not require a response. A maintainer decides whether to merge. |
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
miyoungc
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
test/headless-server-docs.test.ts (1)
102-106: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAssert the published contract instead of source-file deletion.
These
existsSyncchecks couple the regression test to specific MDX filenames. Assert that the retired published routes are absent or redirect correctly instead, so harmless source reorganization does not break the test and stale routes cannot escape coverage. As per path instructions, tests should review behavioral confidence rather than implementation lock-in.🤖 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 `@test/headless-server-docs.test.ts` around lines 102 - 106, Replace the filename-based existsSync assertions in the affected test with requests against the published documentation routes formerly represented by those MDX files. Assert that each retired route is absent or redirects correctly, preserving coverage for stale routes without coupling the test to source filenames.Source: Path instructions
🤖 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.
Nitpick comments:
In `@test/headless-server-docs.test.ts`:
- Around line 102-106: Replace the filename-based existsSync assertions in the
affected test with requests against the published documentation routes formerly
represented by those MDX files. Assert that each retired route is absent or
redirects correctly, preserving coverage for stale routes without coupling the
test to source filenames.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: b6992041-7fa5-471b-9d16-8cd2d38bb360
📒 Files selected for processing (17)
ci/platform-matrix.jsondocs/about/overview.mdxdocs/changelog/2026-07-08.mdxdocs/deployment/brev-web-ui.mdxdocs/deployment/deploy-to-headless-server.mdxdocs/deployment/deploy-to-remote-gpu.mdxdocs/get-started/quickstart.mdxdocs/index.ymldocs/network-policy/approve-network-requests.mdxdocs/reference/commands.mdxdocs/reference/enterprise-readiness.mdxdocs/reference/platform-support.mdxdocs/reference/troubleshooting.mdxfern/docs.ymlscripts/check-docs-published-routes.mtstest/check-docs-published-routes.test.tstest/headless-server-docs.test.ts
💤 Files with no reviewable changes (4)
- docs/deployment/brev-web-ui.mdx
- docs/index.yml
- docs/deployment/deploy-to-remote-gpu.mdx
- docs/deployment/deploy-to-headless-server.mdx
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
There was a problem hiding this comment.
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 `@test/headless-server-docs.test.ts`:
- Around line 15-18: Update the section extraction around unattendedGuide to
validate that both heading indexes are found and that the end index is greater
than the start index before calling slice. Make the test fail immediately when
either anchor is missing or the section order is invalid, while preserving the
existing slicing behavior for valid documentation.
🪄 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: 55cb3626-3ea8-4eca-b196-d59b55d44d89
📒 Files selected for processing (2)
docs/deployment/deploy-to-headless-server.mdxtest/headless-server-docs.test.ts
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/deployment/deploy-to-headless-server.mdx
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
|
@coderabbitai review |
✅ Action performedReview finished.
|
Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
cjagwani
left a comment
cjagwani
left a comment
There was a problem hiding this comment.
Approved after refreshing onto the current base and re-running the full exact-revision gate. The accepted #7180 scope is preserved: provider-neutral headless deployment guidance replaces the retired Brev-specific flow, legacy routes redirect directly, copyable commands match supported CLI behavior, and focused route/content contracts protect the migration. All 53 current checks are green, both advisor lanes report no findings, contributor compliance passes, and no unresolved correctness or security concerns remain.
<!-- markdownlint-disable MD041 --> ## Summary Adds the canonical `## v0.0.92` release entry to `docs/changelog/2026-07-22.mdx` before the release plan is generated. The entry summarizes all ten pull requests merged after v0.0.91, including the OpenClaw security update and Jaeger runtime regression coverage. ## Changes - Added the canonical v0.0.92 changelog entry. - Recorded the user-visible, security, documentation, CI, and test changes in the release range. - #7280 -> `docs/changelog/2026-07-22.mdx`: OpenClaw 2026.7.1 and Node.js 22.23.1 security/runtime update. - #7378 -> `docs/changelog/2026-07-22.mdx`: canonical macOS watcher path validation. - #7379 -> `docs/changelog/2026-07-22.mdx`: stabilized full WSL platform validation. - #7380 -> `docs/changelog/2026-07-22.mdx`: bounded swap for hosted Hermes image exports. - #7100 -> `docs/changelog/2026-07-22.mdx`: semantic progress phases for live E2E tests. - #7376 -> `docs/changelog/2026-07-22.mdx`: restored v0.0.91 changelog history and corrected tagged guidance. - #7374 -> `docs/changelog/2026-07-22.mdx`: reviewed Homebrew formula transition for installer integrity checks. - #7346 -> `docs/changelog/2026-07-22.mdx`: provider-neutral headless server deployment guidance. - #7381 -> `docs/changelog/2026-07-22.mdx`: stabilized Hermes guard timing and WSL ownership fixtures. - #7339 -> `docs/changelog/2026-07-22.mdx`: real-artifact Jaeger header remediation regression coverage. ## 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 - [x] Existing tests cover changed behavior — justification: `test/changelog-docs.test.ts` validates the canonical dated changelog and release heading contract. - [ ] Tests not applicable — justification: - [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: ## DGX Station Hardware Evidence - [ ] Tested on DGX Station - Tested commit: Not applicable - Station profile/scenario: Not applicable - Result: Not applicable - Supporting evidence: Not applicable ## Verification - [x] PR description includes a `Signed-off-by:` line 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 — `npx vitest run test/changelog-docs.test.ts` passed 6/6 tests. - [ ] Applicable broad gate passed — `npm test` for broad runtime/test-harness changes; `npm run check` for repo-wide validation/coverage changes — command/result: Not applicable to a changelog-only change. - [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) — passed with 0 errors and 2 pre-existing Fern warnings. - [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) --- Signed-off-by: Carlos Villela <cvillela@nvidia.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added `v0.0.92` release notes covering sandboxing updates (OpenClaw/Node.js bumps, integrity pinning remediation, mcporter handling, and upgrade validation). * Updated deployment guidance for provider-neutral headless installs, and improved live E2E test reporting plus phase-plan validation. * Tightened installer integrity-check messaging during an OpenShell Homebrew transition and expanded platform/image validation (including macOS/WSL timing) and hosted image export behavior. * Restored the previously missed `v0.0.91` changelog entry and release validation guidance. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Carlos Villela <cvillela@nvidia.com>
3 participants
Summary
Add one provider-neutral guide for running NemoClaw on a headless Linux server over SSH.
Retire the outdated Brev deployment and web UI guides, and redirect their published URLs directly to the shared headless-server guide.
Related Issue
Fixes #7180
Changes
nemoclaw deploycompatibility command.Type of Change
Quality Gates
DGX Station Hardware Evidence
Verification
Signed-off-by:line and every commit appears asVerifiedin GitHubpre-commit,commit-msg, andpre-pushhooks passednpx vitest run test/headless-server-docs.test.ts test/check-docs-published-routes.test.ts test/check-docs-links.test.ts test/generate-platform-docs.test.ts src/lib/gateway-token-command.test.ts(86 passed)npm run docsbuilds — 0 errors and one existing Fern warningcloud-onboardE2E passed on the final commit — workflow runSigned-off-by: Miyoung Choi miyoungc@nvidia.com
Summary by CodeRabbit