docs(helm): align teardown release and namespace with install (NVBug 6622509) - #2596
Open
kheiss-uwzoo wants to merge 4 commits into
Open
docs(helm): align teardown release and namespace with install (NVBug 6622509)#2596kheiss-uwzoo wants to merge 4 commits into
kheiss-uwzoo wants to merge 4 commits into
Conversation
…6622509) The full-teardown block used the chart name and a namespace the quickstart never creates, then hid the failed uninstall. Share REL/NS with the recommended install and verify cleanup against the intended release.
kheiss-uwzoo
marked this pull request as ready for review
August 27, 2026 16:27
Contributor
Greptile SummaryThe documentation now aligns the recommended Helm installation and teardown release identity and replaces namespace-wide cleanup with explicit, inspectable resource deletion.
|
| Filename | Overview |
|---|---|
| nemo_retriever/helm/README.md | The revised Helm commands resolve the previously reported teardown omissions and add safer target verification and resource-scoping guidance. |
Reviews (3): Last reviewed commit: "docs(helm): include optional NIM names i..." | Re-trigger Greptile
The advertised delete commands only listed the four core CRs and PVCs, so enabled optional NIMs and nimServiceName overrides were left behind.
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
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
REL/NSvalues as the recommended install (retriever/default), instead of the chart namenemo-retrieverand aretrievernamespace that the quickstart never creates.helm uninstallfailure with2>/dev/null || true. Confirm the target release first, then verify it is gone before deleting leftover NIM resources.kubectl delete ... --allonly as an explicit warning, not the advertised command.NVBugs: https://nvbugspro.nvidia.com/bug/6622509
This is a docs-only change to
nemo_retriever/helm/README.md. No chart templates, values, or runtime behavior.Why
Literal execution of the old teardown block uninstalled a release that did not exist, suppressed the Helm error, and left the actual
retrieverrelease (and GPU / NIMCache / PVC workloads) running.nemo-retrieveris the chart name, not the Helm release name.Test plan
REL=retrieverandNS=default.helm uninstallis not wrapped in2>/dev/null || true.--all.NSand to runhelm list --all-namespaceswhen the target is empty.PR scope check (
nrl-pr-scope/focused-git-pr)mainnemo_retriever/helm/README.mdvalues.yaml, or workflows)Overlap: draft #2595 also edits this README (copy-paste ellipsis). This PR rewrites the keep-on-uninstall example and drops the leftover
...in that block.pre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main
Base: upstream/main
Files:
nemo_retriever/helm/README.mdsee [CTAs)see [CTAs in the file. The leakage script vs staleorigin/mainalso scanned leftover untrackedcustom-metadata.md(not in this diff).custom-metadata.md/user-defined-stages.mdthat are not in this diff.nemo-retriever(Chart.yaml); example releaseretriever;keepOnUninstalldefault true; core CR names match templates (95%)REL/NSon install and teardownrefer to/do not, and introduces command blocks with complete sentences. Unchanged README contractions and em dashes were left in place.Code drift (not in this docs PR):
nemo_retriever/helm/templates/nims/*.yamldo not setapp.kubernetes.io/instance, so label-scoped NIM CR deletion is not available without an eng change. Teardown deletes by the chart's fixed CR names instead.PR: this draft