Chapter 5. Installing dynamic plugins

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.

5.1. Helm deployment
Copy link

To deploy a Red Hat Developer Hub (RHDH) instance, you use a Helm Chart which is a flexible installation method.

You can sideload dynamic plugins into your Developer Hub instance without having to recompile your code or rebuild the container.

To install dynamic plugins, you use the following global.dynamic parameters in your Helm Chart:

plugins: This field encompasses the list of dynamic plugins slated for installation. By default, it is an empty list. A package can be specified either as a local relative path (starting with ./) to the dynamic plugin’s folder or as a package specification in an NPM repository.
includes: This field contains a roster of YAML files utilizing the same syntax. The plugins list from these files will be incorporated, and potentially overridden, by the plugins list in the primary helm values. The default configuration includes the dynamic-plugins.default.yaml file, which encompasses all the dynamic plugins included in Developer Hub, whether enabled or disabled by default.

5.2. Dynamic plugin installation using the Helm Chart
Copy link

You can include a dynamic plugin in RHDH by appending an entry to the global.dynamic.plugins list in your Helm Chart.

Each entry must contain the following fields:

package: a package specification of the dynamic plugin package to be installed (can be from a local path or an NPM repository)
integrity: (optional for local packages) An integrity checksum in the form of <alg>-<digest> for the specific package. Supported algorithms include sha256, sha384 and sha512.
pluginConfig: an optional plugin-specific app-config yaml fragment. See plugin configuration for more details.
disabled: disables the dynamic plugin if set to true. Default: false.

5.2.1. Examples
Copy link

Example 1: Enabling two plugins from a local and remote source, one requiring a specific app-config

global:
  dynamic:
    plugins:
      - package: <a local package-spec used by npm pack>
      - package: <a remote package-spec used by npm pack>
        integrity: sha512-<some hash>
        pluginConfig: ...

Example 2: Disabling a plugin from an included file

global:
  dynamic:
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: <some imported plugins listed in dynamic-plugins.default.yaml>
        disabled: true

Example 3: Enabling a plugin from an included file

global:
  dynamic:
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: <some imported plugins listed in dynamic-plugins.custom.yaml>
        disabled: false

5.3. Dynamic plugins pre-loaded in Red Hat Developer Hub
Copy link

Red Hat Developer Hub (Developer Hub) is pre-loaded with a selection of dynamic plugins. Most of these dynamic plugins are disabled by default due to the need for mandatory configuration.

For a complete list of dynamic plugins that are included in this release of RHDH, see the dynamic plugins matrix table.

Upon application startup, for each plugin that is disabled by default, the install-dynamic-plugins init container within the Developer Hub pod’s log displays a line similar to the following:

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

To activate this plugin, simply add a package with the same name and adjust the disabled field in the Helm Chart values as shown below:

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 this default configuration.

5.4. Basic configuration of dynamic plugins
Copy link

Some dynamic plugins require environment variables to be set. If a mandatory environment variable is not set, and the plugin is enabled, then the application might fail at startup.

The mandatory environment variables for each plugin are listed in the dynamic plugins matrix table.

Note

Zib-bomb detection When installing some dynamic plugin containing large files, if the installation script considers the package archive to be a Zib-Bomb, the installation fails.

To increase the maximum permitted size of a file inside a package archive, you can increase the MAX_ENTRY_SIZE environment value of the deployment install-dynamic-plugins initContainer from the default size of 20000000 bytes.

5.5. Dynamic plugins included in Red Hat Developer Hub
Copy link

Important

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.

Additional detail on how Red Hat provides support for bundled community dynamic plugins is available on the Red Hat Developer Support Policy page.

There are 47 plugins.

Expand

Table 5.1. Dynamic plugins support matrix
Name	Role	Plugin	Description	Version	Support Level	Path	Required Variables	Default
3scale	Backend	@janus-idp/backstage-plugin-3scale-backend	The 3scale Backstage provider plugin synchronizes the 3scale content into the Backstage catalog.	1.3.6	Red Hat Tech Preview	./dynamic-plugins/dist/janus-idp-backstage-plugin-3scale-backend-dynamic	`3SCALE_BASE_URL` `3SCALE_ACCESS_TOKEN`	Disabled
AAP	Backend	@janus-idp/backstage-plugin-aap-backend		1.4.5	Red Hat Tech Preview	./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic	`AAP_BASE_URL` `AAP_AUTH_TOKEN`	Disabled
ACR	Frontend	@janus-idp/backstage-plugin-acr		1.2.4	Red Hat Tech Preview	./dynamic-plugins/dist/janus-idp-backstage-plugin-acr		Disabled
Analytics Provider Segment	Frontend	@janus-idp/backstage-plugin-analytics-provider-segment	This plugin provides an implementation of the Backstage Analytics API for Segment. Once installed and configured, analytics events will be sent to Segment as your users navigate and use your Backstage instance.	1.2.0	Production	./dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment	`SEGMENT_WRITE_KEY` `SEGMENT_MASK_IP` `SEGMENT_TEST_MODE`	Disabled
Argo CD	Frontend	@roadiehq/backstage-plugin-argo-cd	Backstage plugin to view and interact with Argo CD.	2.3.5	Production	./dynamic-plugins/dist/roadiehq-backstage-plugin-argo-cd		Disabled
Argo CD	Backend	@roadiehq/backstage-plugin-argo-cd-backend	Backstage plugin Argo CD backend	2.11.3	Production	./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`	Disabled
Argo CD	Backend	@roadiehq/scaffolder-backend-argocd		1.1.17	Community Support	./dynamic-plugins/dist/roadiehq-scaffolder-backend-argocd-dynamic	`ARGOCD_USERNAME` `ARGOCD_PASSWORD` `ARGOCD_INSTANCE1_URL` `ARGOCD_AUTH_TOKEN` `ARGOCD_INSTANCE2_URL` `ARGOCD_AUTH_TOKEN2`	Disabled
Azure Devops	Frontend	@backstage/plugin-azure-devops		0.3.7	Community Support	./dynamic-plugins/dist/backstage-plugin-azure-devops		Disabled
Azure Devops	Backend	@backstage/plugin-azure-devops-backend	Azure DevOps backend plugin that contains the API for retrieving builds, pull requests, etc. which is used by the Azure DevOps frontend plugin.	0.4.3	Tech Preview	./dynamic-plugins/dist/backstage-plugin-azure-devops-backend-dynamic	`AZURE_TOKEN` `AZURE_ORG`	Disabled
Datadog	Frontend	@roadiehq/backstage-plugin-datadog	Embed Datadog graphs and dashboards into Backstage.	2.2.0	Community Support	./dynamic-plugins/dist/roadiehq-backstage-plugin-datadog		Disabled
Dynatrace	Frontend	@backstage/plugin-dynatrace	A Backstage plugin that integrates towards Dynatrace.	7.0.5	Community Support	./dynamic-plugins/dist/backstage-plugin-dynatrace		Disabled
Github	Backend	@backstage/plugin-catalog-backend-module-github	A Backstage catalog backend module that helps integrate towards Github	0.4.4	Community Support	./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic	`GITHUB_ORG`	Disabled
Github	Backend	@backstage/plugin-catalog-backend-module-github-org	The github-org backend module for the catalog plugin.	0.1.0	Community Support	./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic	`GITHUB_ORG_URL`	Disabled
Github	Frontend	@backstage/plugin-github-actions	A Backstage plugin that integrates towards GitHub Actions	0.6.6	Community Support	./dynamic-plugins/dist/backstage-plugin-github-actions		Disabled
Github	Frontend	@backstage/plugin-github-issues	A Backstage plugin that integrates towards GitHub Issues	0.2.14	Community Support	./dynamic-plugins/dist/backstage-plugin-github-issues		Disabled
Github	Frontend	@roadiehq/backstage-plugin-github-insights	Backstage plugin to provide Readmes, Top Contributors and other widgets.	2.3.21	Community Support	./dynamic-plugins/dist/roadiehq-backstage-plugin-github-insights		Disabled
Github	Frontend	@roadiehq/backstage-plugin-github-pull-requests	Backstage plugin to view and interact with GitHub pull requests.	2.5.18	Community Support	./dynamic-plugins/dist/roadiehq-backstage-plugin-github-pull-requests		Disabled
Github	Frontend	@roadiehq/backstage-plugin-security-insights	Backstage plugin to add security insights for GitHub repos.	2.3.9	Community Support	./dynamic-plugins/dist/roadiehq-backstage-plugin-security-insights		Disabled
Gitlab	Backend	@backstage/plugin-catalog-backend-module-gitlab	Extracts repositories out of an GitLab instance.	0.3.3	Community Support	./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-gitlab-dynamic		Disabled
Gitlab	Backend	@backstage/plugin-scaffolder-backend-module-gitlab	A module for the scaffolder backend that lets you interact with gitlab	0.2.9	Community Support	./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-gitlab-dynamic		Disabled
Gitlab	Frontend	@immobiliarelabs/backstage-plugin-gitlab	Backstage plugin to interact with GitLab	6.2.0	Community Support	./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab		Disabled
Gitlab	Backend	@immobiliarelabs/backstage-plugin-gitlab-backend	Backstage plugin to interact with GitLab	6.2.0	Community Support	./dynamic-plugins/dist/immobiliarelabs-backstage-plugin-gitlab-backend-dynamic	`GITLAB_HOST` `GITLAB_TOKEN`	Disabled
Jenkins	Frontend	@backstage/plugin-jenkins	A Backstage plugin that integrates towards Jenkins	0.9.0	Community Support	./dynamic-plugins/dist/backstage-plugin-jenkins		Disabled
Jenkins	Backend	@backstage/plugin-jenkins-backend	A Backstage backend plugin that integrates towards Jenkins	0.3.0	Community Support	./dynamic-plugins/dist/backstage-plugin-jenkins-backend-dynamic	`JENKINS_URL` `JENKINS_USERNAME` `JENKINS_TOKEN`	Disabled
Jfrog Artifactory	Frontend	@janus-idp/backstage-plugin-jfrog-artifactory	The Jfrog Artifactory plugin displays information about your container images within the Jfrog Artifactory registry.	1.2.4	Red Hat Tech Preview	./dynamic-plugins/dist/janus-idp-backstage-plugin-jfrog-artifactory		Disabled
Jira	Frontend	@roadiehq/backstage-plugin-jira	Backstage plugin to view and interact with Jira	2.4.11	Community Support	./dynamic-plugins/dist/roadiehq-backstage-plugin-jira		Disabled
Keycloak	Backend	@janus-idp/backstage-plugin-keycloak-backend	The Keycloak backend plugin integrates Keycloak into Backstage.	1.7.6	Production	./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic	`KEYCLOAK_BASE_URL` `KEYCLOAK_LOGIN_REALM` `KEYCLOAK_REALM` `KEYCLOAK_CLIENT_ID` `KEYCLOAK_CLIENT_SECRET`	Disabled
Kubernetes	Frontend	@backstage/plugin-kubernetes	A Backstage plugin that integrates towards Kubernetes	0.11.0	Community Support	./dynamic-plugins/dist/backstage-plugin-kubernetes		Enabled
Kubernetes	Backend	@backstage/plugin-kubernetes-backend	A Backstage backend plugin that integrates towards Kubernetes	0.13.0	Production	./dynamic-plugins/dist/backstage-plugin-kubernetes-backend-dynamic	`K8S_CLUSTER_NAME` `K8S_CLUSTER_URL` `K8S_CLUSTER_TOKEN`	Enabled
Kubernetes	Frontend	@janus-idp/backstage-plugin-topology	The Topology plugin enables you to visualize the workloads such as Deployment, Job, Daemonset, Statefulset, CronJob, and Pods powering any service on the Kubernetes cluster.	1.16.4	Production	./dynamic-plugins/dist/janus-idp-backstage-plugin-topology		Enabled
Lighthouse	Frontend	@backstage/plugin-lighthouse	A Backstage plugin that integrates towards Lighthouse	0.4.10	Community Support	./dynamic-plugins/dist/backstage-plugin-lighthouse		Disabled
Nexus Repository Manager	Frontend	@janus-idp/backstage-plugin-nexus-repository-manager	The Nexus Repository Manager plugin displays the information about your build artifacts that are available in the Nexus Repository Manager in your Backstage application.	1.4.4	Red Hat Tech Preview	./dynamic-plugins/dist/janus-idp-backstage-plugin-nexus-repository-manager		Disabled
OCM	Frontend	@janus-idp/backstage-plugin-ocm	The Open Cluster Management (OCM) plugin integrates your Backstage instance with the `MultiClusterHub` and `MultiCluster` engines of OCM.	3.5.0	Production	./dynamic-plugins/dist/janus-idp-backstage-plugin-ocm		Disabled
OCM	Backend	@janus-idp/backstage-plugin-ocm-backend		3.4.6	Production	./dynamic-plugins/dist/janus-idp-backstage-plugin-ocm-backend-dynamic	`OCM_HUB_NAME` `OCM_HUB_URL` `moc_infra_token`	Disabled
Pagerduty	Frontend	@backstage/plugin-pagerduty	A Backstage plugin that integrates towards PagerDuty	0.6.6	Community Support	./dynamic-plugins/dist/backstage-plugin-pagerduty		Disabled
Quay	Frontend	@janus-idp/backstage-plugin-quay	The Quay plugin displays the information about your container images within the Quay registry in your Backstage application.	1.4.6	Production	./dynamic-plugins/dist/janus-idp-backstage-plugin-quay		Disabled
Quay	Backend	@janus-idp/backstage-scaffolder-backend-module-quay	This module provides Backstage template actions for Quay.	1.2.1	Production	./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-quay-dynamic		Enabled
Regex	Backend	@janus-idp/backstage-scaffolder-backend-module-regex	This plugin provides Backstage template actions for RegExp.	1.2.1	Production	./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-regex-dynamic		Enabled
Scaffolder	Backend	@roadiehq/scaffolder-backend-module-utils	This contains a collection of actions to use in scaffolder templates.	1.10.4	Community Support	./dynamic-plugins/dist/roadiehq-scaffolder-backend-module-utils-dynamic		Enabled
ServiceNow	Backend	@janus-idp/backstage-scaffolder-backend-module-servicenow	This plugin provides Backstage template actions for ServiceNow.	1.2.3	Red Hat Tech Preview	./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-servicenow-dynamic	`SERVICENOW_BASE_URL` `SERVICENOW_USERNAME` `SERVICENOW_PASSWORD`	Disabled
SonarQube	Frontend	@backstage/plugin-sonarqube	A Backstage plugin to display SonarQube code quality and security results.	0.7.7	Community Support	./dynamic-plugins/dist/backstage-plugin-sonarqube		Disabled
SonarQube	Backend	@backstage/plugin-sonarqube-backend		0.2.8	Community Support	./dynamic-plugins/dist/backstage-plugin-sonarqube-backend-dynamic	`SONARQUBE_URL` `SONARQUBE_TOKEN`	Disabled
SonarQube	Backend	@janus-idp/backstage-scaffolder-backend-module-sonarqube	This module provides Backstage template actions for SonarQube.	1.2.1	Red Hat Tech Preview	./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-sonarqube-dynamic		Disabled
Tech Radar	Frontend	@backstage/plugin-tech-radar	A Backstage plugin that lets you display a Tech Radar for your organization	0.6.9	Community Support	./dynamic-plugins/dist/backstage-plugin-tech-radar		Disabled
Techdocs	Frontend	@backstage/plugin-techdocs	The Backstage plugin that renders technical documentation for your components	1.8.0	Production	./dynamic-plugins/dist/backstage-plugin-techdocs		Disabled
Techdocs	Backend	@backstage/plugin-techdocs-backend	The Backstage backend plugin that renders technical documentation for your components	1.8.0	Production	./dynamic-plugins/dist/backstage-plugin-techdocs-backend-dynamic	`TECHDOCS_BUILDER_TYPE` `TECHDOCS_GENERATOR_TYPE` `TECHDOCS_PUBLISHER_TYPE` `BUCKET_NAME` `BUCKET_REGION_VAULT` `BUCKET_URL` `AWS_ACCESS_KEY_ID` `AWS_SECRET_ACCESS_KEY`	Disabled
Tekton	Frontend	@janus-idp/backstage-plugin-tekton	The Tekton plugin enables you to visualize the PipelineRun resources available on the Kubernetes cluster.	3.1.3	Production	./dynamic-plugins/dist/janus-idp-backstage-plugin-tekton		Disabled

5.6. Installation and configuration of Ansible Automation Platform
Copy link

The Ansible Automation Platform (AAP) plugin synchronizes the accessible templates including job templates and workflow job templates from AAP into your Developer Hub catalog.

Important

The Ansible Automation Platform plugin is a Technology Preview feature only.

For more information on Red Hat Technology Preview features, see Technology Preview Features Scope.

Additional detail on how Red Hat provides support for bundled community dynamic plugins is available on the Red Hat Developer Support Policy page.

5.6.1. For administrators
Copy link

5.6.1.1. Installing and configuring the AAP Backend plugin
Copy link

The AAP backend plugin allows you to configure one or multiple providers using your app-config.yaml configuration file in Developer Hub.

Prerequisites

Your Developer Hub application is installed and running.
You have created an account in Ansible Automation Platform.

Installation

The AAP backend plugin is pre-loaded in Developer Hub with basic configuration properties. To enable it, set the disabled property to false as follows:

global:
  dynamic:
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic
        disabled: false

Basic configuration

To enable the AAP plugin, you must set the following environment variables:

AAP_BASE_URL: Base URL of the service
AAP AUTH TOKEN: Authentication token for the service

Advanced configuration

You can use the aap marker to configure the app-config.yaml file of Developer Hub as follows:

   catalog:
     providers:
       aap:
         dev:
           baseUrl: $(AAP_BASE_URL)
           authorization: 'Bearer ${AAP_AUTH_TOKEN}'
           owner: <owner>
           system: <system>
           schedule: # optional; same options as in TaskScheduleDefinition
             # supports cron, ISO duration, "human duration" as used in code
             frequency: { minutes: 1 }
             # supports ISO duration, "human duration" as used in code
             timeout: { minutes: 1 }

5.6.1.2. Log lines for AAP Backend plugin troubleshoot
Copy link

When you start your Developer Hub application, you can see the following log lines:

[1] 2023-02-13T15:26:09.356Z catalog info Discovered ResourceEntity API type=plugin target=AapResourceEntityProvider:dev
[1] 2023-02-13T15:26:09.423Z catalog info Discovered ResourceEntity Red Hat Event (DEV, v1.2.0) type=plugin target=AapResourceEntityProvider:dev
[1] 2023-02-13T15:26:09.620Z catalog info Discovered ResourceEntity Red Hat Event (TEST, v1.1.0) type=plugin target=AapResourceEntityProvider:dev
[1] 2023-02-13T15:26:09.819Z catalog info Discovered ResourceEntity Red Hat Event (PROD, v1.1.0) type=plugin target=AapResourceEntityProvider:dev
[1] 2023-02-13T15:26:09.819Z catalog info Applying the mutation with 3 entities type=plugin target=AapResourceEntityProvider:dev

5.6.2. For users
Copy link

5.6.2.1. Accessing templates from AAP in Developer Hub
Copy link

When you have configured the AAP backend plugin successfully, it synchronizes the templates including job templates and workflow job templates from AAP and displays them on the Developer Hub Catalog page as Resources.

Prerequisites

Your Developer Hub application is installed and running.
You have installed the AAP backend plugin. For installation and configuration instructions, see Section 5.6.1.1, “Installing and configuring the AAP Backend plugin”.

Procedure

Open your Developer Hub application and Go to the Catalog page.
Select Resource from the Kind drop-down and job template or workflow job template from the Type drop-down on the left side of the page.

A list of all the available templates from AAP appears on the page.
Select a template from the list.
The OVERVIEW tab appears containing different cards, such as:
- About: Provides detailed information about the template.
- Relations: Displays the visual representation of the template and associated aspects.
- Links: Contains links to the AAP dashboard and the details page of the template.
- Has subcomponents: Displays a list of associated subcomponents.

5.7. Installation and configuration of Keycloak
Copy link

The Keycloak backend plugin, which integrates Keycloak into Developer Hub, has the following capabilities:

Synchronization of Keycloak users in a realm.
Synchronization of Keycloak groups and their users in a realm.

5.7.1. For administrators
Copy link

5.7.1.1. Installation
Copy link

The Keycloak plugin is pre-loaded in Developer Hub with basic configuration properties. To enable it, set the disabled property to false as follows:

global:
  dynamic:
    includes:
      - dynamic-plugins.default.yaml
    plugins:
      - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic
        disabled: false

5.7.1.2. Basic configuration
Copy link

To enable the Keycloak plugin, you must set the following environment variables:

KEYCLOAK_BASE_URL
KEYCLOAK_LOGIN_REALM
KEYCLOAK_REALM
KEYCLOAK_CLIENT_ID
KEYCLOAK_CLIENT_SECRET

5.7.1.3. Advanced configuration
Copy link

Schedule configuration

You can configure a schedule in the app-config.yaml file, as follows:

     catalog:
       providers:
         keycloakOrg:
           default:
             # ...
             # highlight-add-start
             schedule: # optional; same options as in TaskScheduleDefinition
               # supports cron, ISO duration, "human duration" as used in code
               frequency: { minutes: 1 }
               # supports ISO duration, "human duration" as used in code
               timeout: { minutes: 1 }
               initialDelay: { seconds: 15 }
               # highlight-add-end

Note

If you have made any changes to the schedule in the app-config.yaml file, then restart to apply the changes.

Keycloak query parameters

You can override the default Keycloak query parameters in the app-config.yaml file, as follows:

   catalog:
     providers:
       keycloakOrg:
         default:
           # ...
           # highlight-add-start
           userQuerySize: 500 # Optional
           groupQuerySize: 250 # Optional
           # highlight-add-end

Communication between Developer Hub and Keycloak is enabled by using the Keycloak API. Username and password, or client credentials are supported authentication methods.

The following table describes the parameters that you can configure to enable the plugin under catalog.providers.keycloakOrg.<ENVIRONMENT_NAME> object in the app-config.yaml file:

Expand

Name	Description	Default Value	Required
`baseUrl`	Location of the Keycloak server, such as `https://localhost:8443/auth`. Note that the newer versions of Keycloak omit the `/auth` context path.	""	Yes
`realm`	Realm to synchronize	`master`	No
`loginRealm`	Realm used to authenticate	`master`	No
`username`	Username to authenticate	""	Yes if using password based authentication
`password`	Password to authenticate	""	Yes if using password based authentication
`clientId`	Client ID to authenticate	""	Yes if using client credentials based authentication
`clientSecret`	Client Secret to authenticate	""	Yes if using client credentials based authentication
`userQuerySize`	Number of users to query at a time	`100`	No
`groupQuerySize`	Number of groups to query at a time	`100`	No

