|
| 1 | +[id="proc-enable-plugins-rhdh-container-image_{context}"] |
| 2 | += Enabling plugins added in the {product-very-short} container image |
| 3 | + |
| 4 | +In the {product-very-short} container image, a set of dynamic plugins is preloaded to enhance functionality. However, due to mandatory configuration requirements, most of the plugins are disabled. |
| 5 | + |
| 6 | +You can enable and configure the plugins in the {product-very-short} container image, including how to manage the default configuration, set necessary environment variables, and ensure the proper functionality of the plugins within your application. |
| 7 | + |
| 8 | +.Prerequisites |
| 9 | +* You have access to the link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file, which lists all preloaded plugins and their default configuration. |
| 10 | +* You have deployed the {product-very-short} application, and have access to the logs of the `install-dynamic-plugins` init container. |
| 11 | +* You have the necessary permissions to modify plugin configurations and access the application environment. |
| 12 | +* You have identified and set the required environment variables referenced by the plugin's default configuration. These environment variables must be defined in the Helm Chart or Operator configuration. |
| 13 | + |
| 14 | +.Procedure |
| 15 | +. Start your {product-very-short} application and access the logs of the `install-dynamic-plugins` init container within the {product-very-short} pod. |
| 16 | +. Identify the link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/dynamic_plugins_reference/index#red-hat-supported-plugins[Red Hat supported plugins] that are disabled by default. |
| 17 | +. Copy the package configuration from the link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file. |
| 18 | +. Open the plugin configuration file and locate the plugin entry you want to enable. |
| 19 | ++ |
| 20 | +The location of the plugin configuration file varies based on the deployment method. For more details, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-config-dynamic-plugins-rhdh-operator_rhdh-installing-rhdh-plugins[Installing dynamic plugins with the {product} Operator] and link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart]. |
| 21 | +. Modify the `disabled` field to `false` and add the package name as follows: |
| 22 | ++ |
| 23 | +-- |
| 24 | +.Example plugin configuration |
| 25 | +[source,yaml] |
| 26 | +---- |
| 27 | +plugins: |
| 28 | + - disabled: false |
| 29 | + package: ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic |
| 30 | +---- |
| 31 | +For more information about how to configure dynamic plugins in {product-short}, see link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/{product-version}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/rhdh-installing-rhdh-plugins_title-plugins-rhdh-about[Installing dynamic plugins in {product}]. |
| 32 | +-- |
| 33 | + |
| 34 | +.Verification |
| 35 | +. Restart the {product-very-short} application and verify that the plugin is successfully activated and configured. |
| 36 | +. Verify the application logs for confirmation and ensure the plugin is functioning as expected. |
0 commit comments