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.

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

Conversation

hmanwani-rh
Copy link
Member

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s):
1.4
Add the relevant labels to the Pull Request.
Issue:
RHIDP-5139

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Jan 7, 2025

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

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

Choose a reason for hiding this comment

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

Where can users find dynamic-plugins.default.yaml file?

Copy link
Member Author

Choose a reason for hiding this comment

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

In Chapter 1.2, it is mentioned that the dynamic-plugins.default.yaml file is part of RHDH's default configuration. Would it be helpful to reiterate this point in this section as well?
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants