docs: Add dynamic plugin setup/installation instruction for the janus-idp plugins #1195
Conversation
… janus-idp plugins
| @@ -12,6 +12,50 @@ A subset of available Janus IDP plugins is available at our [community site](htt | |||
|
|
|||
| You can also see the [Plugin Marketplace](https://backstage.io/plugins) for other open-source plugins you can add to your Backstage instance. | |||
|
|
|||
| ## Dynamic Plugins Installation | |||
|
|
|||
| It is possible to install plugins without code changes in a backstage that supports [Dynamic Plugins](https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/dynamic-plugins.md) (e.g. [Janus IDP](https://janus-idp.io/) and [Red Hat Developer Hub](https://developers.redhat.com/rhdh)). Follow the steps below to install a dynamic plugin: | |||
There was a problem hiding this comment.
Are there any prerequisite for enabling the dynamic plugins?
I mean, can a user just use this procedure in a random version of Janus-IDP/Backstage, or should they first make sure a specific version is available, or anything perhaps something else?
There was a problem hiding this comment.
Hello @jkilzi I confirmed that no additional configuration is required to enable dynamic plugins. Regarding what version to use, I know that dynamic plugins are available in RHDH starting on 1.0, but for Janus IDP I recommend users to check if the endpoint /api/dynamic-plugins-info/loaded-plugins, if it is available, then you can use dynamic plugins.
Please bear in mind that upstream backstage does not support dynamic plugins ATM.
README.md
Outdated
| tar -xzvf {path to the NPM package tgz file} -C {plugin name} --strip-components=1 | ||
| ``` | ||
|
|
||
| - Configure your plugin in `app-config.yaml`. For example, the configuration below will make a new menu item to access the plugin on route `my-plugin`: |
There was a problem hiding this comment.
I would suggest using app-config.local.yaml instead here, it's generally better when working locally to try and stick with this file rather than modifying one of the tracked configuration files in the repo like app-config.yaml
README.md
Outdated
|
|
||
| It is possible to install plugins without code changes in a backstage that supports [Dynamic Plugins](https://github.com/janus-idp/backstage-showcase/blob/main/showcase-docs/dynamic-plugins.md) (e.g. [Janus IDP](https://janus-idp.io/) and [Red Hat Developer Hub](https://developers.redhat.com/rhdh)). Follow the steps below to install a dynamic plugin: | ||
|
|
||
| - Map the dynamic plugins root directory in `app-config.yaml`: |
There was a problem hiding this comment.
app-config.local.yaml, sorry missed this one before commenting on the other one :-)
|
@gashcrumb done, thanks! |
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: gashcrumb, invincibleJai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Added brief information about dynamic plugins installation to the README.md, but linking the main Dynamic Plugins docs to avoid information duplication. The README.md instruction is just to let users know about this possibility and direct them to a more complete document.