Starting with {product} 1.9, community-supported plugins are no longer distributed as bundled wrappers in the {product-short} container image. Update your dynamic plugins configuration to use the new GitHub Container Registry paths.
|
Important
|
Breaking Change in {product-very-short} 1.9 These plugins are now built using GitHub Actions and published exclusively to the GitHub Container Registry (ghcr.io). If you use the plugins listed in this section, you must update your dynamic plugins configuration (in |
In {product-short} 1.8 and earlier, community plugins were:
-
Wrapped and bundled in the {product-short} container image.
-
Referenced by using local paths, such as
./dynamic-plugins/dist/<plugin-name>.
Starting with {product-short} 1.9, community plugins are:
-
Built using GitHub Actions from the rhdh-plugin-export-overlays repository.
-
Published to
ghcr.io/redhat-developer/rhdh-plugin-export-overlays. -
Referenced by using OCI registry paths, such as
oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/<oci-artifact-name>:<tag>.
To migrate your configuration:
-
Identify plugins in your ConfigMap or CustomResource that use local paths starting with
./dynamic-plugins/dist/. -
Find the corresponding
ghcr.iopath in the following migration table:# Before ({product-very-short} 1.8 and earlier) plugins: - package: ./dynamic-plugins/dist/backstage-community-plugin-jenkins disabled: false # After ({product-very-short} 1.9+) plugins: - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jenkins:bs_1.45.3__0.26.0 disabled: false
-
Update your configuration to use the new OCI registry path.
The ghcr.io image tags use the following format: bs_<backstage-version>__<plugin-version>
Example: bs_1.45.3__0.26.0:
where
* bs_1.45.3: Built against {backstage} version 1.45.3
* 0.26.0: Node.js-packaged {backstage} plugin, version 0.26.0
See {dynamic-plugins-reference-book-link}#determining-tag-values[Determining Tag Values]
The following table lists all 38 community-supported plugins that have been migrated from bundled wrappers to ghcr.io.
|
Note
|
Replace |
| Plugin Name | Plugin Version | Old Path ({product-very-short} 1.8) | New Path ({product-very-short} 1.9+) |
|---|---|---|---|
3Scale |
3.10.0 |
|
|
ArgoCD Backend |
1.0.4 |
|
|
{azure-short} DevOps Backend |
0.23.0 |
|
|
Catalog Backend Module {azure-short} DevOps Annotator Processor |
0.14.0 |
|
|
Catalog Backend Module Bitbucket Cloud |
0.5.5 |
|
|
Catalog Backend Module Bitbucket Server |
0.5.5 |
|
|
Datadog |
2.7.2 |
|
|
Dynatrace |
10.12.1 |
|
|
GitHub Actions |
0.18.0 |
|
|
GitHub Insights |
3.5.0 |
|
|
GitHub Issues |
0.16.0 |
|
|
GitHub Pull Requests |
3.6.3 |
|
|
GitLab Backend |
6.13.0 |
|
|
JFrog Artifactory |
1.24.1 |
|
|
Jenkins Backend |
0.22.0 |
|
|
Jenkins Scaffolder Backend Module |
0.16.0 |
|
|
Jira |
2.14.0 |
|
|
Lighthouse Backend |
0.17.0 |
|
|
Nexus Repository Manager |
1.19.4 |
|
|
PagerDuty Backend |
0.10.1 |
|
|
Quay Backend |
1.10.1 |
|
|
Roadie ArgoCD Backend |
4.7.1 |
|
|
Scaffolder Backend ArgoCD |
1.8.1 |
|
|
Scaffolder Backend Module {aws-short} |
2.8.2 |
|
|
Scaffolder Backend Module {azure-short} |
0.2.15 |
|
|
Scaffolder Backend Module {azure-short} DevOps |
0.18.0 |
|
|
Scaffolder Backend Module Bitbucket Cloud |
0.2.15 |
|
|
Scaffolder Backend Module Bitbucket Server |
0.2.15 |
|
|
Scaffolder Backend Module DotNet |
0.9.0 |
|
|
Scaffolder Backend Module Gerrit |
0.2.15 |
|
|
Scaffolder Backend Module Quay |
2.14.0 |
|
|
Scaffolder Backend Module ServiceNow |
2.11.0 |
|
|
Scaffolder Backend Module SonarQube |
2.11.0 |
|
|
Scaffolder Backend Module Utils |
4.1.2 |
|
|
Search Backend Module {azure-short} DevOps |
0.1.2 |
|
|
Security Insights |
3.3.1 |
|
|
SonarQube Backend |
0.15.0 |
|
|
Tekton |
3.33.3 |
|
|
The following plugins remain bundled in 1.9 while transitioning to ghcr.io distribution in a future release:
| Plugin Name | Plugin Version | Current Path ({product-very-short} 1.9) | Future Path ({product-very-short} 1.10+) |
|---|---|---|---|
Quay |
1.28.1 |
|
|
Scaffolder Backend Module Quay |
2.14.0 |
|
|
Tekton |
3.33.3 |
|
|
Roadie ArgoCD Backend |
4.6.0 |
|
|
Scaffolder Backend ArgoCD |
1.8.1 |
|
|
Plugin not loading after migration
If a plugin fails to load, perform the following checks:
-
Verify the
ghcr.iopath is correct and the image tag or digest exists. -
Confirm your cluster has network access to
ghcr.io. -
Review {product-short} logs for OCI pull errors.
Determining tag values
Determining SHA256 digests
You can look up the SHA256 digest using the Skopeo CLI or by searching in the {product-very-short} Plugin Export Overlays repository.
Skopeo CLI
Ensure you have skopeo and jq installed.
-
Locate the plugin path in the {dynamic-plugins-reference-book-link}[{dynamic-plugins-reference-book-title}].
-
Run the following command, replacing the plugin path prefix
oci://withdocker://:skopeo inspect docker://<plugin-path>:<tag> | jq '.Digest'
{product-very-short} Plugin Export Overlays Repo
Go to the plugin packages list in the rhdh-plugin-export-overlays repository. Search for your plugin and select the tag that is associated with this release.