When using client credentials, the access type must be set to confidential and service accounts must be enabled. You must also add the following roles from the realm-management client role:

query-groups
query-users
view-users

5.7.1.4. Limitations
Copy link

If you have self-signed or corporate certificate issues, you can set the following environment variable before starting Developer Hub:

NODE_TLS_REJECT_UNAUTHORIZED=0

Note

The solution of setting the environment variable is not recommended.

5.7.2. For users
Copy link

5.7.2.1. Import of users and groups in Developer Hub using the Keycloak plugin
Copy link

After configuring the plugin successfully, the plugin imports the users and groups each time when started.

Note

If you set up a schedule, users and groups will also be imported.

After the first import is complete, you can select User to list the users from the catalog page:

You can see the list of users on the page:

When you select a user, you can see the information imported from Keycloak:

You can also select a group, view the list, and select or view the information imported from Keycloak for a group:

Chapter 5. Installing dynamic plugins

5.1. Helm deployment
Copy link

5.2. Dynamic plugin installation using the Helm Chart
Copy link

5.2.1. Examples
Copy link

5.3. Dynamic plugins pre-loaded in Red Hat Developer Hub
Copy link

5.4. Basic configuration of dynamic plugins
Copy link

5.5. Dynamic plugins included in Red Hat Developer Hub
Copy link

5.6. Installation and configuration of Ansible Automation Platform
Copy link

5.6.1. For administrators
Copy link

5.6.1.1. Installing and configuring the AAP Backend plugin
Copy link

5.6.1.2. Log lines for AAP Backend plugin troubleshoot
Copy link

5.6.2. For users
Copy link

5.6.2.1. Accessing templates from AAP in Developer Hub
Copy link

5.7. Installation and configuration of Keycloak
Copy link

5.7.1. For administrators
Copy link

5.7.1.1. Installation
Copy link

5.7.1.2. Basic configuration
Copy link

5.7.1.3. Advanced configuration
Copy link

5.7.1.4. Limitations
Copy link

5.7.2. For users
Copy link

5.7.2.1. Import of users and groups in Developer Hub using the Keycloak plugin
Copy link

Learn

Try, buy, & sell

Communities

About Red Hat

Making open source more inclusive

About Red Hat Documentation

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Chapter 5. Installing dynamic plugins

5.1. Helm deploymentCopy linkLink copied to clipboard!

5.2. Dynamic plugin installation using the Helm ChartCopy linkLink copied to clipboard!

5.2.1. ExamplesCopy linkLink copied to clipboard!

5.3. Dynamic plugins pre-loaded in Red Hat Developer HubCopy linkLink copied to clipboard!

5.4. Basic configuration of dynamic pluginsCopy linkLink copied to clipboard!

5.5. Dynamic plugins included in Red Hat Developer HubCopy linkLink copied to clipboard!

5.6. Installation and configuration of Ansible Automation PlatformCopy linkLink copied to clipboard!

5.6.1. For administratorsCopy linkLink copied to clipboard!

5.6.1.1. Installing and configuring the AAP Backend pluginCopy linkLink copied to clipboard!

5.6.1.2. Log lines for AAP Backend plugin troubleshootCopy linkLink copied to clipboard!

5.6.2. For usersCopy linkLink copied to clipboard!

5.6.2.1. Accessing templates from AAP in Developer HubCopy linkLink copied to clipboard!

5.7. Installation and configuration of KeycloakCopy linkLink copied to clipboard!

5.7.1. For administratorsCopy linkLink copied to clipboard!

5.7.1.1. InstallationCopy linkLink copied to clipboard!

5.7.1.2. Basic configurationCopy linkLink copied to clipboard!

5.7.1.3. Advanced configurationCopy linkLink copied to clipboard!

5.7.1.4. LimitationsCopy linkLink copied to clipboard!

5.7.2. For usersCopy linkLink copied to clipboard!

5.7.2.1. Import of users and groups in Developer Hub using the Keycloak pluginCopy linkLink copied to clipboard!

Learn

Try, buy, & sell

Communities

About Red Hat

Making open source more inclusive

About Red Hat Documentation

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

5.1. Helm deployment
Copy link

5.2. Dynamic plugin installation using the Helm Chart
Copy link

5.2.1. Examples
Copy link

5.3. Dynamic plugins pre-loaded in Red Hat Developer Hub
Copy link

5.4. Basic configuration of dynamic plugins
Copy link

5.5. Dynamic plugins included in Red Hat Developer Hub
Copy link

5.6. Installation and configuration of Ansible Automation Platform
Copy link

5.6.1. For administrators
Copy link

5.6.1.1. Installing and configuring the AAP Backend plugin
Copy link

5.6.1.2. Log lines for AAP Backend plugin troubleshoot
Copy link

5.6.2. For users
Copy link

5.6.2.1. Accessing templates from AAP in Developer Hub
Copy link

5.7. Installation and configuration of Keycloak
Copy link

5.7.1. For administrators
Copy link

5.7.1.1. Installation
Copy link

5.7.1.2. Basic configuration
Copy link

5.7.1.3. Advanced configuration
Copy link

5.7.1.4. Limitations
Copy link

5.7.2. For users
Copy link

5.7.2.1. Import of users and groups in Developer Hub using the Keycloak plugin
Copy link