Skip to content

Commit f71b946

Browse files
themr0cclaude
andauthored
[RHDHBUGS-521]: Fix confusing plugin enable YAML snippets (#2142)
Replace Helm-specific global.dynamic format with dynamic-plugins.yaml plugins: format across 7 proc-enable files. Add explicit file context ("in your dynamic-plugins.yaml file") so users know which file to modify. Migrate Keycloak and K8s custom actions from deprecated wrapper paths to OCI references. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent da1cebb commit f71b946

7 files changed

Lines changed: 44 additions & 60 deletions

modules/shared/proc-enable-kubernetes-custom-actions-plugin-in-rhdh.adoc

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,24 @@
44
= Enable Kubernetes custom actions plugin in {product}
55

66
[role="_abstract"]
7-
Enable the preinstalled Kubernetes custom actions plugin by updating the Helm chart configuration.
7+
Enable the preinstalled Kubernetes custom actions plugin by updating the dynamic plugins configuration.
88

9-
In {product}, the Kubernetes custom actions are provided as a preinstalled plugin, which is disabled by default. You can enable the Kubernetes custom actions plugin by updating the `disabled` key value in your Helm chart.
10-
11-
.Prerequisites
12-
13-
* You have installed {product} with the Helm chart.
9+
In {product}, the Kubernetes custom actions are provided as a preinstalled plugin, which is disabled by default. You can enable the Kubernetes custom actions plugin by updating the `disabled` key value in your `dynamic-plugins.yaml` file.
1410

1511
.Procedure
1612

17-
* In your Helm chart, add a `package` with the Kubernetes custom action plugin name and update the `disabled` field to enable the plugin. For example:
13+
* Add a `package` with the Kubernetes custom action plugin name and update the `disabled` field in your `dynamic-plugins.yaml` file to enable the plugin. For example:
1814
+
1915
--
20-
[source,yaml]
16+
[source,yaml,subs="+quotes"]
2117
----
22-
global:
23-
dynamic:
24-
includes:
25-
- dynamic-plugins.default.yaml
26-
plugins:
27-
- package: ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-kubernetes-dynamic
28-
disabled: false
18+
plugins:
19+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-kubernetes-dynamic:__<tag>__
20+
disabled: false
2921
----
3022

23+
include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[]
24+
3125
[NOTE]
3226
====
3327
The default configuration for a plugin is extracted from the `dynamic-plugins.default.yaml` file, however, you can use a `pluginConfig` entry to override the default configuration.

modules/shared/proc-enable-servicenow-custom-actions-plugin-in-rhdh.adoc

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,14 @@ To use ServiceNow custom actions, you must first activate the plugin.
1313

1414
.Procedure
1515

16-
. Add a `package` with plugin name and update the `disabled` field in your Helm chart as follows:
16+
. Add a `package` with plugin name and update the `disabled` field in your `dynamic-plugins.yaml` file as follows:
1717
+
1818
--
1919
[source,yaml,subs="+quotes"]
2020
----
21-
global:
22-
dynamic:
23-
includes:
24-
- dynamic-plugins.default.yaml
25-
plugins:
26-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-servicenow:__<tag>__
27-
disabled: false
21+
plugins:
22+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-servicenow:__<tag>__
23+
disabled: false
2824
----
2925

3026
include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[]
@@ -35,7 +31,7 @@ The default configuration for a plugin is extracted from the `dynamic-plugins.de
3531
====
3632
--
3733

38-
. Set the following variables in the Helm chart to access the custom actions:
34+
. Set the following variables in your `{my-app-config-file}` file to access the custom actions:
3935
+
4036
--
4137
[source,yaml]

modules/shared/proc-enable-the-argo-cd-plugin.adoc

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,17 @@ If you do not set this annotation, the Argo CD plugin defaults to the first Argo
6262

6363
.Procedure
6464

65-
* Add the following to your dynamic-plugins ConfigMap to enable the Argo CD plugin.
65+
* To enable the Argo CD plugin, set the `disabled` property to `false` in your `dynamic-plugins.yaml` file as follows:
6666
+
6767
[source,yaml,subs="+quotes"]
6868
----
69+
<<<<<<< RHDHBUGS-521-plugin-enable-snippets
70+
plugins:
71+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-argo-cd-backend:__<tag>__
72+
disabled: false
73+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd:__<tag>__
74+
disabled: false
75+
=======
6976
global:
7077
dynamic:
7178
includes:
@@ -75,6 +82,7 @@ global:
7582
disabled: false
7683
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd:__<tag>__
7784
disabled: false
85+
>>>>>>> main
7886
----
7987

8088
include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[]

modules/shared/proc-enable-the-jfrog-artifactory-plugin.adoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,13 @@
77
To enable the JFrog Artifactory plugin, set the `disabled` property to `false`.
88

99
.Procedure
10-
* Set the value to `false` as follows:
10+
* To enable the JFrog Artifactory plugin, set the `disabled` property to `false` in your `dynamic-plugins.yaml` file as follows:
1111
+
1212
[source,yaml,subs="+quotes"]
1313
----
14-
global:
15-
dynamic:
16-
includes:
17-
- dynamic-plugins.default.yaml
18-
plugins:
19-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jfrog-artifactory:__<tag>__
20-
disabled: false
14+
plugins:
15+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jfrog-artifactory:__<tag>__
16+
disabled: false
2117
----
2218
+
2319
include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[]

modules/shared/proc-enable-the-keycloak-plugin.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ Enable the Keycloak plugin to synchronize users and groups from your {rhbk-brand
2020
** `KEYCLOAK_CLIENT_SECRET`
2121

2222
.Procedure
23-
* The Keycloak plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` as follows:
23+
* The Keycloak plugin is pre-loaded in {product-short} with basic configuration properties. To enable it, set the `disabled` property to `false` in your `dynamic-plugins.yaml` file as follows:
2424
+
25-
[source,yaml]
25+
--
26+
[source,yaml,subs="+quotes"]
2627
----
27-
global:
28-
dynamic:
29-
includes:
30-
- dynamic-plugins.default.yaml
31-
plugins:
32-
- package: ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic
33-
disabled: false
28+
plugins:
29+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-catalog-backend-module-keycloak-dynamic:__<tag>__
30+
disabled: false
3431
----
32+
33+
include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[]
34+
--

modules/shared/proc-enable-the-nexus-repository-manager-plugin.adoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,13 @@
77
To enable the Nexus Repository Manager plugin, set the `disabled` property to `false`.
88

99
.Procedure
10-
* Set the value to `false` as follows:
10+
* To enable the Nexus Repository Manager plugin, set the `disabled` property to `false` in your `dynamic-plugins.yaml` file as follows:
1111
+
1212
[source,yaml,subs="+quotes"]
1313
----
14-
global:
15-
dynamic:
16-
includes:
17-
- dynamic-plugins.default.yaml
18-
plugins:
19-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-nexus-repository-manager:__<tag>__
20-
disabled: false
14+
plugins:
15+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-nexus-repository-manager:__<tag>__
16+
disabled: false
2117
----
2218
+
2319
include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[]

modules/shared/proc-enable-the-tekton-plugin.adoc

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -127,18 +127,12 @@ labels:
127127
When you use the label selector, the mentioned labels must be present on the resource.
128128

129129
.Procedure
130-
* To enable the Tekton plugin, set the `disabled` property to `false` as follows:
130+
* To enable the Tekton plugin, set the `disabled` property to `false` in your `dynamic-plugins.yaml` file as follows:
131131
+
132-
--
133132
[source,yaml,subs="+quotes"]
134133
----
135-
global:
136-
dynamic:
137-
includes:
138-
- dynamic-plugins.default.yaml
139-
plugins:
140-
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-tekton:__<tag>__
141-
disabled: false
134+
plugins:
135+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-tekton:__<tag>__
136+
disabled: false
142137
----
143-
--
144138
include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[]

0 commit comments

Comments
 (0)