generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 57
RHIDP-6584 - Document how users can install and configure plugins from Marketplace in RHDH #1084
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
Merged
hmanwani-rh
merged 16 commits into
redhat-developer:release-1.6
from
Gerry-Forde:RHIDP-6544
May 13, 2025
Merged
Changes from 5 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
610f9a9
RHIDP-6544 - Document how users can install and configure plugins fro…
Gerry-Forde 714a13a
RHIDP-6544 - Document how users can install and configure plugins fro…
Gerry-Forde 240ccfc
RHIDP-6544 - Document how users can install and configure plugins fro…
Gerry-Forde 15a1163
Merge branch 'release-1.6' into RHIDP-6544
Gerry-Forde 0cb57eb
RHIDP-6544 - Document how users can install and configure plugins fro…
Gerry-Forde d455649
Merge branch 'release-1.6' into RHIDP-6544
Gerry-Forde 417329e
RHIDP-6544 - Document how users can install and configure plugins fro…
Gerry-Forde 6dd01db
RHIDP-6544 - Document how users can install and configure plugins fro…
Gerry-Forde 26b0e2c
Update modules/dynamic-plugins/proc-extensions-installing.adoc
Gerry-Forde 0c80a96
Update modules/dynamic-plugins/proc-extensions-installing.adoc
Gerry-Forde 40d116d
Update modules/dynamic-plugins/proc-extensions-installing.adoc
Gerry-Forde 849cc77
Update modules/dynamic-plugins/proc-extensions-installing.adoc
Gerry-Forde 0884335
Update modules/dynamic-plugins/proc-extensions-installing.adoc
Gerry-Forde 233c0d3
Update proc-extensions-installing.adoc
Gerry-Forde ab6291d
Merge branch 'release-1.6' into RHIDP-6544
Gerry-Forde 30156e0
Merge branch 'release-1.6' into RHIDP-6544
Gerry-Forde File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| [id="rhdh-extensions-plugins-installing_{context}"] | ||
| = Installing a plugin by using Extensions | ||
| You can install a plugin and configure it by updating the `{my-app-config-file}` file by using *Extensions*. | ||
|
|
||
| == Prerequisites | ||
| * 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 | ||
| . Use the search bar in the header to search for the plugin that you wish to install and click on the card. For example, search for Tekton and click *Read more* on the *Pipelines With Tekton* card. | ||
| + | ||
| image::rhdh-plugins-reference/rhdh-extensions-tekton-card.png[Extensions catalog with Tekton card] | ||
| . In the plugin drawer, you can review information about the plugin and how to configure it in {product-very-short}. To install the plugin click *Install*. | ||
| + | ||
| image::rhdh-plugins-reference/rhdh-extensions-tekton-details.png[Extensions catalog with Tekton details] | ||
| . On the install plugin page, a YAML editor and installation instructions are displayed. | ||
Gerry-Forde marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| + | ||
| image::rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png[Extensions catalog with plugin editor template] | ||
| . Click the *About the plugin* tab to view installation and configuration details for the plugin. | ||
| . Click the *Examples* tab to display the default plugin configuration. | ||
| . Click *Apply* to copy the default plugin configuration to the YAML editor. | ||
| . In the YAML editor, click the copy icon to copy the plugin configuration. | ||
| + | ||
| image::rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png[Extensions catalog with Tekton configuration] | ||
| + | ||
| [NOTE] | ||
| In {product-very-short} 1.6, the *Install* button is disabled, so you must copy the plugin configuration to the `{my-app-config-file}` file. | ||
| . In the `{my-app-config-file}` file, add the plugin configuration that you copied in the previous step to the `plugins` definitions. | ||
Gerry-Forde marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| .Verification | ||
| . Click *Administration* > *Extensions*. | ||
Gerry-Forde marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| . Go to the *Installed* tab to view a list of installed plugins. | ||
| . Search for the plugin that you installed to confirm that it is available and enabled. | ||
|
|
||
| //// | ||
| . To disable the the Extensions feature plugins, edit your `dynamic-plugins.yaml` with the following content. | ||
| + | ||
| .`dynamic-plugins.yaml` fragment | ||
| [source,yaml] | ||
| ---- | ||
| plugins: | ||
| - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace | ||
| disabled: true | ||
| - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-catalog-backend-module-marketplace-dynamic | ||
| disabled: true | ||
| - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic | ||
| disabled: true | ||
| ---- | ||
|
|
||
| [NOTE] | ||
| If you disable the Extensions feature plugins, the *Catalog* and *Installed* tabs will also be removed. You can still view installed plugins by clicking on *Administration* > *Extensions*. | ||
| //// | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.