Skip to content

[RHIDP#14276]: Document new standalone Helm chart values reference - #2500

Open
rh-tokeefe wants to merge 5 commits into
redhat-developer:release-2.1from
rh-tokeefe:RHIDP-14276
Open

[RHIDP#14276]: Document new standalone Helm chart values reference#2500
rh-tokeefe wants to merge 5 commits into
redhat-developer:release-2.1from
rh-tokeefe:RHIDP-14276

Conversation

@rh-tokeefe

Copy link
Copy Markdown
Member

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

  • Add 13 new reference modules documenting the standalone RHDH Helm chart values (replaces the old upstream Backstage subchart-based reference)
  • Update assembly to include new modules and remove old upstream namespace references
  • Update helm show values procedure for new chart name (rhdh)
  • Update {default-helm-chart-values-link} attribute to point to charts/rhdh/values.yaml

Notes

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

  • Verify all 13 new reference modules render correctly in HTML preview
  • Cross-check values against final charts/rhdh/values.yaml when chart PR merges
  • Confirm no broken cross-references in the Helm chart config reference title
  • Run CQA checks

🤖 Generated with Claude Code

rh-tokeefe and others added 4 commits July 24, 2026 12:33
…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>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@rhdh-bot

rhdh-bot commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 36/36 titles | 117s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2500/


Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-14b: Inbound link stability (no ID changes for existing files)
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features
  • CQA-jtbd-01: Verify navigation file structure
  • CQA-jtbd-02: Modules not yet in product_product (informational)

Summary

Checks: 22 total, 22 pass, 0 fail

Modules not yet in product_product

13 modules (proc, con, ref) are not yet included in the product_product title.

modules/configure_helm-chart-config-reference/ (13)
  • modules/configure_helm-chart-config-reference/ref-application-config-values.adoc
  • modules/configure_helm-chart-config-reference/ref-database-values.adoc
  • modules/configure_helm-chart-config-reference/ref-deployment-and-pod-values.adoc
  • modules/configure_helm-chart-config-reference/ref-dynamic-plugins-values.adoc
  • modules/configure_helm-chart-config-reference/ref-environment-and-command-override-values.adoc
  • modules/configure_helm-chart-config-reference/ref-global-and-chart-values.adoc
  • modules/configure_helm-chart-config-reference/ref-image-values.adoc
  • modules/configure_helm-chart-config-reference/ref-lightspeed-values.adoc
  • modules/configure_helm-chart-config-reference/ref-metrics-values.adoc
  • modules/configure_helm-chart-config-reference/ref-networking-values.adoc
  • modules/configure_helm-chart-config-reference/ref-openshift-values.adoc
  • modules/configure_helm-chart-config-reference/ref-orchestrator-values.adoc
  • modules/configure_helm-chart-config-reference/ref-test-values.adoc

22 checks: 22 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.


Updated 2026-07-24 17:19:43 UTC

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>
@sonarqubecloud

Copy link
Copy Markdown

[,console,subs="+attributes,+quotes"]
----
$ helm pull redhat-developer-hub \
$ helm pull rhdh \

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ helm pull rhdh \
$ helm pull redhat-developer-hub \

The chart name would remain the same.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@rm3l rm3l Sep 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hasn't been updated. Or did I miss anything?

Suggested change
$ helm pull rhdh \
$ helm pull redhat-developer-hub \

[,console]
----
$ helm show values redhat-developer-hub/charts/backstage
$ helm show values rhdh

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ helm show values rhdh
$ helm show values redhat-developer-hub

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

[,console]
----
$ helm show values redhat-developer-hub/charts/backstage/charts/postgresql
$ helm show values rhdh/charts/postgresql

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$ helm show values rhdh/charts/postgresql
$ helm show values redhat-developer-hub/charts/postgresql

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

|list
|[]

|extraEnvFrom

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Comment on lines +13 to +48
|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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Split into "Global parameters" (global. prefix) and "Chart-level parameters" sections

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for calling that out @rm3l I didn't realize there was an in-progress doc item!

|===
d|*Key* |*Description* |*Type* d|*Default*

|imageRegistry

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|imageRegistry
|global.imageRegistry

|string
|""

|imagePullSecrets

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|imagePullSecrets
|global.imagePullSecrets

|list
|[]

|defaultStorageClass

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|defaultStorageClass
|global.defaultStorageClass

|lightspeed.core.image.tag
|Core sidecar image tag.
|string
|"0.5.3"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|"0.5.3"
|"0.6.2"

|test.image.tag
|Test image tag.
|string
|"8.9.1"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|"8.9.1"
|"8.21.0"

[,console,subs="+attributes,+quotes"]
----
$ helm pull redhat-developer-hub \
$ helm pull rhdh \

@rm3l rm3l Sep 2, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This hasn't been updated. Or did I miss anything?

Suggested change
$ helm pull rhdh \
$ helm pull redhat-developer-hub \

|""

|imagePullSecrets
|Secrets for pulling images from private registries. Merged with global `imagePullSecrets`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|Secrets for pulling images from private registries. Merged with global `imagePullSecrets`.
|Secrets for pulling images from private registries. Merged with `global.imagePullSecrets`.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants