Dynamic plugins reference


Red Hat Developer Hub 1.3

Red Hat Customer Content Services

Abstract

Red Hat Developer Hub 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.

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
Note

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:

NamePluginVersionPath and required variables

Analytics Provider Segment

@janus-idp/backstage-plugin-analytics-provider-segment

1.7.3

./dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment

SEGMENT_WRITE_KEY

SEGMENT_TEST_MODE

Argo CD

@roadiehq/backstage-plugin-argo-cd

2.6.5

./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd

Argo CD

@roadiehq/backstage-plugin-argo-cd-backend

3.0.3

./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd-backend-dynamic

ARGOCD_USERNAME

ARGOCD_PASSWORD

ARGOCD_INSTANCE1_URL

ARGOCD_AUTH_TOKEN

ARGOCD_INSTANCE2_URL

ARGOCD_AUTH_TOKEN2

GitHub

@backstage/plugin-catalog-backend-module-github

0.6.5

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic

GITHUB_ORG

GitHub Org

@backstage/plugin-catalog-backend-module-github-org

0.1.17

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic

GITHUB_URL

GITHUB_ORG

Keycloak

@janus-idp/backstage-plugin-keycloak-backend

1.13.4

./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic

KEYCLOAK_BASE_URL

KEYCLOAK_LOGIN_REALM

KEYCLOAK_REALM

KEYCLOAK_CLIENT_ID

KEYCLOAK_CLIENT_SECRET

Kubernetes

@backstage/plugin-kubernetes-backend

0.18.3

./dynamic-plugins/dist/backstage-plugin-kubernetes-backend-dynamic

K8S_CLUSTER_NAME

K8S_CLUSTER_URL

K8S_CLUSTER_TOKEN

OCM

@janus-idp/backstage-plugin-ocm

4.4.5

./dynamic-plugins/dist/janus-idp-backstage-plugin-ocm

OCM

@janus-idp/backstage-plugin-ocm-backend

4.4.4

./dynamic-plugins/dist/janus-idp-backstage-plugin-ocm-backend-dynamic

OCM_HUB_NAME

OCM_HUB_URL

moc_infra_token

Quay

@janus-idp/backstage-plugin-quay

1.11.9

./dynamic-plugins/dist/janus-idp-backstage-plugin-quay

Quay

@janus-idp/backstage-scaffolder-backend-module-quay

1.7.2

./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-quay-dynamic

RBAC

@janus-idp/backstage-plugin-rbac

1.29.7

./dynamic-plugins/dist/janus-idp-backstage-plugin-rbac

Regex

@janus-idp/backstage-scaffolder-backend-module-regex

1.7.2

./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-regex-dynamic

TechDocs

@backstage/plugin-techdocs

1.10.7

./dynamic-plugins/dist/backstage-plugin-techdocs

TechDocs

@backstage/plugin-techdocs-backend

1.10.9

./dynamic-plugins/dist/backstage-plugin-techdocs-backend-dynamic

Tekton

@janus-idp/backstage-plugin-tekton

3.12.9

./dynamic-plugins/dist/janus-idp-backstage-plugin-tekton

Topology

@janus-idp/backstage-plugin-topology

1.27.7

./dynamic-plugins/dist/janus-idp-backstage-plugin-topology

Note

1.2. Technology Preview plugins

Important

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:

NamePluginVersionPath and required variables

Ansible Automation Platform (AAP)

@janus-idp/backstage-plugin-aap-backend

1.9.4

./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic

AAP_BASE_URL

AAP_AUTH_TOKEN

ACR

@janus-idp/backstage-plugin-acr

1.7.16

./dynamic-plugins/dist/janus-idp-backstage-plugin-acr

Bulk Import

@janus-idp/backstage-plugin-bulk-import

1.4.11

./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import

JFrog Artifactory

@janus-idp/backstage-plugin-jfrog-artifactory

1.7.10

./dynamic-plugins/dist/janus-idp-backstage-plugin-jfrog-artifactory

Nexus Repository Manager

@janus-idp/backstage-plugin-nexus-repository-manager

1.9.10

./dynamic-plugins/dist/janus-idp-backstage-plugin-nexus-repository-manager

ServiceNow

@janus-idp/backstage-scaffolder-backend-module-servicenow

1.7.3

./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-servicenow-dynamic

SERVICENOW_BASE_URL

SERVICENOW_USERNAME

SERVICENOW_PASSWORD

SonarQube

@janus-idp/backstage-scaffolder-backend-module-sonarqube

1.7.2

./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-sonarqube-dynamic

Note

1.2.2. Community plugins

Important

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:

NamePluginVersionPath and required variables

3scale

@backstage-community/plugin-3scale-backend

1.8.2

./dynamic-plugins/dist/backstage-community-plugin-3scale-backend-dynamic

THREESCALE_BASE_URL

THREESCALE_ACCESS_TOKEN

Argo CD

@roadiehq/scaffolder-backend-argocd

1.1.27

./dynamic-plugins/dist/roadiehq-scaffolder-backend-argocd-dynamic

ARGOCD_USERNAME

ARGOCD_PASSWORD

ARGOCD_INSTANCE1_URL

ARGOCD_AUTH_TOKEN

ARGOCD_INSTANCE2_URL

ARGOCD_AUTH_TOKEN2

Argo CD (Red Hat)

@backstage-community/plugin-redhat-argocd

1.8.10

./dynamic-plugins/dist/backstage-community-plugin-redhat-argocd

Azure

@backstage/plugin-scaffolder-backend-module-azure

0.1.14

./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-azure-dynamic

Azure Devops

@backstage/plugin-azure-devops

0.4.4

./dynamic-plugins/dist/backstage-plugin-azure-devops

Azure Devops

@backstage/plugin-azure-devops-backend

0.6.5

./dynamic-plugins/dist/backstage-plugin-azure-devops-backend-dynamic

AZURE_TOKEN

AZURE_ORG

Azure Repositories

@parfuemerie-douglas/scaffolder-backend-module-azure-repositories

0.3.0

./dynamic-plugins/dist/parfuemerie-douglas-scaffolder-backend-module-azure-repositories

Bitbucket Cloud

@backstage/plugin-catalog-backend-module-bitbucket-cloud

0.2.9

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-cloud-dynamic

BITBUCKET_WORKSPACE

Bitbucket Cloud

@backstage/plugin-scaffolder-backend-module-bitbucket-cloud

0.1.12

./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-cloud-dynamic

Bitbucket Server

@backstage/plugin-catalog-backend-module-bitbucket-server

0.1.36

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-bitbucket-server-dynamic

BITBUCKET_HOST

Bitbucket Server

@backstage/plugin-scaffolder-backend-module-bitbucket-server

0.1.12

./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-bitbucket-server-dynamic

Bulk Import

@janus-idp/backstage-plugin-bulk-import-backend

1.5.5

./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic

Datadog

@roadiehq/backstage-plugin-datadog

2.3.0

./dynamic-plugins/dist/roadiehq-backstage-plugin-datadog

Dynatrace

@backstage/plugin-dynatrace

10.0.4

./dynamic-plugins/dist/backstage-plugin-dynatrace

Gerrit

@backstage/plugin-scaffolder-backend-module-gerrit

0.1.14

./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gerrit-dynamic

GitHub

@backstage/plugin-scaffolder-backend-module-github

0.4.0

./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-github-dynamic

GitHub Actions

@backstage/plugin-github-actions

0.6.16

./dynamic-plugins/dist/backstage-plugin-github-actions

GitHub Insights

@roadiehq/backstage-plugin-github-insights

2.3.31

./dynamic-plugins/dist/roadiehq-backstage-plugin-github-insights

GitHub Issues

@backstage/plugin-github-issues

0.4.2

./dynamic-plugins/dist/backstage-plugin-github-issues

GitHub Pull Requests

@roadiehq/backstage-plugin-github-pull-requests

2.5.29

./dynamic-plugins/dist/roadiehq-backstage-plugin-github-pull-requests

GitLab

@immobiliarelabs/backstage-plugin-gitlab

6.6.0

