Dynamic plugins reference
Red Hat Developer Hub is preinstalled with a selection of dynamic plugins that you can enable and configure to extend Developer Hub functionality
Abstract
Preface
Red Hat Developer Hub (RHDH) is preinstalled with a selection of dynamic plugins that users can enable and configure to extend RHDH functionality.
The dynamic plugin support is based on the backend plugin manager package, which is a service that scans a configured root directory (dynamicPlugins.rootDirectory in the app config) for dynamic plugin packages and loads them dynamically.
You can use the dynamic plugins that come preinstalled with Red Hat Developer Hub or install external dynamic plugins from a public NPM registry.
Chapter 1. Preinstalled dynamic plugins
Red Hat Developer Hub is preinstalled with a selection of dynamic plugins.
The following 14 preinstalled dynamic plugins are enabled by default:
-
@backstage-community/plugin-analytics-provider-segment -
@backstage-community/plugin-scaffolder-backend-module-regex -
@backstage/plugin-techdocs-backend -
@backstage/plugin-techdocs-module-addons-contrib -
@backstage/plugin-techdocs -
@red-hat-developer-hub/backstage-plugin-adoption-insights-backend -
@red-hat-developer-hub/backstage-plugin-adoption-insights -
@red-hat-developer-hub/backstage-plugin-analytics-module-adoption-insights -
@red-hat-developer-hub/backstage-plugin-app-auth -
@red-hat-developer-hub/backstage-plugin-app-defaults -
@red-hat-developer-hub/backstage-plugin-app-integrations -
@red-hat-developer-hub/backstage-plugin-global-header -
@red-hat-developer-hub/backstage-plugin-homepage -
@red-hat-developer-hub/backstage-plugin-quickstart
The dynamic plugins that require custom configuration are disabled by default.
Upon application startup, for each plugin that is disabled by default, the install-dynamic-plugins init container within the Developer Hub pod log displays a message similar to the following:
======= Skipping disabled dynamic plugin oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator@sha256:2f4f765b5d88ae7c4fabf606821aeb2de1716ab1b3108820d9e4c61c28739178
To enable this plugin, add a package with the same name to the Helm chart and change the value in the disabled field to false. For example:
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator@sha256:2f4f765b5d88ae7c4fabf606821aeb2de1716ab1b3108820d9e4c61c28739178
disabled: false
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.
Chapter 2. Red Hat Generally Available (GA) plugins
Red Hat provides full support for the following 36 dynamic plugins.
| Name | Plugin | Version | Path and required variables |
|---|---|---|---|
|
Adoption Insights |
0.9.1 |
| |
|
Adoption Insights |
|
0.9.1 |
|
|
Analytics Module Adoption Insights |
|
0.9.1 |
|
|
Analytics Provider Segment |
1.30.0 |
| |
|
Auth Backend Module Keycloak Provider |
|
0.4.0 |
|
|
GitHub Org |
0.3.23 |
| |
|
GitHub |
0.13.3 |
| |
|
GitHub |
0.9.10 |
| |
|
GitLab Org |
0.2.22 |
| |
|
GitLab |
0.8.4 |
| |
|
Global Header |
2.0.0 |
| |
|
Homepage |
1.17.1 |
| |
|
Http Request |
5.6.0 |
| |
|
Intelligent Assistant |
|
3.2.0 |
|
|
Intelligent Assistant |
|
3.2.0 |
|
|
Keycloak |
3.19.2 |
| |
|
Kubernetes |
0.21.5 |
| |
|
Kubernetes |
|
2.19.0 |
|
|
Ldap |
0.12.6 |
| |
|
MS Graph |
0.10.3 |
| |
|
Orchestrator Backend Module Loki |
|
1.4.0 |
|
|
Orchestrator Form Widgets |
|
1.12.0 |
|
|
Orchestrator |
5.10.0 |
| |
|
Orchestrator |
|
8.11.0 |
|
|
Orchestrator |
|
1.7.0 |
|
|
Quickstart |
2.0.1 |
| |
|
RBAC |
2.1.0 |
| |
|
Regex |
2.17.0 |
| |
|
Signals |
0.0.32 |
| |
|
Signals |
0.3.16 |
| |
|
Tech Radar |
1.20.0 |
| |
|
Tech Radar |
1.19.0 |
| |
|
TechDocs Module Addons Contrib |
1.1.37 |
| |
|
TechDocs |
1.17.7 |
| |
|
TechDocs |
2.2.1 |
| |
|
Topology |
2.16.0 |
|
- For more information about configuring KeyCloak, see Configuring dynamic plugins.
- For more information about configuring TechDocs, see Configuring TechDocs.
Chapter 3. Red Hat Technology Preview plugins
Red Hat provides Technology Preview support for the following 14 plugins.
These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.
| Name | Plugin | Version | Path and required variables |
|---|---|---|---|
|
App Auth |
0.1.1 |
| |
|
App Defaults |
0.0.3 |
| |
|
App Integrations |
0.1.1 |
| |
|
Bulk Import |
8.0.0 |
| |
|
Bulk Import |
8.0.0 |
| |
|
Events Backend Module GitHub |
0.4.13 |
| |
|
GitLab |
0.11.7 |
| |
|
Homepage |
0.4.0 |
| |
|
Kubernetes |
0.12.20 |
| |
|
Notifications |
0.5.18 |
| |
|
Notifications |
0.3.22 |
| |
|
Notifications |
0.6.6 |
| |
|
Pingidentity |
|
0.13.0 |
|
|
Scaffolder Relation Processor |
|
2.15.0 |
|
Chapter 4. Red Hat community supported plugins
Red Hat provides community support for the following 65 dynamic plugins in ghcr.io.
Replace <tag> with the version tag corresponding to your Developer Hub version. See Determining Tag Values
| Name | Version | Path and required variables |
|---|---|---|
|
3Scale |
3.15.0 |
` |
|
@backstage/plugin-mcp-actions-backend |
0.1.14 |
` |
|
ACR |
1.27.0 |
` |
|
App Visualizer |
0.2.5 |
` |
|
ArgoCD Backend |
1.4.0 |
` |
|
ArgoCD |
2.8.0 |
` |
|
Auth Frontend |
0.1.9 |
` |
|
Azure DevOps Backend |
0.30.0 |
` |
|
Azure DevOps Frontend |
0.32.0 |
` |
|
Catalog Backend Module Azure DevOps Annotator Processor |
0.20.0 |
` |
|
Catalog Backend Module Bitbucket Cloud |
0.5.12 |
` |
|
Catalog Backend Module Bitbucket Server |
0.5.12 |
` |
|
Datadog |
2.7.2 |
` |
|
Dynatrace |
10.21.0 |
` |
|
GitHub Actions |
1.2.0 |
` |
|
GitHub Deployments |
1.2.0 |
` |
|
GitHub Discussions Search Backend Module |
0.14.0 |
` |
|
GitHub Discussions |
1.2.0 |
` |
|
GitHub Insights |
3.5.0 |
` |
|
GitHub Issues |
1.2.1 |
` |
|
GitHub Pull Requests Board |
1.2.0 |
` |
|
GitHub Pull Requests |
3.7.0 |
` |
|
GitLab Backend |
7.0.1 |
` |
|
GitLab Frontend |
7.0.1 |
` |
|
JFrog Artifactory |
1.30.2 |
` |
|
Jenkins Backend |
0.29.0 |
` |
|
Jenkins Frontend |
0.32.0 |
` |
|
Jenkins Scaffolder Backend Module |
0.22.0 |
` |
|
Jira |
2.14.0 |
` |
|
Lighthouse Backend |
0.25.0 |
` |
|
Lighthouse |
0.24.0 |
` |
|
Nexus Repository Manager |
1.26.0 |
` |
|
PagerDuty Backend |
0.14.0 |
` |
|
PagerDuty Entity Processor |
0.4.0 |
` |
|
PagerDuty Frontend |
0.21.0 |
` |
|
PagerDuty Scaffolder Actions |
0.3.1 |
` |
|
Quay Backend |
1.17.0 |
` |
|
Quay |
1.37.1 |
` |
|
Roadie ArgoCD Backend |
4.8.0 |
` |
|
Roadie ArgoCD |
2.12.5 |
` |
|
Scaffolder Backend ArgoCD |
1.8.1 |
` |
|
Scaffolder Backend Module AWS |
2.8.2 |
` |
|
Scaffolder Backend Module Azure DevOps |
0.25.0 |
` |
|
Scaffolder Backend Module Azure |
0.2.22 |
` |
|
Scaffolder Backend Module Bitbucket Cloud |
0.3.7 |
` |
|
Scaffolder Backend Module Bitbucket Server |
0.2.22 |
` |
|
Scaffolder Backend Module DotNet |
0.15.0 |
` |
|
Scaffolder Backend Module Gerrit |
0.2.22 |
` |
|
Scaffolder Backend Module Quay |
2.21.0 |
` |
|
Scaffolder Backend Module ServiceNow |
2.16.0 |
` |
|
Scaffolder Backend Module SonarQube |
2.16.0 |
` |
|
Scaffolder Backend Module Utils |
4.1.2 |
` |
|
Scorecard Backend Module for Dependabot |
1.0.1 |
` |
|
Scorecard Backend Module for Filechecks |
1.0.1 |
` |
|
Scorecard Backend Module for GitHub |
4.1.0 |
` |
|
Scorecard Backend Module for Jira |
4.1.0 |
` |
|
Scorecard Backend Module for OpenSSF Security Scorecards |
1.0.1 |
` |
|
Scorecard Backend Module for SonarQube |
1.0.1 |
` |
|
Scorecard Backend |
4.1.0 |
` |
|
Scorecard |
4.1.0 |
` |
|
Search Backend Module Azure DevOps |
0.7.0 |
` |
|
Security Insights |
3.3.1 |
` |
|
SonarQube Backend |
1.1.1 |
` |
|
SonarQube Frontend |
1.1.0 |
` |
|
Tekton |
3.41.0 |
` |
4.1. Troubleshooting
Plugin not loading
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.
Determining tag values
where:
<tag>Enter your RHDH version of Backstage and the plugin version, in the format
bs_<backstage-version>__<plugin-version>(note the double underscore delimiter). To find these versions, complete the following steps:- Find your Backstage version in the RHDH release notes preface.
Locate the plugin version in the Dynamic Plugins Reference guide. For example, for RHDH 1.9 based on Backstage 1.45.3, use the format
bs_1.45.3__<plugin-version>.TipTo ensure environment stability, use a SHA256 digest instead of a version tag. See Determining SHA256 Digests.
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'
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.
4.2. Additional resources
Chapter 5. Deprecated plugins
There are no deprecated plugins in this release of Red Hat Developer Hub (RHDH)
Chapter 6. Other installable plugins
The following Technology Preview plugins are not preinstalled and must be installed from an external source.
These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.
| Name | Plugin | Version | Installation Details |
|---|---|---|---|
|
Ansible Automation Platform Frontend |
1.0.0 | ||
|
Ansible Automation Platform |
1.0.0 | ||
|
Ansible Automation Platform Scaffolder Backend |
1.0.0 |