Repository navigation
RHIDP-16107: Switch Lightspeed RAG Container to OKP - #2540
Merged
Merged
Conversation
Collaborator
PR Build ResultsBuild passed -- 2/2 titles | 59s Content Quality AssessmentCQA Report
SummaryChecks: 22 total, 22 pass, 0 fail Modules not yet in product_product7 modules (proc, con, ref) are not yet included in the
|
pabel-rh
force-pushed
the
rhidp-16107
branch
from
September 2, 2026 11:25
55e4aa9 to
3fee631
Compare
pabel-rh
added
Peer review needed 📖
do-no-merge/review-in-progress 👀
Technical review needed 🔩
maysunfaisal
reviewed
Oct 6, 2026
maysunfaisal
reviewed
Oct 6, 2026
maysunfaisal
reviewed
Oct 6, 2026
maysunfaisal
reviewed
Oct 6, 2026
pabel-rh
added
Technical review done ⛅
jmagak
reviewed
Oct 13, 2026
pabel-rh
added
Ready to merge 💂
Peer review done 📘
AEM ready to merge
|
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
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.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
release-2.1 only
Issue:
RHIDP-16107
Preview: