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 18 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-catalog-backend-module-extensions -
@red-hat-developer-hub/backstage-plugin-extensions-backend -
@red-hat-developer-hub/backstage-plugin-extensions -
@red-hat-developer-hub/backstage-plugin-global-header -
@red-hat-developer-hub/backstage-plugin-homepage-backend -
@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 50 dynamic plugins.
| Name | Plugin | Plugin Version | Path and required variables | Artifact Tag |
|---|---|---|---|---|
|
Adoption Insights |
1.0.4 |
|
2.2.0—1.0.4 | |
|
Adoption Insights |
|
1.0.4 |
|
2.2.0—1.0.4 |
|
Analytics Module Adoption Insights |
|
1.0.4 |
|
2.2.0—1.0.4 |
|
Analytics Provider Segment |
2.0.0 |
|
2.2.0—2.0.0 | |
|
App Auth |
1.2.0 |
|
2.2.0—1.2.0 | |
|
App Defaults |
1.10.0 |
|
2.2.0—1.10.0 | |
|
App Integrations |
1.1.1 |
|
2.2.0—1.1.1 | |
|
Auth Backend Module GitHub Provider |
0.5.6 |
|
2.2.0—0.5.6 | |
|
Auth Backend Module GitLab Provider |
0.4.6 |
|
2.2.0—0.4.6 | |
|
Auth Backend Module Guest Provider |
0.2.22 |
|
2.2.0—0.2.22 | |
|
Auth Backend Module Keycloak Provider |
|
0.6.0 |
|
2.2.0—0.6.0 |
|
Auth Backend Module Microsoft Provider |
0.3.18 |
|
2.2.0—0.3.18 | |
|
Auth Backend Module Oidc Provider |
0.4.20 |
|
2.2.0—0.4.20 | |
|
Auth Backend Module Pingfederate Provider |
|
0.4.0 |
|
2.2.0—0.4.0 |
|
Bulk Import |
9.1.1 |
|
2.2.0—9.1.1 | |
|
Bulk Import |
9.1.1 |
|
2.2.0—9.1.1 | |
|
GitHub Org |
0.3.25 |
|
2.2.0—0.3.25 | |
|
GitHub |
0.13.5 |
|
2.2.0—0.13.5 | |
|
GitHub |
0.9.13 |
|
2.2.0—0.9.13 | |
|
GitLab Org |
0.2.24 |
|
2.2.0—0.2.24 | |
|
GitLab |
0.8.7 |
|
2.2.0—0.8.7 | |
|
Global Header |
3.1.0 |
|
2.2.0—3.1.0 | |
|
Homepage |
1.18.0 |
|
2.2.0—1.18.0 | |
|
Homepage |
0.5.0 |
|
2.2.0—0.5.0 | |
|
Http Request |
5.9.0 |
|
2.2.0—5.9.0 | |
|
Intelligent Assistant |
|
5.3.6 |
|
2.2.0—5.3.6 |
|
Intelligent Assistant |
|
5.3.6 |
|
2.2.0—5.3.6 |
|
Keycloak |
3.23.1 |
|
2.2.0—3.23.1 | |
|
Kubernetes |
0.12.22 |
|
2.2.0—0.12.22 | |
|
Kubernetes |
0.21.10 |
|
2.2.0—0.21.10 | |
|
Kubernetes |
|
2.21.0 |
|
2.2.0—2.21.0 |
|
Ldap |
0.12.8 |
|
2.2.0—0.12.8 | |
|
MS Graph |
0.10.5 |
|
2.2.0—0.10.5 | |
|
Orchestrator Backend Module Loki |
|
1.5.1 |
|
2.2.0—1.5.1 |
|
Orchestrator Form Widgets |
|
2.2.0 |
|
2.2.0—2.2.0 |
|
Orchestrator |
6.2.1 |
|
2.2.0—6.2.1 | |
|
Orchestrator |
|
8.13.1 |
|
2.2.0—8.13.1 |
|
Orchestrator |
|
1.8.1 |
|
2.2.0—1.8.1 |
|
Org |
0.7.8 |
|
2.2.0—0.7.8 | |
|
Quickstart |
2.2.0 |
|
2.2.0—2.2.0 | |
|
RBAC |
2.3.1 |
|
2.2.0—2.3.1 | |
|
Regex |
2.18.0 |
|
2.2.0—2.18.0 | |
|
Signals |
0.0.34 |
|
2.2.0—0.0.34 | |
|
Signals |
0.3.18 |
|
2.2.0—0.3.18 | |
|
Tech Radar |
1.22.0 |
|
2.2.0—1.22.0 | |
|
Tech Radar |
1.21.0 |
|
2.2.0—1.21.0 | |
|
TechDocs Module Addons Contrib |
1.1.39 |
|
2.2.0—1.1.39 | |
|
TechDocs |
1.18.0 |
|
2.2.0—1.18.0 | |
|
TechDocs |
2.2.4 |
|
2.2.0—2.2.4 | |
|
Topology |
3.0.1 |
|
2.2.0—3.0.1 |
- 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 19 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 | Plugin Version | Path and required variables | Artifact Tag |
|---|---|---|---|---|
|
Events Backend Module GitHub |
0.4.15 |
|
2.2.0—0.4.15 | |
|
Extensions |
1.0.1 |
|
2.2.0—1.0.1 | |
|
Extensions |
|
1.0.1 |
|
2.2.0—1.0.1 |
|
Extensions |
1.0.1 |
|
2.2.0—1.0.1 | |
|
GitLab |
0.11.10 |
|
2.2.0—0.11.10 | |
|
Notifications |
0.5.20 |
|
2.2.0—0.5.20 | |
|
Notifications |
0.3.24 |
|
2.2.0—0.3.24 | |
|
Notifications |
0.6.8 |
|
2.2.0—0.6.8 | |
|
Pingidentity |
|
0.15.0 |
|
2.2.0—0.15.0 |
|
Scaffolder Relation Processor |
|
2.17.1 |
|
2.2.0—2.17.1 |
|
Scorecard Backend Module Dependabot |
|
1.1.3 |
|
2.2.0—1.1.3 |
|
Scorecard Backend Module Dora |
|
0.2.2 |
|
2.2.0—0.2.2 |
|
Scorecard Backend Module Filecheck |
|
1.1.3 |
|
2.2.0—1.1.3 |
|
Scorecard Backend Module GitHub |
|
4.4.1 |
|
2.2.0—4.4.1 |
|
Scorecard Backend Module Jira |
|
4.4.1 |
|
2.2.0—4.4.1 |
|
Scorecard Backend Module Openssf |
|
2.0.0 |
|
2.2.0—2.0.0 |
|
Scorecard Backend Module SonarQube |
|
4.4.1 |
|
2.2.0—4.4.1 |
|
Scorecard |
4.4.1 |
|
2.2.0—4.4.1 | |
|
Scorecard |
4.4.1 |
|
2.2.0—4.4.1 |
Chapter 4. Red Hat community supported plugins
There are no community supported plugins in this release of Red Hat Developer Hub (RHDH)
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 |