Skip to content

RHIDP-14276: Document the standalone Helm chart values reference - #2616

Merged
gtrivedi88 merged 1 commit into
redhat-developer:release-2.1from
gtrivedi88:RHIDP-14276
Oct 22, 2026
Merged

gtrivedi88 merged 1 commit into
redhat-developer:release-2.1from
gtrivedi88:RHIDP-14276

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Summary

Fixes critical field name mismatch in PR #2500. The standalone RHDH chart renamed the lightspeed.* field to intelligentAssistant.* between when PR #2500 was created (July 24) and when the chart was merged (Aug 24). This PR updates the documentation to match the final chart.

Changes

  • Deleted: ref-lightspeed-values.adoc (outdated field references)
  • Created: ref-intelligent-assistant-values.adoc (331 lines, corrected field names)
    • All 40+ field references updated: lightspeed.* → intelligentAssistant.*
    • Fixed Vale error: "vanilla Kubernetes" → "uncustomized Kubernetes"
    • Added OKP (Offline Knowledge Portal) fields (new feature in final chart)
    • Removed ragInit fields (not in final chart)
  • Updated: assembly-helm-chart-configuration-reference.adoc
    • Category name: {ls-brand-name} → Intelligent Assistant
    • Include path updated to new filename

Verification

All field names verified against:

  • /home/gtrivedi/Documents/GitLab/combine/rhdh-chart/charts/rhdh/values.yaml (final chart)
  • /home/gtrivedi/Documents/GitLab/combine/rhdh-chart/charts/rhdh/README.md (auto-generated docs)

CQA checks: ✅ Passing

Context

This complements PR #2500 by @rh-tokeefe with the field rename fix needed for merge.

JIRA: RHIDP-14276

🤖 Generated with Claude Code

@rhdh-bot

rhdh-bot commented Sep 18, 2026 •

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 1/1 titles | 69s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2616/


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

22 checks: 22 pass, 0 fail

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


Updated 2026-10-21 14:39:39 UTC

@gtrivedi88

Copy link
Copy Markdown
Contributor Author

Pushed a commit addressing all 13 of @rm3l's unresolved review comments from Aug 6 / Sep 2 on #2500 (this branch is a continuation of that one):

  • Helm chart name in CLI examples: rhdh -> redhat-developer-hub
  • Removed extraArgs/extraEnv/extraEnvFrom rows from the override-values table (they append, they don't override)
  • Added guidance that override-key users must keep overrides in sync with future default changes
  • Clarified which global-and-chart-values keys are actually under global.* vs top-level
  • Fixed stale test.image.tag default (8.9.1 -> 8.21.0)
  • Fixed imagePullSecrets description wording

Comment #7 (lightspeed -> intelligentAssistant) and #11 (core image tag) were already handled by this branch's earlier commits via direct chart verification.

QA: Vale 0 errors/0 new warnings on touched files, full build 36/36 titles pass, lychee 0 broken links.

@rm3l re-requesting your review now that your feedback is applied.

@rm3l rm3l left a comment

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.

Comment thread modules/configure_helm-chart-config-reference/ref-database-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-database-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-database-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-database-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-dynamic-plugins-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-global-and-chart-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-dynamic-plugins-values.adoc Outdated

@rm3l rm3l left a comment

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.

@rm3l rm3l left a comment

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.

workload.* fields should also be documented as this is significant feature for users who need StatefulSet behavior. See https://github.com/redhat-developer/rhdh-chart/blob/4523f814a0c1664338370f9cda761ec2f429a04c/charts/rhdh/values.yaml#L222-L245

@rm3l rm3l left a comment

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.

@gtrivedi88 Also, I feel the title of this PR is a bit confusing. It is not only about RHIDP-14276: Fix lightspeed → intelligentAssistant field rename, but actually documenting the new Helm chart fields ;-)

@gtrivedi88 gtrivedi88 changed the title RHIDP-14276: Fix lightspeed → intelligentAssistant field rename RHIDP-14276: Document the standalone Helm chart values reference Oct 8, 2026
@gtrivedi88
gtrivedi88 requested a review from rm3l October 8, 2026 08:03
@gtrivedi88

Copy link
Copy Markdown
Contributor Author

@rm3l Re title feedback: updated to "RHIDP-14276: Document the standalone Helm chart values reference" — thanks for flagging it.

@gtrivedi88

Copy link
Copy Markdown
Contributor Author

@rm3l Re workload.* fields: added a new workload section to ref-deployment-and-pod-values.adoc covering workload.kind and all six workload.statefulSet.* fields (serviceName, podManagementPolicy, updateStrategy, persistentVolumeClaimRetentionPolicy, extraVolumeClaimTemplates, annotations).

@rm3l rm3l left a comment

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.

Thanks @gtrivedi88 !!

/approve

@gtrivedi88 gtrivedi88 added Peer review needed 📖 Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Oct 14, 2026

@pabel-rh pabel-rh left a comment

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.

I ran this through Claude and it asked me to have this verified:

I confirmed the following keys from the 7 deleted files are absent from all 13 new files. This PR's stated goal is to match the final chart, so each is either a legitimate chart removal or a documentation gap
— confirm each against charts/rhdh/values.yaml:

  • upstream.backstage.installDir
  • upstream.backstage.containerPorts (the container listen port; new docs only have service.port)
  • upstream.diagnosticMode (.enabled, .args, .command) — whole block gone
  • upstream.networkPolicy.* — entire feature gone (.enabled, .egressRules.customRules, .egressRules.denyConnectionsToExternal, .ingressRules.customRules, .ingressRules.namespaceSelector,
    .ingressRules.podSelector)
  • test.injectTestNpmrcSecret
  • built-in PostgreSQL auth.username, auth.password, auth.existingSecret, auth.secretKeys.replicationPasswordKey (new postgresql.* keeps only secretKeys.adminPasswordKey/userPasswordKey)
  • orchestrator.sonataflowPlatform.initContainerImage (collapsed into dbCreationJob.image with no note)
  • Lower-confidence (likely intentional Bitnami cleanup): upstream.clusterDomain, upstream.kubeVersion, upstream.postgresql.architecture

Could you please check this too?

Comment thread modules/configure_helm-chart-config-reference/ref-deployment-and-pod-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-deployment-and-pod-values.adoc Outdated
Comment thread modules/configure_helm-chart-config-reference/ref-deployment-and-pod-values.adoc Outdated
@gtrivedi88

Copy link
Copy Markdown
Contributor Author

Correction on the orchestrator.sonataflowPlatform note: checked ref-orchestrator-values.adoc and orchestrator.sonataflowPlatform.dbCreationJob.image is already documented there ("Image for the database creation job. Defaults to the PostgreSQL image values."). The initContainerImage name only ever existed in the deleted doc, never in a shipped chart, so there's no public rename for readers to be warned about — adding a "formerly X" note to a reference module would just add noise. No edit needed here; the existing row already covers it.

Replace the old upstream Backstage subchart-based reference modules
with 13 flat reference modules documenting the new standalone RHDH
Helm chart's values structure, and fix the lightspeed -> intelligentAssistant
field rename that landed in the chart after this work started.

Changes:
- Deleted 7 namespace-based reference modules that documented the old
  upstream Backstage subchart (root/global/orchestrator/route/test/
  upstream values, plus additional upstream chart values)
- Added 13 new flat-structure reference modules covering the standalone
  chart: application-config, database, deployment-and-pod,
  dynamic-plugins, environment-and-command-override,
  global-and-chart, image, intelligent-assistant, metrics,
  networking, openshift, orchestrator, test values
- Updated the assembly and product_product nav map to include the new
  modules in place of the old namespace-based ones
- Updated the helm CLI procedure to match the new chart structure
- Fixed the lightspeed.* -> intelligentAssistant.* field rename that
  happened in the standalone chart between when this work started
  (Jul 24) and when the chart merged (Aug 24); added OKP (Offline
  Knowledge Portal) fields and removed obsolete ragInit fields
- Addressed all 35 of rm3l's (Helm chart SME) review comments across
  two review passes:
  - 13 comments: CLI example chart name (rhdh -> redhat-developer-hub),
    removed extraArgs/extraEnv/extraEnvFrom from the override-values
    table (they append, not override), clarified global.* vs top-level
    keys, fixed stale test.image.tag default, fixed imagePullSecrets
    wording
  - 22 comments: corrected image registry/repository/tag/digest
    defaults across 6 modules to match the Red Hat downstream build
    (registry.redhat.io, rhel10/postgresql-18, etc. instead of
    community/quay.io values); documented previously missing fields
    (intelligentAssistant.okp.enabled, openshift.route.targetPort,
    dynamicPlugins.volume.type statefulSetPVC option and sub-fields,
    the full workload.* StatefulSet section, priorityClassName,
    terminationGracePeriodSeconds, lifecycleHooks, extraDeploy);
    restored a sentence about the postgresql values scope with the
    corrected path
