Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RHIDP-5139: Installing RHDH container image plugins #831

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+46 −1
Open

RHIDP-5139: Installing RHDH container image plugins #831

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion assemblies/dynamic-plugins/assembly-install-third-party-plugins-rhdh.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
42 changes: 42 additions & 0 deletions modules/dynamic-plugins/proc-install-plugins-rhdh-container-image.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
hmanwani-rh marked this conversation as resolved.
Show resolved Hide resolved

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hmanwani-rh Generally we refer to "enabling" and "disabling" preinstalled plugins. There a few similar mentions of "activating" plugins in this PR. I'd suggest sticking with enable/disable.

Suggested change
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.
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.


.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.
hmanwani-rh marked this conversation as resolved.
Show resolved Hide resolved
* 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that getting list of the plugins from logs is a user-friendly way to get the list of available plugins.

We list of the plugins in our documentation (https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html/dynamic_plugins_reference/con-preinstalled-dynamic-plugins) so we should probably guide users use this instead parsing logs.

+
--
.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.
hmanwani-rh marked this conversation as resolved.
Show resolved Hide resolved

.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.
3 changes: 3 additions & 0 deletions titles/plugins-rhdh-install/master.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Loading