Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions modules/dynamic-plugins/proc-create-plugin-js-package.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The derived dynamic plugin JavaScript packages must not be published to the publ
====

.Prerequisites
* You have exported a third-party dynamic plugin package. For more information, see xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[].
* You have exported a third-party dynamic plugin package.

.Procedure
. Navigate to the `dist-dynamic` directory.
Expand Down Expand Up @@ -36,4 +36,9 @@ You can add the following to your `package.json` file before running the `export

If you modify `publishConfig` after exporting the dynamic plugin, re-run the `export-dynamic-plugin` command to ensure the correct configuration is included.
====
--
--

[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[Exporting third-party plugins in {product}]
9 changes: 7 additions & 2 deletions modules/dynamic-plugins/proc-create-plugin-oci-image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

.Prerequisites
* You have installed `podman` or `docker`.
* You have exported a third-party dynamic plugin package. For more information, see xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[].
* You have exported a third-party dynamic plugin package.

.Procedure
. Navigate to the plugin's root directory (not the `dist-dynamic` directory).
Expand Down Expand Up @@ -34,4 +34,9 @@ docker push quay.io/example/image:v0.0.1
----

The output of the `package-dynamic-plugins` command provides the plugin's path for use in the `dynamic-plugin-config.yaml` file.
--
--

[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[Exporting third-party plugins in {product}]
9 changes: 7 additions & 2 deletions modules/dynamic-plugins/proc-create-plugin-tgz-file.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= Creating a TGZ file with dynamic packages

.Prerequisites
* You have exported a third-party dynamic plugin package. For more information, see xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[].
* You have exported a third-party dynamic plugin package.

.Procedure
. Navigate to the `dist-dynamic` directory.
Expand Down Expand Up @@ -67,4 +67,9 @@ oc new-app --image-stream=plugin-registry
plugins:
- package: http://plugin-registry:8080/backstage-plugin-myplugin-1.9.6.tgz
----
--
--

[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index#proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[Exporting third-party plugins in {product}]
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In the {product-very-short} container image, a set of dynamic plugins is preload
You can enable and configure the plugins in the {product-very-short} container image, including how to manage the default configuration, set necessary environment variables, and ensure the proper functionality of the plugins within your application.

.Prerequisites
* You have access to the link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml`] file, which lists all preloaded plugins and their default configuration.
* You have access to the `dynamic-plugins.default.yaml` file, which lists all preloaded plugins and their default configuration.
* You have deployed the {product-very-short} application, and have access to the logs of the `install-dynamic-plugins` init container.
* 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.
Expand Down Expand Up @@ -34,3 +34,8 @@ For more information about how to configure dynamic plugins in {product-short},
.Verification
. Restart the {product-very-short} application and verify that the plugin is successfully activated and configured.
. Verify the application logs for confirmation and ensure the plugin is functioning as expected.

[role="_additional-resources"]
.Additional resources