- Fixed Vale error: "vanilla Kubernetes" -> "uncustomized Kubernetes"
- Fixed ccutil DocBook build error: escaped asterisks in admonition
  text that caused mismatched emphasis/literal tags
- Addressed pabel-rh's follow-up review pass: use {ia-name},
  {ia-brand-name}, {ia-short} attributes instead of hardcoded
  'Intelligent Assistant' text; removed an undefined {ls-brand-name}
  attribute reference; clarified replicaCount, terminationGracePeriodSeconds,
  and autoscaling.targetCPUUtilizationPercentage field descriptions;
  lowercased 'chart' for consistency with the surrounding step list

All field names verified against the merged standalone chart
(rhdh-chart release-2.1 values.yaml, both the public GitHub repo and
the Red Hat downstream distgit).

Continues the work started in PR redhat-developer#2500.

QA: Vale 0 errors / 0 new warnings on touched files, full build 36/36
titles pass, all 22 CQA checks pass, lychee 0 broken links.

Co-authored-by: Cursor <cursoragent@cursor.com>
@sonarqubecloud

Copy link
Copy Markdown

@gtrivedi88
gtrivedi88 merged commit 3936594 into redhat-developer:release-2.1 Oct 22, 2026
6 checks passed
gtrivedi88 added a commit to gtrivedi88/red-hat-developers-documentation-rhdh that referenced this pull request Oct 22, 2026
…tation

Systematically replace all upstream.backstage.* values paths and
related YAML examples across the documentation with the new
standalone rhdh-chart's flat values structure. Every renamed field
verified against charts/rhdh/values.yaml, values.schema.json, and
templates/_helpers.tpl in the merged chart PR redhat-developer#438.

Field path changes (old -> new, upstream wrapper removed):
- appConfig, extraAppConfig moved to top level
- extraEnv replaces extraEnvVars; extraEnvFrom (raw envFrom) replaces
  extraEnvVarsSecrets / extraEnvVarsCM
- extraVolumes, extraVolumeMounts, imagePullSecrets, podSecurityContext,
  podAnnotations, metrics, livenessProbe, auth.backend.enabled moved
  to top level
- replicaCount replaces replicas
- dynamicPlugins.plugins / dynamicPlugins.includes replace
  global.dynamic.plugins / global.dynamic.includes (14 occurrences
  across 13 files -- the wrapper changes but the per-plugin field is
  unchanged, matching the documented dynamic-plugins.yaml schema)
- dynamicPlugins.initContainer.extraVolumeMounts replaces the
  full-array initContainers override for install-dynamic-plugins
  (additive now, no need to duplicate the default container spec)
- dynamicPlugins.volume.type: pvc replaces manual extraVolumes wiring
  for the dynamic plugin cache -- the chart now mounts it automatically
- openshift.clusterRouterBase replaces global.clusterRouterBase;
  openshift.route replaces the old top-level route key
- postgresql.* de-nested from upstream.postgresql (bitnami subchart is
  now a direct dependency, not nested under backstage)
- intelligentAssistant.core / intelligentAssistant.okp replace
  global.lightspeed.sidecar / global.lightspeed.initContainer for
  Helm-based air-gapped mirroring (OKP replaces the old RAG init
  container as a separate deployment); intelligentAssistant.enabled /
  .existingSecret / .config.stack.existingConfigMap replace
  global.lightspeed.enabled / .secret / .configMaps
- dynamicPlugins.plugins[].enabled: true replaces the deprecated
  disabled: false field throughout (12 files), per the chart's
  values.schema.json which has no disabled field at all

Also renamed the app-config.yaml runtime namespace (lightspeed ->
intelligent-assistant) in 4 files, confirmed via the upstream plugin's
published breaking-change notes ("@red-hat-developer-hub/backstage-
plugin-lightspeed(-backend)@3.0.0: configuration namespace has been
renamed from lightspeed to intelligent-assistant") and cross-checked
against this repo's own ref-ai-feature-permissions.adoc and
snip-rbac-policies.adoc, which already document and use the new RBAC
permission names (intelligent-assistant.chat, .notebooks, .mcp.tools).

Removed the obsolete upstream Backstage subchart values-display step
(helm show values redhat-developer-hub/charts/backstage) -- the new
chart owns all templates directly and has no subchart to inspect.

Simplified several examples (dynamic plugin cache PVC, OCI registry
CA/cert mounting x3, plugin registry mirroring snippet) that
previously required duplicating default volumes, volume mounts, and
init container fields to work around a Helm array-merge limitation.
The new chart's add-don't-replace pattern for extra* fields removes
that requirement entirely.

Deleted two modules explicitly called out as obsolete in the
RHIDP-14277 planning notes, plus their now-pointless wrapper
assembly/nav/concept pages:
- proc-upgrade-rhdh-from-1-8-to-using-the-helm-chart.adoc (1.x-to-1.x
  only custom-values migration guide)
- proc-fix-helm-overwriting-predefined-arrays.adoc plus its dedicated
  assembly-troubleshoot-rhdh-configuration-issues.adoc and
  product_product nav/concept pages (the underlying Helm array
  overwrite bug no longer exists with the add-don't-replace pattern)

Closed the resulting documentation gap left by removing the 1.8->1.9
migration note: added an IMPORTANT admonition to
proc-upgrade-the-rhdh-helm-chart.adoc and an Additional resources link
in con-helm-chart-values-file.adoc, both pointing to the official
charts/rhdh/docs/migration-from-backstage-chart.md guide in the
rhdh-chart repo (per SME feedback from rm3l), using {product-version}
after confirming the guide exists only on the rhdh-chart release-2.1
branch (release-2.2 returns 404).

Applied rm3l's (Helm chart SME) review feedback:
- Disabled openshift.route on every non-OpenShift Kubernetes (AKS,
  EKS, GKE) values.yaml example, since openshift.route.enabled
  defaults to true in the chart and the route.openshift.io/v1 API is
  not registered on those platforms
- Removed a redundant extraEnv BACKEND_SECRET example (the chart's
  default pod template already injects it; extraEnv only appends)
- Added a migration-guide link for the 1.y -> 2.y chart transition

Applied pabel-rh's review feedback:
- Converted remaining disabled: false / disabled: true examples to
  enabled: true / enabled: false (inverted boolean) across 12 files,
  closing the last gaps in the disabled -> enabled field rename
- Fixed a stray trailing comma after rejectUnauthorized: true (invalid
  YAML)
- 'sidecar' -> 'core' container images wording in the OCP mirror
  procedure (matches the intelligentAssistant.core field)
- Pointed an IMPORTANT admonition at 'the migration guide linked in
  the Additional resources section' instead of the generic 'Additional
  resources'
- 'within this Secret' -> 'in this Secret'

Left untouched (verified already correct, no upstream.backstage
pattern): orchestrator-infra CLI display proc, the two orchestrator
air-gapped install procs (already use top-level orchestrator.plugins),
the two must-gather diagnostics procs (separate, already-flat
redhat-developer-hub-must-gather chart), and
ref-ai-feature-permissions.adoc (its lightspeed.* references are an
intentional 1.x-to-2.1 migration table, not stale content).

Verification: node build/scripts/cqa/index.js --all reports zero new
issues across every file touched by this change (CQA-01 Vale DITA,
CQA-12 grammar, CQA-14/14b links, CQA-16 product names, CQA-jtbd-01/02
all clean).

Rebased onto current release-2.1 (now including merged PR redhat-developer#2616
RHIDP-14276 and PR redhat-developer#2632 RHIDP-15242). Resolved one conflict in
modules/configure_helm-chart-config-reference/proc-display-a-complete-list-of-helm-chart-values-with-helm-cli.adoc:
kept release-2.1's version. redhat-developer#2616 already flattened this exact
procedure and dropped its upstream {backstage} subchart values-display
step as part of documenting the standalone chart's values reference,
superseding this PR's own (now redundant) edit to the same file. No
other files touched by this PR conflicted with redhat-developer#2616 or redhat-developer#2632;
confirmed no dangling references to the two files this PR deletes
(proc-upgrade-rhdh-from-1-8-to-using-the-helm-chart.adoc and the
troubleshoot-configuration-issues category-map pages) were introduced
by redhat-developer#2632's new troubleshooting content.

Re-verified after rebase: node build/scripts/cqa/index.js --all
reports 21/22 checks passing; the single failing check
(CQA-01 AsciiDocDITA.AssemblyContents in titles/product_product/master.adoc)
is pre-existing and in a file this PR does not touch.

JIRA: RHIDP-14277
Related: RHIDP-14276 (values reference, dependency satisfied),
RHIDP-14278 (airgapping instructions, overlaps on mirror-images proc),
RHIDP-14279 (migration guide, not duplicated here)

Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88 added a commit to gtrivedi88/red-hat-developers-documentation-rhdh that referenced this pull request Oct 22, 2026
…tation

Systematically replace all upstream.backstage.* values paths and
related YAML examples across the documentation with the new
standalone rhdh-chart's flat values structure. Every renamed field
verified against charts/rhdh/values.yaml, values.schema.json, and
templates/_helpers.tpl in the merged chart PR redhat-developer#438.

Field path changes (old -> new, upstream wrapper removed):
- appConfig, extraAppConfig moved to top level
- extraEnv replaces extraEnvVars; extraEnvFrom (raw envFrom) replaces
  extraEnvVarsSecrets / extraEnvVarsCM
- extraVolumes, extraVolumeMounts, imagePullSecrets, podSecurityContext,
  podAnnotations, metrics, livenessProbe, auth.backend.enabled moved
  to top level
- replicaCount replaces replicas
- dynamicPlugins.plugins / dynamicPlugins.includes replace
  global.dynamic.plugins / global.dynamic.includes (14 occurrences
  across 13 files -- the wrapper changes but the per-plugin field is
  unchanged, matching the documented dynamic-plugins.yaml schema)
- dynamicPlugins.initContainer.extraVolumeMounts replaces the
  full-array initContainers override for install-dynamic-plugins
  (additive now, no need to duplicate the default container spec)
- dynamicPlugins.volume.type: pvc replaces manual extraVolumes wiring
  for the dynamic plugin cache -- the chart now mounts it automatically
- openshift.clusterRouterBase replaces global.clusterRouterBase;
  openshift.route replaces the old top-level route key
- postgresql.* de-nested from upstream.postgresql (bitnami subchart is
  now a direct dependency, not nested under backstage)
- intelligentAssistant.core / intelligentAssistant.okp replace
  global.lightspeed.sidecar / global.lightspeed.initContainer for
  Helm-based air-gapped mirroring (OKP replaces the old RAG init
  container as a separate deployment); intelligentAssistant.enabled /
  .existingSecret / .config.stack.existingConfigMap replace
  global.lightspeed.enabled / .secret / .configMaps
- dynamicPlugins.plugins[].enabled: true replaces the deprecated
  disabled: false field throughout (12 files), per the chart's
  values.schema.json which has no disabled field at all

Also renamed the app-config.yaml runtime namespace (lightspeed ->
intelligent-assistant) in 4 files, confirmed via the upstream plugin's
published breaking-change notes ("@red-hat-developer-hub/backstage-
plugin-lightspeed(-backend)@3.0.0: configuration namespace has been
renamed from lightspeed to intelligent-assistant") and cross-checked
against this repo's own ref-ai-feature-permissions.adoc and
snip-rbac-policies.adoc, which already document and use the new RBAC
permission names (intelligent-assistant.chat, .notebooks, .mcp.tools).

Removed the obsolete upstream Backstage subchart values-display step
(helm show values redhat-developer-hub/charts/backstage) -- the new
chart owns all templates directly and has no subchart to inspect.

Simplified several examples (dynamic plugin cache PVC, OCI registry
CA/cert mounting x3, plugin registry mirroring snippet) that
previously required duplicating default volumes, volume mounts, and
init container fields to work around a Helm array-merge limitation.
The new chart's add-don't-replace pattern for extra* fields removes
that requirement entirely.

Deleted two modules explicitly called out as obsolete in the
RHIDP-14277 planning notes, plus their now-pointless wrapper
assembly/nav/concept pages:
- proc-upgrade-rhdh-from-1-8-to-using-the-helm-chart.adoc (1.x-to-1.x
  only custom-values migration guide)
- proc-fix-helm-overwriting-predefined-arrays.adoc plus its dedicated
  assembly-troubleshoot-rhdh-configuration-issues.adoc and
  product_product nav/concept pages (the underlying Helm array
  overwrite bug no longer exists with the add-don't-replace pattern)

Closed the resulting documentation gap left by removing the 1.8->1.9
migration note: added an IMPORTANT admonition to
proc-upgrade-the-rhdh-helm-chart.adoc and an Additional resources link
in con-helm-chart-values-file.adoc, both pointing to the official
charts/rhdh/docs/migration-from-backstage-chart.md guide in the
rhdh-chart repo (per SME feedback from rm3l), using {product-version}
after confirming the guide exists only on the rhdh-chart release-2.1
branch (release-2.2 returns 404).

Applied rm3l's (Helm chart SME) review feedback:
- Disabled openshift.route on every non-OpenShift Kubernetes (AKS,
  EKS, GKE) values.yaml example, since openshift.route.enabled
  defaults to true in the chart and the route.openshift.io/v1 API is
  not registered on those platforms
- Removed a redundant extraEnv BACKEND_SECRET example (the chart's
  default pod template already injects it; extraEnv only appends)
- Added a migration-guide link for the 1.y -> 2.y chart transition

Applied pabel-rh's review feedback:
- Converted remaining disabled: false / disabled: true examples to
  enabled: true / enabled: false (inverted boolean) across 12 files,
  closing the last gaps in the disabled -> enabled field rename
- Fixed a stray trailing comma after rejectUnauthorized: true (invalid
  YAML)
- 'sidecar' -> 'core' container images wording in the OCP mirror
  procedure (matches the intelligentAssistant.core field)
- Pointed an IMPORTANT admonition at 'the migration guide linked in
  the Additional resources section' instead of the generic 'Additional
  resources'
- 'within this Secret' -> 'in this Secret'

Left untouched (verified already correct, no upstream.backstage
pattern): orchestrator-infra CLI display proc, the two orchestrator
air-gapped install procs (already use top-level orchestrator.plugins),
the two must-gather diagnostics procs (separate, already-flat
redhat-developer-hub-must-gather chart), and
ref-ai-feature-permissions.adoc (its lightspeed.* references are an
intentional 1.x-to-2.1 migration table, not stale content).

Verification: node build/scripts/cqa/index.js --all reports zero new
issues across every file touched by this change (CQA-01 Vale DITA,
CQA-12 grammar, CQA-14/14b links, CQA-16 product names, CQA-jtbd-01/02
all clean).

Rebased onto current release-2.1 (now including merged PR redhat-developer#2616
RHIDP-14276 and PR redhat-developer#2632 RHIDP-15242). Resolved one conflict in
modules/configure_helm-chart-config-reference/proc-display-a-complete-list-of-helm-chart-values-with-helm-cli.adoc:
kept release-2.1's version. redhat-developer#2616 already flattened this exact
procedure and dropped its upstream {backstage} subchart values-display
step as part of documenting the standalone chart's values reference,
superseding this PR's own (now redundant) edit to the same file. No
other files touched by this PR conflicted with redhat-developer#2616 or redhat-developer#2632;
confirmed no dangling references to the two files this PR deletes
(proc-upgrade-rhdh-from-1-8-to-using-the-helm-chart.adoc and the
troubleshoot-configuration-issues category-map pages) were introduced
by redhat-developer#2632's new troubleshooting content.

Re-verified after rebase: node build/scripts/cqa/index.js --all
reports 21/22 checks passing; the single failing check
(CQA-01 AsciiDocDITA.AssemblyContents in titles/product_product/master.adoc)
is pre-existing and in a file this PR does not touch.

Second rebase onto current release-2.1 (now also including merged PR
redhat-developer#2540 RHIDP-16107, "Switch Lightspeed RAG Container to OKP"). Resolved
three conflicts, all in files where redhat-developer#2540 and this PR edited the same
lines independently:

- modules/shared/proc-configure-by-using-the-helm-chart.adoc: kept
  this PR's wording improvements (abstract, NOTE/TIP text, step
  phrasing); for the one truly conflicting line (`key:` value quoting
  in the existingConfigMap example), matched redhat-developer#2540's already-merged
  unquoted style instead of this PR's quoted version, since redhat-developer#2540 is
  the newer, reviewed edit to that exact line.
- modules/shared/proc-mirror-images-for-helm-deployments-on-kubernetes.adoc
  and modules/shared/proc-mirror-images-for-helm-deployments-on-ocp.adoc:
  took redhat-developer#2540's version in full. At the time this PR mechanically
  renamed `global.lightspeed.sidecar/initContainer` to
  `intelligentAssistant.core/okp`, OKP was still documented as an
  in-place container swap. redhat-developer#2540 subsequently rewrote both procedures
  around OKP's current architecture (a separate Ingress-exposed
  deployment, `.digest`-based image references with `@digest` skopeo
  pinning instead of `.tag` with `:tag`, and the `okp.enabled` +
  `okp.ingress` fields), which supersedes this PR's earlier mechanical
  rename for these two files.

Re-verified again: node build/scripts/cqa/index.js --all reports the
same 21/22 checks passing, no new issues.

JIRA: RHIDP-14277
Related: RHIDP-14276 (values reference, dependency satisfied),
RHIDP-14278 (airgapping instructions, overlaps on mirror-images proc),
RHIDP-14279 (migration guide, not duplicated here)

Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88 added a commit that referenced this pull request Oct 22, 2026
…tation (#2622)

Systematically replace all upstream.backstage.* values paths and
related YAML examples across the documentation with the new
standalone rhdh-chart's flat values structure. Every renamed field
verified against charts/rhdh/values.yaml, values.schema.json, and
templates/_helpers.tpl in the merged chart PR #438.

Field path changes (old -> new, upstream wrapper removed):
- appConfig, extraAppConfig moved to top level
- extraEnv replaces extraEnvVars; extraEnvFrom (raw envFrom) replaces
  extraEnvVarsSecrets / extraEnvVarsCM
- extraVolumes, extraVolumeMounts, imagePullSecrets, podSecurityContext,
  podAnnotations, metrics, livenessProbe, auth.backend.enabled moved
  to top level
- replicaCount replaces replicas
- dynamicPlugins.plugins / dynamicPlugins.includes replace
  global.dynamic.plugins / global.dynamic.includes (14 occurrences
  across 13 files -- the wrapper changes but the per-plugin field is
  unchanged, matching the documented dynamic-plugins.yaml schema)
- dynamicPlugins.initContainer.extraVolumeMounts replaces the
  full-array initContainers override for install-dynamic-plugins
  (additive now, no need to duplicate the default container spec)
- dynamicPlugins.volume.type: pvc replaces manual extraVolumes wiring
  for the dynamic plugin cache -- the chart now mounts it automatically
- openshift.clusterRouterBase replaces global.clusterRouterBase;
  openshift.route replaces the old top-level route key
- postgresql.* de-nested from upstream.postgresql (bitnami subchart is
  now a direct dependency, not nested under backstage)
- intelligentAssistant.core / intelligentAssistant.okp replace
  global.lightspeed.sidecar / global.lightspeed.initContainer for
  Helm-based air-gapped mirroring (OKP replaces the old RAG init
  container as a separate deployment); intelligentAssistant.enabled /
  .existingSecret / .config.stack.existingConfigMap replace
  global.lightspeed.enabled / .secret / .configMaps
- dynamicPlugins.plugins[].enabled: true replaces the deprecated
  disabled: false field throughout (12 files), per the chart's
  values.schema.json which has no disabled field at all

Also renamed the app-config.yaml runtime namespace (lightspeed ->
intelligent-assistant) in 4 files, confirmed via the upstream plugin's
published breaking-change notes ("@red-hat-developer-hub/backstage-
plugin-lightspeed(-backend)@3.0.0: configuration namespace has been
renamed from lightspeed to intelligent-assistant") and cross-checked
against this repo's own ref-ai-feature-permissions.adoc and
snip-rbac-policies.adoc, which already document and use the new RBAC
permission names (intelligent-assistant.chat, .notebooks, .mcp.tools).

Removed the obsolete upstream Backstage subchart values-display step
(helm show values redhat-developer-hub/charts/backstage) -- the new
chart owns all templates directly and has no subchart to inspect.

Simplified several examples (dynamic plugin cache PVC, OCI registry
CA/cert mounting x3, plugin registry mirroring snippet) that
previously required duplicating default volumes, volume mounts, and
init container fields to work around a Helm array-merge limitation.
The new chart's add-don't-replace pattern for extra* fields removes
that requirement entirely.

Deleted two modules explicitly called out as obsolete in the
RHIDP-14277 planning notes, plus their now-pointless wrapper
assembly/nav/concept pages:
- proc-upgrade-rhdh-from-1-8-to-using-the-helm-chart.adoc (1.x-to-1.x
  only custom-values migration guide)
- proc-fix-helm-overwriting-predefined-arrays.adoc plus its dedicated
  assembly-troubleshoot-rhdh-configuration-issues.adoc and
  product_product nav/concept pages (the underlying Helm array
  overwrite bug no longer exists with the add-don't-replace pattern)

Closed the resulting documentation gap left by removing the 1.8->1.9
migration note: added an IMPORTANT admonition to
proc-upgrade-the-rhdh-helm-chart.adoc and an Additional resources link
in con-helm-chart-values-file.adoc, both pointing to the official
charts/rhdh/docs/migration-from-backstage-chart.md guide in the
rhdh-chart repo (per SME feedback from rm3l), using {product-version}
after confirming the guide exists only on the rhdh-chart release-2.1
branch (release-2.2 returns 404).

Applied rm3l's (Helm chart SME) review feedback:
- Disabled openshift.route on every non-OpenShift Kubernetes (AKS,
  EKS, GKE) values.yaml example, since openshift.route.enabled
  defaults to true in the chart and the route.openshift.io/v1 API is
  not registered on those platforms
- Removed a redundant extraEnv BACKEND_SECRET example (the chart's
  default pod template already injects it; extraEnv only appends)
- Added a migration-guide link for the 1.y -> 2.y chart transition

Applied pabel-rh's review feedback:
- Converted remaining disabled: false / disabled: true examples to
  enabled: true / enabled: false (inverted boolean) across 12 files,
  closing the last gaps in the disabled -> enabled field rename
- Fixed a stray trailing comma after rejectUnauthorized: true (invalid
  YAML)
- 'sidecar' -> 'core' container images wording in the OCP mirror
  procedure (matches the intelligentAssistant.core field)
- Pointed an IMPORTANT admonition at 'the migration guide linked in
  the Additional resources section' instead of the generic 'Additional
  resources'
- 'within this Secret' -> 'in this Secret'

Left untouched (verified already correct, no upstream.backstage
pattern): orchestrator-infra CLI display proc, the two orchestrator
air-gapped install procs (already use top-level orchestrator.plugins),
the two must-gather diagnostics procs (separate, already-flat
redhat-developer-hub-must-gather chart), and
ref-ai-feature-permissions.adoc (its lightspeed.* references are an
intentional 1.x-to-2.1 migration table, not stale content).

Verification: node build/scripts/cqa/index.js --all reports zero new
issues across every file touched by this change (CQA-01 Vale DITA,
CQA-12 grammar, CQA-14/14b links, CQA-16 product names, CQA-jtbd-01/02
all clean).

Rebased onto current release-2.1 (now including merged PR #2616
RHIDP-14276 and PR #2632 RHIDP-15242). Resolved one conflict in
modules/configure_helm-chart-config-reference/proc-display-a-complete-list-of-helm-chart-values-with-helm-cli.adoc:
kept release-2.1's version. #2616 already flattened this exact
procedure and dropped its upstream {backstage} subchart values-display
step as part of documenting the standalone chart's values reference,
superseding this PR's own (now redundant) edit to the same file. No
other files touched by this PR conflicted with #2616 or #2632;
confirmed no dangling references to the two files this PR deletes
(proc-upgrade-rhdh-from-1-8-to-using-the-helm-chart.adoc and the
troubleshoot-configuration-issues category-map pages) were introduced
by #2632's new troubleshooting content.

Re-verified after rebase: node build/scripts/cqa/index.js --all
reports 21/22 checks passing; the single failing check
(CQA-01 AsciiDocDITA.AssemblyContents in titles/product_product/master.adoc)
is pre-existing and in a file this PR does not touch.

Second rebase onto current release-2.1 (now also including merged PR
#2540 RHIDP-16107, "Switch Lightspeed RAG Container to OKP"). Resolved
three conflicts, all in files where #2540 and this PR edited the same
lines independently:

- modules/shared/proc-configure-by-using-the-helm-chart.adoc: kept
  this PR's wording improvements (abstract, NOTE/TIP text, step
  phrasing); for the one truly conflicting line (`key:` value quoting
  in the existingConfigMap example), matched #2540's already-merged
  unquoted style instead of this PR's quoted version, since #2540 is
  the newer, reviewed edit to that exact line.
- modules/shared/proc-mirror-images-for-helm-deployments-on-kubernetes.adoc
  and modules/shared/proc-mirror-images-for-helm-deployments-on-ocp.adoc:
  took #2540's version in full. At the time this PR mechanically
  renamed `global.lightspeed.sidecar/initContainer` to
  `intelligentAssistant.core/okp`, OKP was still documented as an
  in-place container swap. #2540 subsequently rewrote both procedures
  around OKP's current architecture (a separate Ingress-exposed
  deployment, `.digest`-based image references with `@digest` skopeo
  pinning instead of `.tag` with `:tag`, and the `okp.enabled` +
  `okp.ingress` fields), which supersedes this PR's earlier mechanical
  rename for these two files.

Re-verified again: node build/scripts/cqa/index.js --all reports the
same 21/22 checks passing, no new issues.

JIRA: RHIDP-14277
Related: RHIDP-14276 (values reference, dependency satisfied),
RHIDP-14278 (airgapping instructions, overlaps on mirror-images proc),
RHIDP-14279 (migration guide, not duplicated here)

Co-authored-by: Cursor <cursoragent@cursor.com>

This branch was successfully deployed

2 active (1 outdated) deployments
internal — 56e847a2 Deployed Oct 21, 2026 by gtrivedi88 via authorize #11711
external — f667a22c Deployed Sep 21, 2026 by gtrivedi88 via authorize #11302
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AEM ready to merge PR content is ready to be migrated to AEM Peer review done 📘 Ready to merge 💂 Technical review done ⛅ Any procedure has been succesfully tested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants