|
| 1 | +[id="rhdh-extensions-plugins-installing_{context}"] |
| 2 | += Installing a plugin by using Extensions |
| 3 | +You can install a plugin and configure it by updating the `dynamic-plugins.yaml` file by using *Extensions*. |
| 4 | + |
| 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. |
| 8 | + |
| 9 | +.Procedure |
| 10 | +. Open your {product-short} application and click *Administration* > *Extensions*. |
| 11 | +. Use the search bar on the *Extensions* page to find the plugin you wish to install, then click on the card. For example, search for Tekton and click *Read more* on the *Pipelines With Tekton* card. |
| 12 | ++ |
| 13 | +image::rhdh-plugins-reference/rhdh-extensions-tekton-card.png[Extensions catalog with Tekton card] |
| 14 | +. 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*. |
| 15 | ++ |
| 16 | +image::rhdh-plugins-reference/rhdh-extensions-tekton-details.png[Extensions catalog with Tekton details] |
| 17 | +. On the Install Plugin page, a YAML editor and installation instructions are displayed. |
| 18 | ++ |
| 19 | +image::rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png[Extensions catalog with plugin editor template] |
| 20 | +. Click the *About the plugin* tab to view installation and configuration details for the plugin. |
| 21 | +. Click the *Examples* tab to display the default plugin configuration. |
| 22 | +. Click *Apply* to copy the default plugin configuration to the YAML editor. |
| 23 | +. In the YAML editor, click the copy icon to copy the plugin configuration. |
| 24 | ++ |
| 25 | +image::rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png[Extensions catalog with Tekton configuration] |
| 26 | ++ |
| 27 | +[NOTE] |
| 28 | +In {product-very-short} {product-version}, the *Install* button is disabled, so you must copy the plugin configuration to the `dynamic-plugins.yaml` file. |
| 29 | +. In the `dynamic-plugins.yaml` file, add the plugin configuration that you copied in the previous step to the `plugins` definitions. |
| 30 | ++ |
| 31 | +[NOTE] |
| 32 | +If you have installed {product-very-short} by using the Helm Chart, to enable the plugin, you may need to roll out your {product-very-short} project manually. |
| 33 | + |
| 34 | +.Verification |
| 35 | +. Click on *Administration* > *Extensions*. |
| 36 | +. Go to the *Installed* tab to view a list of installed plugins. |
| 37 | +. Search for the plugin that you installed to confirm that it is available and enabled. |
| 38 | + |
| 39 | +//// |
| 40 | +. To disable the the Extensions feature plugins, edit your `dynamic-plugins.yaml` with the following content. |
| 41 | ++ |
| 42 | +.`dynamic-plugins.yaml` fragment |
| 43 | +[source,yaml] |
| 44 | +---- |
| 45 | +plugins: |
| 46 | + - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace |
| 47 | + disabled: true |
| 48 | + - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-catalog-backend-module-marketplace-dynamic |
| 49 | + disabled: true |
| 50 | + - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic |
| 51 | + disabled: true |
| 52 | +---- |
| 53 | +
|
| 54 | +[NOTE] |
| 55 | +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*. |
| 56 | +//// |
0 commit comments