diff --git a/assemblies/dynamic-plugins/assembly-extensions-plugins.adoc b/assemblies/dynamic-plugins/assembly-extensions-plugins.adoc index 666cf29070..599533e84f 100644 --- a/assemblies/dynamic-plugins/assembly-extensions-plugins.adoc +++ b/assemblies/dynamic-plugins/assembly-extensions-plugins.adoc @@ -29,8 +29,11 @@ include::../modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloff // Searching and filtering Extensions include::../modules/dynamic-plugins/con-catalog-searching-and-filtering.adoc[leveloffset=+1] -// Viewing a plugin -include::../modules/dynamic-plugins/ref-catalog-plugin.adoc[leveloffset=+2] +// Viewing a plugin - screenshots added post 1.5 GA, so this section is no longer necessary +// include::../modules/dynamic-plugins/ref-catalog-plugin.adoc[leveloffset=+2] + +// Installing a plugin +include::../modules/dynamic-plugins/proc-extensions-installing.adoc[leveloffset=+1] // Disabling Extensions include::../modules/dynamic-plugins/proc-extensions-disabling.adoc[leveloffset=+1] diff --git a/images/rhdh-plugins-reference/rhdh-extensions-tekton-card.png b/images/rhdh-plugins-reference/rhdh-extensions-tekton-card.png new file mode 100644 index 0000000000..fa8af004d7 Binary files /dev/null and b/images/rhdh-plugins-reference/rhdh-extensions-tekton-card.png differ diff --git a/images/rhdh-plugins-reference/rhdh-extensions-tekton-details.png b/images/rhdh-plugins-reference/rhdh-extensions-tekton-details.png new file mode 100644 index 0000000000..c36183e4cf Binary files /dev/null and b/images/rhdh-plugins-reference/rhdh-extensions-tekton-details.png differ diff --git a/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png b/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png new file mode 100644 index 0000000000..e69a00be1c Binary files /dev/null and b/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-1.png differ diff --git a/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png b/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png new file mode 100644 index 0000000000..9b95d76493 Binary files /dev/null and b/images/rhdh-plugins-reference/rhdh-extensions-tekton-editor-2.png differ diff --git a/modules/dynamic-plugins/proc-extensions-installing.adoc b/modules/dynamic-plugins/proc-extensions-installing.adoc new file mode 100644 index 0000000000..7f3ed66f1b --- /dev/null +++ b/modules/dynamic-plugins/proc-extensions-installing.adoc @@ -0,0 +1,56 @@ +[id="rhdh-extensions-plugins-installing_{context}"] += Installing a plugin by using Extensions +You can install a plugin and configure it by updating the `dynamic-plugins.yaml` 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 +. Open your {product-short} application and click *Administration* > *Extensions*. +. 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. ++ +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. ++ +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} {product-version}, the *Install* button is disabled, so you must copy the plugin configuration to the `dynamic-plugins.yaml` file. +. In the `dynamic-plugins.yaml` file, add the plugin configuration that you copied in the previous step to the `plugins` definitions. ++ +[NOTE] +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. + +.Verification +. Click on *Administration* > *Extensions*. +. 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*. +////