Skip to content

Commit 4be1338

Browse files
josephcajosephca
committed
RHIDP-9540: create dynamic plugins table re: wrapped plugins in 1.8 that will move to ghcr.io in 1.9
1 parent f40141a commit 4be1338

File tree

3 files changed

+596
-15
lines changed

3 files changed

+596
-15
lines changed

‎modules/dynamic-plugins/ref-community-plugins-migration.adoc‎

Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,250 @@
1+
// Module included in the following assemblies:
2+
// assembly-dynamic-plugins.adoc
3+
4+
// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="ref-community-plugins-migration_{context}"]
8+
= Community plugins migration from bundled wrappers to ghcr.io
9+
10+
[IMPORTANT]
11+
====
12+
*Breaking Change in RHDH 1.9*
13+
14+
Starting with {product} 1.9, community-supported plugins are no longer distributed as bundled wrappers in the {product-short} container image. These plugins are now built using GitHub Actions and published exclusively to the GitHub Container Registry (ghcr.io).
15+
16+
If you are using any of the plugins listed in this section, you must update your `dynamic-plugins.yaml` configuration to use the new `oci://ghcr.io/...` paths.
17+
====
18+
19+
== What changed
20+
21+
In previous versions of {product-short} (1.8 and earlier), community plugins were:
22+
23+
* Wrapped and bundled in the {product-short} container image
24+
* Built using Konflux pipelines
25+
* Referenced using local paths like `./dynamic-plugins/dist/<plugin-name>`
26+
27+
Starting with {product-short} 1.9, community plugins are:
28+
29+
* Built using GitHub Actions from the link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays] repository
30+
* Published to `ghcr.io/redhat-developer/rhdh-plugin-export-overlays`
31+
* Referenced using OCI registry paths like `oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/<plugin-name>:<tag>`
32+
33+
== Migration steps
34+
35+
To migrate your configuration:
36+
37+
. Identify which plugins in your `dynamic-plugins.yaml` use local paths starting with `./dynamic-plugins/dist/`
38+
. Find the corresponding new ghcr.io path in the migration table below
39+
. Update your configuration to use the new OCI registry path
40+
41+
.Example migration
42+
[source,yaml]
43+
----
44+
# Before (RHDH 1.8 and earlier)
45+
plugins:
46+
- package: ./dynamic-plugins/dist/backstage-community-plugin-jenkins
47+
disabled: false
48+
49+
# After (RHDH 1.9+)
50+
plugins:
51+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jenkins:bs_1.45.3__3.10.0
52+
disabled: false
53+
----
54+
55+
== Understanding the tag format
56+
57+
The ghcr.io image tags follow the format: `bs_<backstage-version>__<plugin-version>`
58+
59+
For example: `bs_1.45.3__0.26.0` means:
60+
61+
* `bs_1.45.3` - Built against Backstage version 1.45.3
62+
* `0.26.0` - Plugin version 0.26.0
63+
64+
== Community plugins migration table
65+
66+
The following table lists all 32 community-supported plugins that have been migrated from bundled wrappers to ghcr.io.
67+
68+
[NOTE]
69+
====
70+
Replace `<tag>` with the appropriate version tag for your {product-short} version. Check the link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays repository] for the latest available tags.
71+
====
72+
73+
[cols="1,2,3", options="header"]
74+
|===
75+
|Plugin Name
76+
|Old Path (RHDH 1.8)
77+
|New Path (RHDH 1.9+)
78+
79+
|*3Scale*
80+
|`./dynamic-plugins/dist/backstage-community-plugin-3scale-backend`
81+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-3scale-backend:<tag>`
82+
83+
|*ArgoCD Backend*
84+
|`./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd-backend`
85+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-argocd-backend:<tag>`
86+
87+
|*Azure DevOps Backend*
88+
|`./dynamic-plugins/dist/backstage-community-plugin-azure-devops-backend`
89+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-azure-devops-backend:<tag>`
90+
91+
|*Catalog Backend Module Azure DevOps Annotator Processor*
92+
|`./dynamic-plugins/dist/bcp-ctlg-backend-mod-azure-devops-annotator-processor`
93+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-catalog-backend-module-azure-devops-annotator-processor:<tag>`
94+
95+
|*Catalog Backend Module Bitbucket Cloud*
96+
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-cloud`
97+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-catalog-backend-module-bitbucket-cloud:<tag>`
98+
99+
|*Catalog Backend Module Bitbucket Server*
100+
|`./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-server`
101+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-catalog-backend-module-bitbucket-server:<tag>`
102+
103+
|*Datadog*
104+
|`./dynamic-plugins/dist/roadiehq-backstage-plugin-datadog`
105+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-datadog:<tag>`
106+
107+
|*Dynatrace*
108+
|`./dynamic-plugins/dist/backstage-community-plugin-dynatrace`
109+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-dynatrace:<tag>`
110+
111+
|*GitHub Actions*
112+
|`./dynamic-plugins/dist/backstage-community-plugin-github-actions`
113+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-actions:<tag>`
114+
115+
|*GitHub Insights*
116+
|`./dynamic-plugins/dist/roadiehq-backstage-plugin-github-insights`
117+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-github-insights:<tag>`
118+
119+
|*GitHub Issues*
120+
|`./dynamic-plugins/dist/backstage-community-plugin-github-issues`
121+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-github-issues:<tag>`
122+
123+
|*GitHub Pull Requests*
124+
|`./dynamic-plugins/dist/roadiehq-backstage-plugin-github-pull-requests`
125+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-github-pull-requests:<tag>`
126+
127+
|*GitLab Backend*
128+
|`./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab-backend`
129+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/immobiliarelabs-backstage-plugin-gitlab-backend:<tag>`
130+
131+
|*JFrog Artifactory*
132+
|`./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory`
133+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jfrog-artifactory:<tag>`
134+
135+
|*Jenkins Backend*
136+
|`./dynamic-plugins/dist/backstage-community-plugin-jenkins-backend`
137+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jenkins-backend:<tag>`
138+
139+
|*Jenkins Scaffolder Backend Module*
140+
|`./dynamic-plugins/dist/bcp-scaffolder-backend-mod-jenkins`
141+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-jenkins:<tag>`
142+
143+
|*Jira*
144+
|`./dynamic-plugins/dist/roadiehq-backstage-plugin-jira`
145+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-jira:<tag>`
146+
147+
|*Lighthouse Backend*
148+
|`./dynamic-plugins/dist/backstage-community-plugin-lighthouse-backend`
149+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-lighthouse-backend:<tag>`
150+
151+
|*Nexus Repository Manager*
152+
|`./dynamic-plugins/dist/backstage-community-plugin-nexus-repository-manager`
153+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-nexus-repository-manager:<tag>`
154+
155+
|*PagerDuty Backend*
156+
|`./dynamic-plugins/dist/pagerduty-backstage-plugin-backend`
157+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/pagerduty-backstage-plugin-backend:<tag>`
158+
159+
|*Roadie ArgoCD Backend*
160+
|`./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend`
161+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-argo-cd-backend:<tag>`
162+
163+
|*Scaffolder Backend ArgoCD*
164+
|`./dynamic-plugins/dist/roadiehq-scaffolder-backend-argocd`
165+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-argocd:<tag>`
166+
167+
|*Scaffolder Backend Module Azure DevOps*
168+
|`./dynamic-plugins/dist/bcp-scaffolder-backend-mod-azure-devops`
169+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-azure-devops:<tag>`
170+
171+
|*Scaffolder Backend Module Bitbucket Cloud*
172+
|`./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-cloud`
173+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-bitbucket-cloud:<tag>`
174+
175+
|*Scaffolder Backend Module Bitbucket Server*
176+
|`./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-server`
177+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-bitbucket-server:<tag>`
178+
179+
|*Scaffolder Backend Module DotNet*
180+
|`./dynamic-plugins/dist/bcp-scaffolder-backend-mod-dotnet`
181+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-dotnet:<tag>`
182+
183+
|*Scaffolder Backend Module Gerrit*
184+
|`./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gerrit`
185+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-plugin-scaffolder-backend-module-gerrit:<tag>`
186+
187+
|*Scaffolder Backend Module SonarQube*
188+
|`./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-sonarqube`
189+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-scaffolder-backend-module-sonarqube:<tag>`
190+
191+
|*Scaffolder Backend Module Utils*
192+
|`./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-utils`
193+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-module-utils:<tag>`
194+
195+
|*Search Backend Module Azure DevOps*
196+
|`./dynamic-plugins/dist/bcp-search-backend-mod-azure-devops`
197+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-search-backend-module-azure-devops:<tag>`
198+
199+
|*Security Insights*
200+
|`./dynamic-plugins/dist/roadiehq-backstage-plugin-security-insights`
201+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-backstage-plugin-security-insights:<tag>`
202+
203+
|*SonarQube Backend*
204+
|`./dynamic-plugins/dist/backstage-community-plugin-sonarqube-backend`
205+
|`oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-sonarqube-backend:<tag>`
206+
207+
|===
208+
209+
== Plugins remaining bundled in RHDH 1.9
210+
211+
The following plugins were previously bundled in {product-short} 1.8 and will continue to be bundled in 1.9 while transitioning to ghcr.io distribution in a future release:
212+
213+
* `@backstage-community/plugin-quay`
214+
* `@backstage-community/plugin-quay-backend`
215+
* `@backstage-community/plugin-tekton`
216+
* `@roadiehq/backstage-plugin-argo-cd-backend` (Roadie version)
217+
218+
[NOTE]
219+
====
220+
These plugins will migrate to ghcr.io in {product-short} 1.10 or 1.11. Plan your migration accordingly.
221+
====
222+
223+
== Troubleshooting
224+
225+
=== Plugin not loading after migration
226+
227+
If a plugin fails to load after migration:
228+
229+
. Verify the ghcr.io path is correct and the image tag exists
230+
. Check that your cluster has network access to `ghcr.io`
231+
. Review the {product-short} logs for OCI pull errors
232+
. Ensure the integrity checksum (if required) matches the published image
233+
234+
=== Finding available tags
235+
236+
To find available image tags for a plugin:
237+
238+
[source,bash]
239+
----
240+
# Using skopeo
241+
skopeo list-tags docker://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/<plugin-name>
242+
----
243+
244+
== Additional resources
245+
246+
* link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays GitHub repository]
247+
* xref:ref-community-plugins.adoc[Community Plugins Reference]
248+
* xref:proc-config-dynamic-plugins-rhdh-operator.adoc[Configuring dynamic plugins with the Operator]
249+
250+

