Red Hat SummitEste contenido no está disponible en el idioma seleccionado.
Chapter 2. Community plugins migration to the GitHub Container Registry
Breaking Change in RHDH 1.9
Starting with Red Hat Developer Hub 1.9, community-supported plugins are no longer distributed as bundled wrappers in the Developer Hub container image. 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 dynamic-plugins-default.yaml, your ConfigMap or CustomResource) to use the new oci://ghcr.io/… paths.
2.1. What changed
In Developer Hub 1.8 and earlier, community plugins were:
- Wrapped and bundled in the Developer Hub container image.
-
Referenced by using local paths, such as
./dynamic-plugins/dist/<plugin-name>.
Starting with Developer Hub 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>.TipTo ensure environment stability, use a SHA256 digest instead of a version tag. See Determining SHA256 Digests
2.2. Migration steps
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:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Update your configuration to use the new OCI registry path.
2.3. Understanding the tag format
The ghcr.io image tags use the following format: bs_<backstage-version>__<plugin-version>
For example, the image tag bs_1.45.3__0.26.0 uses the following structure:
-
bs_1.45.3: Built against Backstage version 1.45.3 -
0.26.0: Nodejs-packaged Backstage plugin, version 0.26.0
Additional resources
2.4. Community plugins migration table
The following table lists all 36 community-supported plugins that have been migrated from bundled wrappers to ghcr.io.
Replace <tag> with the version tag corresponding to your Developer Hub version. See Determining Tag Values
To ensure environment stability, use a SHA256 digest instead of a version tag. See Determining SHA256 Digests
| Plugin Name | Plugin Version | Old Path (RHDH 1.8) | New Path (RHDH 1.9+) |
|---|---|---|---|
| 3Scale | 3.10.0 |
|
|
| ArgoCD Backend | 1.0.2 |
|
|
| Azure DevOps Backend | 0.23.0 |
|
|
| Catalog Backend Module Azure DevOps Annotator Processor | 0.14.0 |
|
|
| Catalog Backend Module Bitbucket Cloud | 0.5.5 |
|
|
| Catalog Backend Module Bitbucket Server | 0.5.5 |
|
|
| Datadog | 2.6.0 |
|
|
| Dynatrace | 10.12.1 |
|
|
| GitHub Actions | 0.18.0 |
|
|
| GitHub Insights | 3.4.1 |
|
|
| GitHub Issues | 0.16.0 |
|
|
| GitHub Pull Requests | 3.6.2 |
|
|
| 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.6.0 |
|
|
| Scaffolder Backend ArgoCD | 1.8.1 |
|
|
| Scaffolder Backend Module Azure 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.1 |
|
|
| Search Backend Module Azure DevOps | 0.1.2 |
|
|
| Security Insights | 3.3.1 |
|
|
| SonarQube Backend | 0.15.0 |
|
|
| Tekton | 3.33.3 |
|
|
2.5. Plugins remaining bundled in RHDH 1.9
The following plugins remain bundled in 1.9 while transitioning to ghcr.io distribution in a future release:
| Plugin Name | Plugin Version | Current Path (RHDH 1.9) | Future Path (RHDH 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 |
|
|
2.6. Troubleshooting
2.6.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 Developer Hub logs for OCI pull errors.
To ensure environment stability, use a SHA256 digest instead of a version tag. See Determining SHA256 Digests
2.6.2. Determining tag values
The <tag> variable is your RHDH application's version of Backstage and the plugin version, in the format: bs_<backstage-version>__<plugin-version> (note the double underscore delimiter). This format is only applicable for Community supported plugins.
To find the correct image tag for
<tag>:- Look in the RHDH release notes preface for your Backstage version.
-
Locate the plugin version for paths starting with
oci://ghcr.iowithin one of the tables provided in the Dynamic plugins reference.
For example, because RHDH 1.9 is based on Backstage 1.45.3, the tag will have the format bs_1.45.3__<plugin-version>
To ensure environment stability, use a SHA256 digest instead of a version tag. See Determining SHA256 Digests
2.6.3. Determining SHA256 digests
You can look up the SHA256 digest using the Skopeo CLI or by searching in the RHDH Plugin Export Overlays repository
Skopeo CLI
Ensure you have skopeo and jq installed
- Locate the plugin path in the Dynamic plugins reference
-
Run the following command, replacing the plugin path prefix
oci://withdocker://
skopeo inspect docker://<plugin-path>:<tag> | jq '.Digest'
skopeo inspect docker://<plugin-path>:<tag> | jq '.Digest'RHDH 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.
2.7. Additional resources
2.7.1. Deprecated plugins
Red Hat Developer Hub (RHDH) includes a number of deprecated plugins, which are no longer being actively developed. It is recommended that if you depend on any of these plugins, you migrate to an alternative solution as soon as possible, as these plugins will be removed in a future release.
RHDH includes the following 2 deprecated plugins:
| Name | Plugin | Version | Path and required variables |
|---|---|---|---|
| OCM | 5.11.1 |
| |
| OCM | 5.12.2 |
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}