Skip to content

Commit 240ccfc

Browse files
committed
RHIDP-6544 - Document how users can install and configure plugins from Marketplace in RHDH
1 parent 714a13a commit 240ccfc

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

modules/dynamic-plugins/proc-extensions-installing.adoc

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,28 @@
11
[id="rhdh-extensions-plugins-installing_{context}"]
22
= Installing a plugin by using Extensions
3-
You can install a plugin and configure it from Extensions.
3+
You can install a plugin and configure it by updating the `{my-app-config-file}` file by using *Extensions*.
44

5+
== Prerequisites
6+
* You have the necessary permissions to modify plugin configurations and access the application environment.
7+
* 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.
58

69
.Procedure
7-
. 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 on the Pipelines With Tekton card.
10+
. 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.
811
+
912
image::rhdh-plugins-reference/rhdh-extensions-tekton-card.png[Extensions catalog with Tekton card]
10-
. On the plugin details page, you can review more information about the plugin and how to install it in{product-very-short}. To install the plugin click *Install*.
13+
. 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*.
1114
+
1215
image::rhdh-plugins-reference/rhdh-extensions-tekton-details.png[Extensions catalog with Tekton details]
13-
. On the indstall plugins page, click on the *About the plugin* tab to text-editor will appear which will be used to update your {product-very-short} dynamic plugins configuration. with installation instructions. The installation instructions and default configuration are also displayed.
16+
. On the install plugin page, a YAML editor and installation instructions are displayed.
1417
+
1518
image::rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png[Extensions catalog with plugin editor template]
16-
. Click Apply to copy the default configuration to the text-editor.
17-
. Click on the copy icon to copy the configuration from the text editor to your `app-config.yaml` file.
19+
. Click the *About the plugin* tab to view installation and configuration details for the plugin.
20+
. Click the *Examples* tab to display the default plugin configuration.
21+
. Click *Apply* to copy the default plugin configuration to the YAML editor.
22+
. In the YAML editor, click the copy icon to copy the configuration to the `{my-app-config-file}` file.
1823
+
1924
image::rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png[Extensions catalog with Tekton configuration]
20-
. Add the plugin configuration that you copied in the previous step to the `plugins` definition in your `app-config.yaml` file.
25+
. In the `{my-app-config-file}` file, add the plugin configuration that you copied in the previous step to the `plugins` definitions.
2126

2227
.Verification
2328
. Click *Administration* > *Extensions*.

0 commit comments

Comments
 (0)