Skip to content

docs(helm): point KEDA ScaledObject at the quickstart Deployment (NVBug 6622429) - #2602

Open
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6622429-helm-keda-scaledobject
Open

docs(helm): point KEDA ScaledObject at the quickstart Deployment (NVBug 6622429)#2602
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/6622429-helm-keda-scaledobject

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Fixes NVBug 6622429: the Helm README KEDA example hard-coded scaleTargetRef.name: nemo-retriever-realtime, which does not exist for the documented quickstart release retriever.
  • The example now uses retriever-nemo-retriever-realtime and documents a label-based kubectl command so other release names can discover the rendered realtime Deployment.

Test plan

  • Chart naming helper matches the README: release retriever renders retriever-nemo-retriever-realtime; nemo-retriever and custom-release produce different names.
  • helm template retriever ./nemo_retriever/helm with the documented KEDA/split flags (Helm is not installed in the authoring environment).
  • On a cluster, kubectl get deploy -l app.kubernetes.io/instance=retriever,app.kubernetes.io/component=realtime returns the same Deployment name.

pre-draft: leakage, mkdocs --strict, ::a, ::p, ::r on the diff vs main

Base: upstream/main
Files: nemo_retriever/helm/README.md

Check Result
Leakage (page roles + see [ CTAs) PASS — helm README has no see [ CTAs. The leakage script vs origin/main also scanned stale/untracked leftovers (custom-metadata.md); those files are not in this PR.
Allowed paths PASS — 1 documentation file (nemo_retriever/helm/README.md)
mkdocs --strict PASS for this change — helm README is not in the MkDocs site. Strict failed on untracked leftover pages (custom-metadata.md, user-defined-stages.md) that are not in this diff.
::a audit PASS — scaleTargetRef.name matches nemo-retriever.role.fullname for release retriever; labels match nemo-retriever.role.selectorLabels (high confidence). validate_code_blocks.py reported 0 fences on this file; YAML/bash in the changed section were reviewed manually.
::p polish Applied — replaced the hard-coded target, added discovery command, and named the Helm labels explicitly.
::r style 95% on the changed prose — no blocking issues. Surrounding KEDA section still has pre-existing contractions and em dashes that were left untouched.

Code drift (not in this docs PR): none. Chart templates already derive Deployment names correctly; only the README example was wrong.

PR: this draft

…ug 6622429)

The documented Helm release is retriever, so scaleTargetRef.name must be retriever-nemo-retriever-realtime.
@kheiss-uwzoo
kheiss-uwzoo requested a review from jperez999 August 27, 2026 18:45
@kheiss-uwzoo kheiss-uwzoo self-assigned this Aug 27, 2026
@kheiss-uwzoo kheiss-uwzoo added 26.08.1 doc Improvements or additions to documentation labels Aug 27, 2026
@kheiss-uwzoo
kheiss-uwzoo marked this pull request as ready for review August 27, 2026 18:46
@kheiss-uwzoo
kheiss-uwzoo requested review from a team as code owners August 27, 2026 18:46
@greptile-apps

greptile-apps Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Updates the Helm KEDA example so the ScaledObject targets the Deployment rendered by the documented retriever release.

  • Changes the example target to retriever-nemo-retriever-realtime.
  • Adds a label-based command for discovering realtime and batch Deployment names under other Helm release names.

Confidence Score: 5/5

The documentation-only change appears safe to merge.

The documented quickstart Deployment name, release-instance label, component label, and single realtime Deployment assumption agree with the checked-in Helm templates.

Important Files Changed

Filename Overview
nemo_retriever/helm/README.md The revised KEDA target name and label selectors match the chart’s fullname and role-label helpers.

Reviews (1): Last reviewed commit: "docs(helm): point KEDA ScaledObject at t..." | Re-trigger Greptile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

26.08.1 doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant