[RHIDP#14276]: Document new standalone Helm chart values reference - #2500
[RHIDP#14276]: Document new standalone Helm chart values reference#2500rh-tokeefe wants to merge 5 commits into
Conversation
…chart Replace the old upstream Backstage subchart-based reference modules with 13 focused reference modules covering the new standalone chart's flat values structure. Update assembly includes, helm CLI procedure, and chart attributes to match. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This reverts commit 4cb6c21.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
PR Build ResultsBuild passed -- 36/36 titles | 117s Content Quality AssessmentCQA Report
SummaryChecks: 22 total, 22 pass, 0 fail Modules not yet in product_product13 modules (proc, con, ref) are not yet included in the
|
The asterisks in `*Override` and `extra*` inside backticks caused mismatched emphasis/literal tags in DocBook XML. Reworded to use explicit key names instead. Reverted the helm chart values link back to charts/backstage/values.yaml since charts/rhdh/values.yaml does not exist on release-1.10 yet. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
| [,console,subs="+attributes,+quotes"] | ||
| ---- | ||
| $ helm pull redhat-developer-hub \ | ||
| $ helm pull rhdh \ |
There was a problem hiding this comment.
| $ helm pull rhdh \ | |
| $ helm pull redhat-developer-hub \ |
The chart name would remain the same.
There was a problem hiding this comment.
This hasn't been updated. Or did I miss anything?
| $ helm pull rhdh \ | |
| $ helm pull redhat-developer-hub \ |
| [,console] | ||
| ---- | ||
| $ helm show values redhat-developer-hub/charts/backstage | ||
| $ helm show values rhdh |
There was a problem hiding this comment.
| $ helm show values rhdh | |
| $ helm show values redhat-developer-hub |
| [,console] | ||
| ---- | ||
| $ helm show values redhat-developer-hub/charts/backstage/charts/postgresql | ||
| $ helm show values rhdh/charts/postgresql |
There was a problem hiding this comment.
| $ helm show values rhdh/charts/postgresql | |
| $ helm show values redhat-developer-hub/charts/postgresql |
| |list | ||
| |[] | ||
|
|
||
| |extraEnvFrom |
There was a problem hiding this comment.
All extra* fields do not override the default system behavior. They are only appended to the defaults. So I think they should not be listed under this section.
There was a problem hiding this comment.
Moved to separate "Extra keys" subsection
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| The override keys (for example, `commandOverride` and `envOverride`) replace system defaults entirely. When you use an override key, system-injected environment variables such as `BACKEND_SECRET` and database credentials are not added automatically. Use the extra keys (for example, `extraEnv` and `extraArgs`) to add values without replacing the defaults. |
There was a problem hiding this comment.
We could also explicitly call out that it is the user's responsibility to keep track of any changes to the defaults if they use the *Override fields. For example, if we update the defaults in a followup upgrade, users should make sure to somehow reflect that in their override.
| |imageRegistry | ||
| |Global container image registry. Overrides per-image registries for all containers. | ||
| |string | ||
| |"" | ||
|
|
||
| |imagePullSecrets | ||
| |Global container image registry secret names. | ||
| |list | ||
| |[] | ||
|
|
||
| |defaultStorageClass | ||
| |Global default StorageClass for PVCs. | ||
| |string | ||
| |"" | ||
|
|
||
| |nameOverride | ||
| |Override the chart name used in resource naming. | ||
| |string | ||
| |"" | ||
|
|
||
| |fullnameOverride | ||
| |Override the full resource name. | ||
| |string | ||
| |"" | ||
|
|
||
| |commonLabels | ||
| |Labels applied to all chart resources. | ||
| |object | ||
| |{} | ||
|
|
||
| |commonAnnotations | ||
| |Annotations applied to all chart resources. | ||
| |object | ||
| |{} | ||
|
|
||
| |host |
There was a problem hiding this comment.
This reads like all those fields are global.
Some of those fields are under the global. scope, others are not; for example global.imageRegistry but simply host.
Refer to the values.yaml in the chart PR.
There was a problem hiding this comment.
Split into "Global parameters" (global. prefix) and "Chart-level parameters" sections
There was a problem hiding this comment.
FYI, Lightspeed has been rebranded to "Intelligent Assistant" and this has been reflected in the fields of the new chart (redhat-developer/rhdh-chart#515) => s/lightspeed/intelligentAssistant/g and s/Lightspeed/Intelligent Assistant/g
cc @Jdubrick
There was a problem hiding this comment.
Thanks for calling that out @rm3l I didn't realize there was an in-progress doc item!
| |=== | ||
| d|*Key* |*Description* |*Type* d|*Default* | ||
|
|
||
| |imageRegistry |
There was a problem hiding this comment.
| |imageRegistry | |
| |global.imageRegistry |
| |string | ||
| |"" | ||
|
|
||
| |imagePullSecrets |
There was a problem hiding this comment.
| |imagePullSecrets | |
| |global.imagePullSecrets |
| |list | ||
| |[] | ||
|
|
||
| |defaultStorageClass |
There was a problem hiding this comment.
| |defaultStorageClass | |
| |global.defaultStorageClass |
| |lightspeed.core.image.tag | ||
| |Core sidecar image tag. | ||
| |string | ||
| |"0.5.3" |
| |test.image.tag | ||
| |Test image tag. | ||
| |string | ||
| |"8.9.1" |
There was a problem hiding this comment.
| |"8.9.1" | |
| |"8.21.0" |
| [,console,subs="+attributes,+quotes"] | ||
| ---- | ||
| $ helm pull redhat-developer-hub \ | ||
| $ helm pull rhdh \ |
There was a problem hiding this comment.
This hasn't been updated. Or did I miss anything?
| $ helm pull rhdh \ | |
| $ helm pull redhat-developer-hub \ |
| |"" | ||
|
|
||
| |imagePullSecrets | ||
| |Secrets for pulling images from private registries. Merged with global `imagePullSecrets`. |
There was a problem hiding this comment.
| |Secrets for pulling images from private registries. Merged with global `imagePullSecrets`. | |
| |Secrets for pulling images from private registries. Merged with `global.imagePullSecrets`. |



IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s): 2.1
Issue: https://redhat.atlassian.net/browse/RHIDP-14276
Preview: N/A (draft — pending chart PR merge)
Summary
helm show valuesprocedure for new chart name (rhdh){default-helm-chart-values-link}attribute to point tocharts/rhdh/values.yamlNotes
This is a draft based on the current state of the developer's branch (rhdh-chart PR 438). The values schema may change after the developer returns from PTO. The old reference modules (upstream namespace, additional upstream values) are left on disk for release-1.x branches but removed from the assembly includes.
Related dev feature: RHDHPLAN-1058
Test plan
charts/rhdh/values.yamlwhen chart PR merges🤖 Generated with Claude Code