./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab

GitLab

@backstage/plugin-catalog-backend-module-gitlab

0.3.21

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-dynamic

GitLab

@immobiliarelabs/backstage-plugin-gitlab-backend

6.6.0

./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab-backend-dynamic

GITLAB_HOST

GITLAB_TOKEN

GitLab

@backstage/plugin-scaffolder-backend-module-gitlab

0.4.4

./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gitlab-dynamic

GitLab Org

@backstage/plugin-catalog-backend-module-gitlab-org

0.0.5

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-org-dynamic

Http Request

@roadiehq/scaffolder-backend-module-http-request

4.3.2

./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-http-request-dynamic

Jenkins

@backstage/plugin-jenkins

0.9.10

./dynamic-plugins/dist/backstage-plugin-jenkins

Jenkins

@backstage/plugin-jenkins-backend

0.4.5

./dynamic-plugins/dist/backstage-plugin-jenkins-backend-dynamic

JENKINS_URL

JENKINS_USERNAME

JENKINS_TOKEN

Jira

@roadiehq/backstage-plugin-jira

2.5.8

./dynamic-plugins/dist/roadiehq-backstage-plugin-jira

Kubernetes

@backstage/plugin-kubernetes

0.11.12

./dynamic-plugins/dist/backstage-plugin-kubernetes

Ldap

@backstage/plugin-catalog-backend-module-ldap

0.7.0

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-ldap-dynamic

Lighthouse

@backstage/plugin-lighthouse

0.4.20

./dynamic-plugins/dist/backstage-plugin-lighthouse

Logs

@backstage/plugin-catalog-backend-module-logs

0.0.1

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-logs-dynamic

MS Graph

@backstage/plugin-catalog-backend-module-msgraph

0.5.30

./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-msgraph-dynamic

PagerDuty

@pagerduty/backstage-plugin

0.15.0

./dynamic-plugins/dist/pagerduty-backstage-plugin

PagerDuty

@pagerduty/backstage-plugin-backend

0.6.1

./dynamic-plugins/dist/pagerduty-backstage-plugin-backend-dynamic

PAGERDUTY_API_BASE

PAGERDUTY_CLIENT_ID

PAGERDUTY_CLIENT_SECRET

PAGERDUTY_SUBDOMAIN

Pingidentity

@backstage-community/plugin-catalog-backend-module-pingidentity

0.1.2

./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-pingidentity-dynamic

Scaffolder Relation Processor

@backstage-community/plugin-catalog-backend-module-scaffolder-relation-processor

1.2.6

./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-scaffolder-relation-processor-dynamic

Security Insights

@roadiehq/backstage-plugin-security-insights

2.3.19

./dynamic-plugins/dist/roadiehq-backstage-plugin-security-insights

SonarQube

@backstage/plugin-sonarqube

0.7.17

./dynamic-plugins/dist/backstage-plugin-sonarqube

SonarQube

@backstage/plugin-sonarqube-backend

0.2.20

./dynamic-plugins/dist/backstage-plugin-sonarqube-backend-dynamic

SONARQUBE_URL

SONARQUBE_TOKEN

Tech Radar

@backstage/plugin-tech-radar

0.7.4

./dynamic-plugins/dist/backstage-plugin-tech-radar

Utils

@roadiehq/scaffolder-backend-module-utils

1.17.1

./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-utils-dynamic

2. Other installable plugins

The following Technology Preview plugins are not preinstalled and must be installed from an external source:

NamePluginVersionInstallation Details

Ansible Automation Platform Frontend

@ansible/plugin-backstage-rhaap

1.0.0

Learn more

Ansible Automation Platform

@ansible/plugin-backstage-rhaap-backend

1.0.0

 

Ansible Automation Platform Scaffolder Backend

@ansible/plugin-scaffolder-backend-module-backstage-rhaap

1.0.0

 

Orchestrator Frontend

@janus-idp/backstage-plugin-orchestrator

1.22.6

Learn more

Orchestrator Backend

@janus-idp/backstage-plugin-orchestrator-backend-dynamic

1.22.9

 
Note
  • 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.
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.