docs(reference): document remote-deploy env vars#3349
docs(reference): document remote-deploy env vars#3349latenighthackathon wants to merge 1 commit into
Conversation
|
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:
📝 WalkthroughWalkthroughThis PR adds a "Remote Deployment" subsection to environment variables, documenting four Brev-specific seed variables— ChangesRemote Deployment Environment Variables
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
✨ Thanks for submitting this detailed PR to document remote-deploy env vars. This change aims to improve the accuracy of the documentation by adding a new subsection for remote deployment environment variables. Related open issues: |
6e94778 to
2c26d64
Compare
5930b8b to
96fe544
Compare
Add a `### Remote Deployment` subsection covering the four env vars read in `src/lib/deploy.ts` for the `nemoclaw deploy` / `nemoclaw onboard --remote` flow: - `NEMOCLAW_BREV_PROVIDER` (default `gcp`) - `NEMOCLAW_GPU` (default `a2-highgpu-1g:nvidia-tesla-a100:1`) - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each had a flag equivalent on `deploy` but no doc entry, so non-interactive remote provisioning users could not discover them from the docs portal. Defaults verified against `src/lib/deploy.ts:296-303`. Mirrored to the nemoclaw-user-reference skill. Follow-up to NVIDIA#3184; the env-var doc-drift gate still passes since these vars are read via a destructured `env.NEMOCLAW_*` local that the AST extractor does not currently flag. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
50938d9 to
f107870
Compare
|
Closing in favor of #4166 which is rebuilt cleanly on current upstream/main with the same content. Cheers! |
Add a "Remote Deployment" subsection under Environment Variables in `docs/reference/commands.mdx` covering the four env vars that seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`: - `NEMOCLAW_BREV_PROVIDER` - `NEMOCLAW_GPU` - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each entry covers the default, the effect, and notes that flag equivalents on `deploy` take precedence when non-interactive runs need to skip prompts. The provider/GPU pair cross-links to the existing `Deploy to Remote GPU` narrative for full how-to coverage. The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` is regenerated by `scripts/docs-to-skills.py` so the skill stays in sync with the user-facing docs. This is a fresh recreation of the closed NVIDIA#3349. The original branch was opened against the legacy `.md` docs layout before the Fern MDX migration (NVIDIA#3837) and accumulated 10 commits of upstream churn on `commands.mdx`; rebuilt cleanly on top of current upstream/main as a single signed commit. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
Add a "Remote Deployment" subsection under Environment Variables in `docs/reference/commands.mdx` covering the four env vars that seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`: - `NEMOCLAW_BREV_PROVIDER` - `NEMOCLAW_GPU` - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each entry covers the default, the effect, and notes that flag equivalents on `deploy` take precedence when non-interactive runs need to skip prompts. The provider/GPU pair cross-links to the existing `Deploy to Remote GPU` narrative for full how-to coverage. The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` is regenerated by `scripts/docs-to-skills.py` so the skill stays in sync with the user-facing docs. This is a fresh recreation of the closed NVIDIA#3349. The original branch was opened against the legacy `.md` docs layout before the Fern MDX migration (NVIDIA#3837) and accumulated 10 commits of upstream churn on `commands.mdx`; rebuilt cleanly on top of current upstream/main as a single signed commit. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
Add a "Remote Deployment" subsection under Environment Variables in `docs/reference/commands.mdx` covering the four env vars that seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`: - `NEMOCLAW_BREV_PROVIDER` - `NEMOCLAW_GPU` - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each entry covers the default, the effect, and notes that flag equivalents on `deploy` take precedence when non-interactive runs need to skip prompts. The provider/GPU pair cross-links to the existing `Deploy to Remote GPU` narrative for full how-to coverage. The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` is regenerated by `scripts/docs-to-skills.py` so the skill stays in sync with the user-facing docs. This is a fresh recreation of the closed NVIDIA#3349. The original branch was opened against the legacy `.md` docs layout before the Fern MDX migration (NVIDIA#3837) and accumulated 10 commits of upstream churn on `commands.mdx`; rebuilt cleanly on top of current upstream/main as a single signed commit. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
Add a "Remote Deployment" subsection under Environment Variables in `docs/reference/commands.mdx` covering the four env vars that seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`: - `NEMOCLAW_BREV_PROVIDER` - `NEMOCLAW_GPU` - `NEMOCLAW_DEPLOY_NO_CONNECT` - `NEMOCLAW_DEPLOY_NO_START_SERVICES` Each entry covers the default, the effect, and notes that flag equivalents on `deploy` take precedence when non-interactive runs need to skip prompts. The provider/GPU pair cross-links to the existing `Deploy to Remote GPU` narrative for full how-to coverage. The mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` is regenerated by `scripts/docs-to-skills.py` so the skill stays in sync with the user-facing docs. This is a fresh recreation of the closed NVIDIA#3349. The original branch was opened against the legacy `.md` docs layout before the Fern MDX migration (NVIDIA#3837) and accumulated 10 commits of upstream churn on `commands.mdx`; rebuilt cleanly on top of current upstream/main as a single signed commit. Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com>
## Summary Add a "Remote Deployment" subsection under Environment Variables in `docs/reference/commands.mdx` covering the four env vars that seed defaults for `nemoclaw deploy` and `nemoclaw onboard --remote`. ## Related Issue Closes #3059. ## Problem The env-var reference table lists `NEMOCLAW_*` flag defaults for many existing commands but omits the remote-deploy path. Discovering the seed-value env vars for a non-interactive Brev deployment currently requires reading source, since the docs say nothing about them. ## Changes - Add a `### Remote Deployment` subsection just before `## NemoHermes Alias` documenting `NEMOCLAW_BREV_PROVIDER` (default `gcp`), `NEMOCLAW_GPU` (default `a2-highgpu-1g:nvidia-tesla-a100:1`), `NEMOCLAW_DEPLOY_NO_CONNECT` (unset; `1` skips post-deploy connect), and `NEMOCLAW_DEPLOY_NO_START_SERVICES` (unset; `1` skips service start). - Each entry covers the default, the effect, and notes that flag equivalents on `deploy` take precedence so non-interactive runs can skip prompts. - Cross-link the provider/GPU pair to the existing `Deploy to Remote GPU` narrative for full how-to coverage. - Regenerate the mirror at `.agents/skills/nemoclaw-user-reference/references/commands.md` via `scripts/docs-to-skills.py` so the skill stays in sync with the user-facing docs. ## 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) ## Verification <!-- Check each item you ran and confirmed. Leave unchecked items you skipped. --> - [ ] `npx prek run --all-files` passes - [ ] `npm test` passes - [ ] Tests added or updated for new or changed behavior - [x] No secrets, API keys, or credentials committed - [x] Docs updated for user-facing behavior changes - [ ] `npm run docs` builds without warnings (doc changes only) - [x] Doc pages follow the style guide (doc changes only) - [ ] New doc pages include SPDX header and frontmatter (new pages only) Ran: `python3 scripts/docs-to-skills.py docs/ .agents/skills/ --prefix nemoclaw-user --doc-platform fern-mdx --dry-run` clean; `markdownlint-cli2` clean on both files. All pre-commit hooks pass except the pre-existing `tsc-plugin` infra failure in `nemoclaw/src/onboard/config.ts` that is also present on stock `upstream/main`. Note: this is a fresh recreation of the closed #3349. The original branch was opened against the legacy `.md` docs layout before the Fern MDX migration (#3837) and accumulated 10 commits of upstream churn on `commands.mdx`. Rather than rebasing across that conflict surface, this rebuilds cleanly on top of current `upstream/main` (`8be998680`) as a single signed commit. --- Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Added a Remote Deployment environment-variables section describing Brev/GPU provisioning defaults (NEMOCLAW_BREV_PROVIDER, NEMOCLAW_GPU). * Documented non-interactive deploy/onboard options and flags to skip the post-deploy automatic connect and automatic service startup (NEMOCLAW_DEPLOY_NO_CONNECT, NEMOCLAW_DEPLOY_NO_START_SERVICES). * Linked to the Deploy to Remote GPU guide for usage details. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Signed-off-by: latenighthackathon <latenighthackathon@users.noreply.github.com> Co-authored-by: latenighthackathon <latenighthackathon@users.noreply.github.com> Co-authored-by: Carlos Villela <cvillela@nvidia.com>
Summary
Adds a
### Remote Deploymentsubsection to the## Environment Variablesreference, documenting the four env vars thatsrc/lib/deploy/index.tsreads for thenemoclaw deploy/nemoclaw onboard --remoteflow. Follow-up to #3184: the env-var doc gate currently passes because these vars are accessed via a destructuredenv.NEMOCLAW_*local that the AST extractor does not flag, but the same users who hit the new gate-enforced sections also hit these deploy knobs and had no doc entry to find them.Related Issue
Follow-up to #3184. Original umbrella issue #3059 was already substantively addressed by #3184; this PR closes the four remaining deploy-vars gaps from that audit.
Changes
docs/reference/commands.mdx: new### Remote Deploymentsubsection between### Lifecycle Behavior Flagsand## NemoHermes Alias. One table with four rows:NEMOCLAW_BREV_PROVIDER(defaultgcp),NEMOCLAW_GPU(defaulta2-highgpu-1g:nvidia-tesla-a100:1),NEMOCLAW_DEPLOY_NO_CONNECT,NEMOCLAW_DEPLOY_NO_START_SERVICES. Defaults verified againstsrc/lib/deploy/index.ts:295-303..agents/skills/nemoclaw-user-reference/references/commands.md: same subsection added at the corresponding position to keep the auto-generated skill in sync.Test plan
prek runcleanenv.NEMOCLAW_*reads insrc/lib/deploy/index.ts(the file moved fromsrc/lib/deploy.tstosrc/lib/deploy/index.tsupstream)Signed-off-by: latenighthackathon latenighthackathon@users.noreply.github.com