‎modules/dynamic-plugins/ref-community-plugins-migration.template.adoc‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
// Module included in the following assemblies:
2+
// assembly-dynamic-plugins.adoc
3+
4+
// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
5+
6+
:_mod-docs-content-type: REFERENCE
7+
[id="ref-community-plugins-migration_{context}"]
8+
= Community plugins migration from bundled wrappers to ghcr.io
9+
10+
[IMPORTANT]
11+
====
12+
*Breaking Change in RHDH 1.9*
13+
14+
Starting with {product} 1.9, community-supported plugins are no longer distributed as bundled wrappers in the {product-short} container image. These plugins are now built using GitHub Actions and published exclusively to the GitHub Container Registry (ghcr.io).
15+
16+
If you are using any of the plugins listed in this section, you must update your `dynamic-plugins.yaml` configuration to use the new `oci://ghcr.io/...` paths.
17+
====
18+
19+
== What changed
20+
21+
In previous versions of {product-short} (1.8 and earlier), community plugins were:
22+
23+
* Wrapped and bundled in the {product-short} container image
24+
* Built using Konflux pipelines
25+
* Referenced using local paths like `./dynamic-plugins/dist/<plugin-name>`
26+
27+
Starting with {product-short} 1.9, community plugins are:
28+
29+
* Built using GitHub Actions from the link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays] repository
30+
* Published to `ghcr.io/redhat-developer/rhdh-plugin-export-overlays`
31+
* Referenced using OCI registry paths like `oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/<plugin-name>:<tag>`
32+
33+
== Migration steps
34+
35+
To migrate your configuration:
36+
37+
. Identify which plugins in your `dynamic-plugins.yaml` use local paths starting with `./dynamic-plugins/dist/`
38+
. Find the corresponding new ghcr.io path in the migration table below
39+
. Update your configuration to use the new OCI registry path
40+
41+
.Example migration
42+
[source,yaml]
43+
----
44+
# Before (RHDH 1.8 and earlier)
45+
plugins:
46+
- package: ./dynamic-plugins/dist/backstage-community-plugin-jenkins
47+
disabled: false
48+
49+
# After (RHDH 1.9+)
50+
plugins:
51+
- package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jenkins:%%EXAMPLE_TAG%%
52+
disabled: false
53+
----
54+
55+
== Understanding the tag format
56+
57+
The ghcr.io image tags follow the format: `bs_<backstage-version>__<plugin-version>`
58+
59+
For example: `bs_1.45.3__0.26.0` means:
60+
61+
* `bs_1.45.3` - Built against Backstage version 1.45.3
62+
* `0.26.0` - Plugin version 0.26.0
63+
64+
== Community plugins migration table
65+
66+
The following table lists all %%MIGRATION_COUNT%% community-supported plugins that have been migrated from bundled wrappers to ghcr.io.
67+
68+
[NOTE]
69+
====
70+
Replace `<tag>` with the appropriate version tag for your {product-short} version. Check the link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays repository] for the latest available tags.
71+
====
72+
73+
[cols="1,2,3", options="header"]
74+
|===
75+
|Plugin Name
76+
|Old Path (RHDH 1.8)
77+
|New Path (RHDH 1.9+)
78+
79+
%%MIGRATION_TABLE%%
80+
|===
81+
82+
== Plugins remaining bundled in RHDH 1.9
83+
84+
The following plugins were previously bundled in {product-short} 1.8 and will continue to be bundled in 1.9 while transitioning to ghcr.io distribution in a future release:
85+
86+
%%BUNDLED_PLUGINS%%
87+
88+
[NOTE]
89+
====
90+
These plugins will migrate to ghcr.io in {product-short} 1.10 or 1.11. Plan your migration accordingly.
91+
====
92+
93+
== Troubleshooting
94+
95+
=== Plugin not loading after migration
96+
97+
If a plugin fails to load after migration:
98+
99+
. Verify the ghcr.io path is correct and the image tag exists
100+
. Check that your cluster has network access to `ghcr.io`
101+
. Review the {product-short} logs for OCI pull errors
102+
. Ensure the integrity checksum (if required) matches the published image
103+
104+
=== Finding available tags
105+
106+
To find available image tags for a plugin:
107+
108+
[source,bash]
109+
----
110+
# Using skopeo
111+
skopeo list-tags docker://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/<plugin-name>
112+
----
113+
114+
== Additional resources
115+
116+
* link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays GitHub repository]
117+
* xref:ref-community-plugins.adoc[Community Plugins Reference]
118+
* xref:proc-config-dynamic-plugins-rhdh-operator.adoc[Configuring dynamic plugins with the Operator]
119+
120+

0 commit comments

Comments
 (0)