docs: update k8s docs - #695
Merged
Merged
Conversation
Contributor
|
🌿 Preview your docs: https://nvidia-preview-docs-k8s-versioning-mck.docs.buildwithfern.com/nemo-platform |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughSelf-managed deployment documentation was published in the latest navigation, Helm installation guides were rewritten, and related CLI examples, links, image references, and configuration defaults were updated. ChangesSelf-managed deployment documentation
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/set-up/helm/install.mdx (1)
294-303: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winReplace the literal CRD placeholder.
kubectl delete crd <crd_name>is not executable and does not identify chart-owned CRDs. Provide verified names or remove the command and direct users to inventory CRDs before deletion.As per coding guidelines, “Ensure all code snippets are tested and actually work before publishing.”
🤖 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/set-up/helm/install.mdx` around lines 294 - 303, Update the teardown instructions following helm uninstall by replacing the non-executable <crd_name> placeholder with verified chart-owned CRD names, or remove the CRD deletion command and direct users to inventory the CRDs first. Keep the existing namespace deletion and cluster-wide deletion warning intact, and ensure the resulting shell snippet is executable.Source: Coding guidelines
🧹 Nitpick comments (1)
docs/set-up/helm/install.mdx (1)
34-80: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse tabs for chart-source alternatives.
NGC, direct archive, and GHCR are mutually exclusive workflows. Put them in a tab set.
As per coding guidelines, “Use tab sets for parallel alternatives or variants.”
🤖 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/set-up/helm/install.mdx` around lines 34 - 80, Organize the mutually exclusive NGC repository, direct archive, and GHCR installation workflows in a tab set within the chart setup documentation. Preserve each workflow’s commands and explanatory text, using separate tabs for the stable NGC, direct archive, and nightly GHCR alternatives.Source: Coding guidelines
🤖 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/set-up/helm/install.mdx`:
- Around line 247-252: Update the local smoke-test instructions around the
port-forward command so the readiness curl can execute: either background the
port-forward process and retain a usable cleanup flow, or explicitly direct
users to run curl from a second terminal. Ensure the resulting shell snippet is
tested and works as documented.
- Around line 261-274: Extend the “Upgrade the chart” section with the
equivalent Helm OCI/GHCR upgrade command for releases installed from
$NMP_HELM_CHART_REF. Keep the existing repository-based command, and show the
OCI command using the same release, namespace, values, wait, timeout, and
version settings while referencing the GHCR chart source.
---
Outside diff comments:
In `@docs/set-up/helm/install.mdx`:
- Around line 294-303: Update the teardown instructions following helm uninstall
by replacing the non-executable <crd_name> placeholder with verified chart-owned
CRD names, or remove the CRD deletion command and direct users to inventory the
CRDs first. Keep the existing namespace deletion and cluster-wide deletion
warning intact, and ensure the resulting shell snippet is executable.
---
Nitpick comments:
In `@docs/set-up/helm/install.mdx`:
- Around line 34-80: Organize the mutually exclusive NGC repository, direct
archive, and GHCR installation workflows in a tab set within the chart setup
documentation. Preserve each workflow’s commands and explanatory text, using
separate tabs for the stable NGC, direct archive, and nightly GHCR alternatives.
🪄 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: bbc55a50-fa36-46f6-ac2a-eb681c7486f8
⛔ Files ignored due to path filters (3)
sdk/python/nemo-platform/src/nemo_platform/cli/app.pyis excluded by!sdk/**sdk/python/nemo-platform/src/nemo_platform/cli/commands/docs.pyis excluded by!sdk/**sdk/python/nemo-platform/src/nemo_platform/cli/commands/manifest_registry.pyis excluded by!sdk/**
📒 Files selected for processing (23)
docs/AGENTS.mddocs/auth/authentication/index.mdxdocs/cli/index.mdxdocs/cli/reference.mdxdocs/fern/README.mddocs/fern/gated-nav.ymldocs/fern/versions/latest.ymldocs/helm/index.mdxdocs/set-up/config-reference.mdxdocs/set-up/helm/index.mdxdocs/set-up/helm/ingress.mdxdocs/set-up/helm/install.mdxdocs/set-up/helm/openshift.mdxdocs/set-up/helm/persistent-volumes.mdxdocs/set-up/helm/prerequisites.mdxdocs/set-up/index.mdxdocs/set-up/manage-jobs.mdxdocs/set-up/milvus.mdxk8s/helm/helm-docs-template/nemo-helm-readme.md.gotmplpackages/nemo_platform_ext/src/nemo_platform_ext/cli/app.pypackages/nemo_platform_ext/src/nemo_platform_ext/cli/commands/docs.pypackages/nemo_platform_ext/src/nemo_platform_ext/cli/commands/manifest_registry.pypackages/nemo_platform_plugin/src/nemo_platform_plugin/config.py
💤 Files with no reviewable changes (1)
- docs/fern/gated-nav.yml
Contributor
|
Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
mckornfield
force-pushed
the
docs-k8s-versioning/mck
branch
from
July 15, 2026 16:25
d4d952f to
266bba0
Compare
mckornfield
changed the title
Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
benmccown
approved these changes
Jul 15, 2026
tylersbray
approved these changes
Jul 15, 2026
|
|
||
| ### Reading Documentation | ||
|
|
||
| Use `nemo docs` to read bundled documentation from the CLI: |
Contributor
There was a problem hiding this comment.
Does it do PR reviews? #FeatureRequest
| **Getting started:** | ||
| - Browse documentation with **`nemo docs --list`** | ||
| - Run local platform services with **`nemo services run --help`** | ||
| - Deploy to Kubernetes with **`nemo docs set-up/helm/install`** |
Contributor
There was a problem hiding this comment.
Feels a little off, it tells you about the deployment, doesn't actually do the deployment.
| use_sdk_auth: true | ||
| ``` | ||
|
|
||
| For multi-node GPU jobs on EKS, also configure EFA networking in [Multinode Networking](/documentation/self-managed-deployment/setup/helm/multinode-networking). |
Contributor
There was a problem hiding this comment.
"also configure EFA networking. See [Multinode Networking]" or "also configure EFA networking as described in [Multinode Networking]" ?
| --timeout 20m | ||
| ``` | ||
|
|
||
| The installation process can take approximately 10 minutes for image downloads, container startup, and service readiness. Pods might appear in pending or restarting states while dependencies initialize. |
Contributor
There was a problem hiding this comment.
The "it can take 10 min" comment is helpful for setting expectations, nice.
| @@ -24,7 +24,7 @@ Use `make docs` when you are only editing `docs/fern/` config. Use `make docs-wa | |||
| ## Rules that bite if you miss them | |||
This was referenced Jul 15, 2026
This was referenced Jul 27, 2026
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
New Features
Documentation
CLI
nemo docshelp withset-up/helm/installusage, including reading bundled documentation.