* link:https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml[`dynamic-plugins.default.yaml` file]
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Topology plugin is defining additional permissions. When link:{authorization
* The `catalog-entity` `read` permission to view the {product} software catalog items.

.Prerequisites
* You are link:{authorization-book-url}#managing-authorizations-by-using-external-files[managing {authorization-book-title} by using external files].
* You are managing {authorization-book-title} by using external files.

.Procedure
* Add the following permission policies to your `rbac-policy.csv` file to create a `topology-viewer` role that has access to the Topology plugin features, and add the role to the users requiring this authorization:
Expand All @@ -23,4 +23,9 @@ p, role:default/topology-viewer, catalog-entity, read, allow <3>
----
<1> Grants the user the ability to see the Topology panel.
<2> Grants the user the ability to view the pod logs.
<3> Grants the user the ability to see the catalog item.
<3> Grants the user the ability to see the catalog item.

[role="_additional-resources"]
.Additional resources

* link:{authorization-book-url}#managing-authorizations-by-using-external-files[Managing {authorization-book-title} by using external files]
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To use plugins in {product}, you can export plugins as derived dynamic plugin pa
.Prerequisites
* The `@janus-idp/cli` package is installed. Use the latest version (`@latest` tag) for compatibility with the most recent features and fixes.
* Node.js and NPM is installed and configured.
* The third-party plugin is compatible with your {product} version. For more information, see link:https://github.com/redhat-developer/rhdh/blob/main/docs/dynamic-plugins/versions.md[Version compatibility matrix].
* The third-party plugin is compatible with your {product} version. For more information, see the Version compatibility matrix.
* The third-party plugin must have a valid `package.json` file in its root directory, containing all required metadata and dependencies.
+
--
Expand Down Expand Up @@ -124,4 +124,7 @@ The derived dynamic plugin JavaScript packages must not be published to the publ
====
--

[role="_additional-resources"]
.Additional resources

* link:https://github.com/redhat-developer/rhdh/blob/main/docs/dynamic-plugins/versions.md[Version compatibility matrix]
11 changes: 7 additions & 4 deletions modules/dynamic-plugins/proc-load-plugin-js-package.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
= Loading a plugin packaged as a JavaScript package

.Prerequisites
* The third-party plugin is packaged as a dynamic plugin in a JavaScript package.
+
For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[].
* The third-party plugin is packaged as a dynamic plugin in a JavaScript package.

.Procedure
. Run the following command to obtain the integrity hash from the NPM registry:
Expand Down Expand Up @@ -65,4 +63,9 @@ stringData:
`_<release_name>_-dynamic-plugins-npmrc`
--

. To apply the changes, restart the {product-very-short} application.
. To apply the changes, restart the {product-very-short} application.

[role="_additional-resources"]
.Additional resources

* xref:assembly-package-publish-third-party-dynamic-plugin[Packaging a third-party plugin]
9 changes: 6 additions & 3 deletions modules/dynamic-plugins/proc-load-plugin-oci-image.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
= Loading a plugin packaged as an OCI image

.Prerequisites
* The third-party plugin is packaged as a dynamic plugin in an OCI image.
+
For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[].
* The third-party plugin is packaged as a dynamic plugin in an OCI image.

.Procedure
. To retrieve plugins from an authenticated registry, complete the following steps:
Expand Down Expand Up @@ -55,3 +53,8 @@ plugins:
----
--
. To apply the changes, restart the {product-very-short} application.

[role="_additional-resources"]
.Additional resources

* xref:assembly-package-publish-third-party-dynamic-plugin[Packaging a third-party plugin]
11 changes: 7 additions & 4 deletions modules/dynamic-plugins/proc-load-plugin-tgz-file.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
= Loading a plugin packaged as a TGZ file

.Prerequisites
* The third-party plugin is packaged as a dynamic plugin in a TGZ file.
+
For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[].
* The third-party plugin is packaged as a dynamic plugin in a TGZ file.

.Procedure

Expand All @@ -21,4 +19,9 @@ plugins:
----
--

. To apply the changes, restart the {product-very-short} application.
. To apply the changes, restart the {product-very-short} application.

[role="_additional-resources"]
.Additional resources

* xref:assembly-package-publish-third-party-dynamic-plugin[Packaging a third-party plugin]
9 changes: 7 additions & 2 deletions modules/dynamic-plugins/proc-using-topology-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

.Prerequisites
* Your {product} instance is installed and running.
* You have installed the Topology plugin.
* You have installed the Topology plugin.
//For the installation process, see Installation.
* You have xref:enable-users-to-use-the-topology-plugin[enabled the users to use the Topology plugin].
* You have enabled the users to use the Topology plugin.

.Procedure

Expand All @@ -25,3 +25,8 @@ image::rhdh-plugins-reference/topology-tab-user2.png[topology-user-2]
image::rhdh-plugins-reference/topology-tab-user3.png[topology-user-3]
+
Click the *Open URL* button to access the associated *Ingresses* and run your application in a new tab.

[role="_additional-resources"]
.Additional resources

* xref:enable-users-to-use-the-topology-plugin[Enabling the users to use the Topology plugin]
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can enable the Bulk Import feature for users and give them the necessary permissions to access it.

.Prerequisites
* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub integration].
* You have configured GitHub integration.

.Procedure

Expand Down Expand Up @@ -38,3 +38,7 @@ Note that only {product-short} administrators or users with the `bulk.import` pe
* The sidebar displays a *Bulk Import* option.
* The *Bulk Import* page shows a list of *Added Repositories*.

[role="_additional-resources"]
.Additional resources

* link:{authentication-book-url}#enabling-authentication-with-github[Configuring GitHub integration]
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
In {product}, you can select your GitHub repositories and automate their onboarding to the {product-short} catalog.

.Prerequisites
* You have xref:enabling-and-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it].
* You have enabled the Bulk Import feature and gave access to it.

.Procedure
. Click *Bulk Import* in the left sidebar.
Expand Down Expand Up @@ -34,3 +34,7 @@ To view more details about the reasons, click *Edit*.
* The *Added repositories* list displays the repositories you imported, each with an appropriate status: either _Waiting for approval_ or _Added_.
* For each _Waiting for approval_ import job listed, there is a corresponding pull request adding the `catalog-info.yaml` file in the corresponding repository.

[role="_additional-resources"]
.Additional resources

* xref:enabling-and-giving-access-to-the-bulk-import-feature[Enabling the Bulk Import feature and gave access to it]
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
You can oversee and manage the repositories that are imported to the {product-short}.

.Prerequisites
* You have xref:importing-multiple-github-repositories[imported GitHub repositories].
* You have imported GitHub repositories.


.Procedure
Expand All @@ -27,3 +27,8 @@ Empty:: {product-short} is unable to determine the import job status because the
** The target repository is accessible from the configured GitHub integrations.
** The location URL points to a `catalog-info.yaml` file at the root of the repository default branch.
====

[role="_additional-resources"]
.Additional resources

* xref:importing-multiple-github-repositories[Importing GitHub repositories]