Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions assemblies/dynamic-plugins/assembly-extensions-plugins.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
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.
52 changes: 52 additions & 0 deletions modules/dynamic-plugins/proc-extensions-installing.adoc
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.
+
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.

.Verification
. Click *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*.
////