RHIDP-5139: Installing RHDH container image plugins

assemblies/dynamic-plugins/assembly-install-third-party-plugins-rhdh.adoc

@@ -15,7 +15,7 @@ Plugins are defined in the `plugins` array within the `dynamic-plugin-config.yam
 
 [NOTE]
 ====
-You can also load dynamic plugins from another directory, though this is intended for development or testing purposes and is not recommended for production, except for plugins included in the {product-very-short} container image.
+You can also load dynamic plugins from another directory, though this is intended for development or testing purposes and is not recommended for production, except for plugins included in the {product-very-short} container image. For more information, see xref:proc-install-plugins-rhdh-container-image_{context}[].
 ====
 
 //OCI image

modules/dynamic-plugins/proc-install-plugins-rhdh-container-image.adoc

@@ -0,0 +1,42 @@
+[id="proc-install-plugins-rhdh-container-image_{context}"]
+= Installing plugins included in {product-very-short} container image
+
+In the {product-very-short} container image, a set of dynamic plugins is pre-loaded to enhance functionality. However, due to mandatory configuration requirements, most of the plugins are disabled.
+
+You can activate 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.
+
+.Prerequisites
+* 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.
+* You have deployed the {product-very-short} application, and have access to the logs of the `install-dynamic-plugins` init container.
+* You have the necessary permissions to modify plugin configurations and access the application environment.
+* 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.
+
+.Procedure
+. Locate the link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file in your setup.
+. Start your {product-very-short} application and access the logs of the `install-dynamic-plugins` init container within the {product-very-short} pod.
+. Look for log entries indicating plugins that are disabled by default. For example:
++
+--
+.Example log entry for a disabled plugin
+[source,sql]
+----
+======= Skipping disabled dynamic plugin ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
+----
+--
+. Open the plugin configuration file and locate the plugin entry you want to activate.
+. Modify the `disabled` field to `false` and specify the package name as follows:
++
+--
+.Example plugin configuration
+[source,yaml]
+----
+plugins:
+  - disabled: false
+    package: ./dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-dynamic
+----
+--
+. Optional: Replace the default plugin configuration from the `dynamic-plugins.default.yaml` file by adding a `pluginConfig` entry to the plugin configuration file.
+
+.Verification
+. Restart the {product-very-short} application and verify that the plugin is successfully activated and configured.
+. Verify the application logs for confirmation and ensure the plugin is functioning as expected.

titles/plugins-rhdh-install/master.adoc

@@ -14,5 +14,8 @@ include::assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc[levelo
 //third-party plugins
 include::assemblies/dynamic-plugins/assembly-third-party-plugins.adoc[leveloffset=+1]
 
+//Install RHDH container image plugins
+include::modules/dynamic-plugins/proc-install-plugins-rhdh-container-image.adoc[leveloffset=+1]
+
 // Viewing installed plugins
 include::modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloffset=+1]