Dynamic plugins reference
Abstract
Preface
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 preinstalled dynamic plugins are enabled by default:
-
@janus-idp/backstage-plugin-analytics-provider-segment -
@janus-idp/backstage-scaffolder-backend-module-quay -
@janus-idp/backstage-scaffolder-backend-module-regex -
@backstage/plugin-techdocs-backend -
@backstage/plugin-techdocs
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 ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
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: ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
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.
1.1. Red Hat supported plugins
Red Hat supports the following 17 plugins:
| Name | Plugin | Version | Path and required variables |
|---|---|---|---|
|
Analytics Provider Segment |
1.7.3 |
| |
|
Argo CD |
2.6.5 |
| |
|
Argo CD |
3.0.3 |
| |
|
GitHub |
0.6.5 |
| |
|
GitHub Org |
0.1.17 |
| |
|
Keycloak |
1.13.4 |
| |
|
Kubernetes |
0.18.3 |
| |
|
OCM |
4.4.5 |
| |
|
OCM |
4.4.4 |
| |
|
Quay |
1.11.9 |
| |
|
Quay |
1.7.2 |
| |
|
RBAC |
1.29.7 |
| |
|
Regex |
1.7.2 |
| |
|
TechDocs |
1.10.7 |
| |
|
TechDocs |
1.10.9 |
| |
|
Tekton |
3.12.9 |
| |
|
Topology |
1.27.7 |
|
- For more information about configuring KeyCloak, see Configuring dynamic plugins.
- For more information about configuring TechDocs, see Configuring the TechDocs plugin in Red Hat Developer Hub.
1.2. Technology Preview plugins
Red Hat Developer Hub includes a select number of Technology Preview plugins, available for customers to configure and enable. These plugins are provided with support scoped per Technical Preview terms, 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.
1.2.1. Red Hat Technology Preview plugins
Red Hat provides Technology Preview support for the following 7 plugins:
| Name | Plugin | Version | Path and required variables |
|---|---|---|---|
|
Ansible Automation Platform (AAP) |
1.9.4 |
| |
|
ACR |
1.7.16 |
| |
|
Bulk Import |
1.4.11 |
| |
|
JFrog Artifactory |
1.7.10 |
| |
|
Nexus Repository Manager |
1.9.10 |
| |
|
ServiceNow |
1.7.3 |
| |
|
SonarQube |
1.7.2 |
|
- A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See Other installable plugins in the Configuring plugins in Red Hat Developer Hub guide for further details. See Dynamic plugins support matrix.
1.2.2. Community plugins
Red Hat Developer Hub (RHDH) includes a select number of community-supported plugins, available for customers to enable and configure. These community plugins are augmented by Red Hat to be dynamic plugin capable, and are provided with support scoped per Technical Preview terms.
Details on how Red Hat provides support for bundled community dynamic plugins are available on the Red Hat Developer Support Policy page.
RHDH includes the following 43 community plugins:
| Name | Plugin | Version | Path and required variables |
|---|---|---|---|
|
3scale |
1.8.2 |
| |
|
Argo CD |
1.1.27 |
| |
|
Argo CD (Red Hat) |
1.8.10 |
| |
|
Azure |
0.1.14 |
| |
|
Azure Devops |
0.4.4 |
| |
|
Azure Devops |
0.6.5 |
| |
|
Azure Repositories |
|
0.3.0 |
|
|
Bitbucket Cloud |
0.2.9 |
| |
|
Bitbucket Cloud |
0.1.12 |
| |
|
Bitbucket Server |
0.1.36 |
| |
|
Bitbucket Server |
|
0.1.12 |
|
|
Bulk Import |
1.5.5 |
| |
|
Datadog |
2.3.0 |
| |
|
Dynatrace |
10.0.4 |
| |
|
Gerrit |
0.1.14 |
| |
|
GitHub |
0.4.0 |
| |
|
GitHub Actions |
0.6.16 |
| |
|
GitHub Insights |
2.3.31 |
| |
|
GitHub Issues |
0.4.2 |
| |
|
GitHub Pull Requests |
2.5.29 |
| |
|
GitLab |
6.6.0 |
| |
|
GitLab |
0.3.21 |
| |
|
GitLab |
6.6.0 |
| |
|
GitLab |
0.4.4 |
| |
|
GitLab Org |
0.0.5 |
| |
|
Http Request |
4.3.2 |
| |
|
Jenkins |
0.9.10 |
| |
|
Jenkins |
0.4.5 |
| |
|
Jira |
2.5.8 |
| |
|
Kubernetes |
0.11.12 |
| |
|
Ldap |
0.7.0 |
| |
|
Lighthouse |
0.4.20 |
| |
|
Logs |
0.0.1 |
| |
|
MS Graph |
0.5.30 |
| |
|
PagerDuty |
0.15.0 |
| |
|
PagerDuty |
0.6.1 |
| |
|
Pingidentity |
|
0.1.2 |
|
|
Scaffolder Relation Processor |
|
1.2.6 |
|
|
Security Insights |
2.3.19 |
| |
|
SonarQube |
0.7.17 |
| |
|
SonarQube |
0.2.20 |
| |
|
Tech Radar |
0.7.4 |
| |
|
Utils |
1.17.1 |
|
Chapter 2. Other installable plugins
The following Technology Preview plugins are not preinstalled and must be installed from an external source:
| 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 | ||
|
Orchestrator Frontend |
1.22.6 | ||
|
Orchestrator Backend |
1.22.9 |
- The above Red Hat Ansible Automation Platform (RHAAP) plugins, can be used as a replacement for the older plugin listed in the Technology Preview plugins section of the Configuring plugins in Red Hat Developer Hub guide.