Skip to content

Commit

Permalink
Merge branch 'release-1.4' into RHIDP-5367
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerry-Forde authored Jan 3, 2025
2 parents 16ba283 + 6642216 commit cb0c238
Show file tree
Hide file tree
Showing 28 changed files with 45 additions and 101 deletions.
1 change: 1 addition & 0 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
:rhsso: RHSSO
:rhbk-brand-name: Red Hat Build of Keycloak
:rhbk: RHBK
:keycloak-version: 24.0

// RHTAP information
:rhtap-version: 1.3
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-acr
- package: ./dynamic-plugins/dist/backstage-community-plugin-acr
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-jfrog-artifactory
- package: ./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic
- package: ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-keycloak-backend-dynamic
- package: ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-nexus-repository-manager
- package: ./dynamic-plugins/dist/backstage-community-plugin-nexus-repository-manager
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-nexus-repository-manager
- package: ./dynamic-plugins/dist/backstage-community-plugin-nexus-repository-manager
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-nexus-repository-manager
- package: ./dynamic-plugins/dist/backstage-community-plugin-nexus-repository-manager
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The Open Cluster Management (OCM) plugin integrates your Backstage instance with OCM.

For more information about OCM plugin, see the https://github.com/janus-idp/backstage-plugins/tree/main/plugins/ocm[Open Cluster Management plugin documentation] on GitHub.
For more information about OCM plugin, see the https://github.com/backstage/community-plugins/tree/main/workspaces/ocm/plugins/ocm[Open Cluster Management plugin documentation] on GitHub.
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

The Open Cluster Management (OCM) plugin integrates your Backstage instance with OCM.

For more information about OCM plugin, see the https://github.com/janus-idp/backstage-plugins/tree/main/plugins/ocm[Open Cluster Management plugin documentation] on GitHub.
For more information about OCM plugin, see the https://github.com/backstage/community-plugins/tree/main/workspaces/ocm/plugins/ocm[Open Cluster Management plugin documentation] on GitHub.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-quay
- package: ./dynamic-plugins/dist/backstage-community-plugin-quay
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-tekton
- package: ./dynamic-plugins/dist/backstage-community-plugin-tekton
disabled: false
----
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-tekton
- package: ./dynamic-plugins/dist/backstage-community-plugin-tekton
disabled: false
----
--
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-tekton
- package: ./dynamic-plugins/dist/backstage-community-plugin-tekton
disabled: false
----
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-topology
- package: ./dynamic-plugins/dist/backstage-community-plugin-topology
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ You can also add the `app.openshift.io/edit-url` annotation that you want to acc

[TIP]
====
You can use the https://raw.githubusercontent.com/janus-idp/backstage-plugins/main/plugins/topology/manifests/clusterrole.yaml[prepared manifest for a read-only `ClusterRole`], which provides access for both Kubernetes and Topology plugin.
You can use the https://raw.githubusercontent.com/backstage/community-plugins/main/workspaces/topology/plugins/topology/manifests/clusterrole.yaml[prepared manifest for a read-only `ClusterRole`], which provides access for both Kubernetes and Topology plugin.
====
--

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
GroupTransformer,
keycloakTransformerExtensionPoint,
UserTransformer,
} from '@janus-idp/backstage-plugin-keycloak-backend';
} from '@backstage-community/plugin-catalog-backend-module-keycloak';
const customGroupTransformer: GroupTransformer = async (
entity, // entity output from default parser
Expand Down
2 changes: 1 addition & 1 deletion modules/authorization/proc-download-user-stats-rhdh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ You can download the list of users in CSV format using the {product-short} web i

.Prerequisites

* RBAC plugins (`@janus-idp/backstage-plugin-rbac` and `@janus-idp/backstage-plugin-rbac-backend`) must be enabled in {product}.
* RBAC plugins (`@backstage-community/plugin-rbac` and `@backstage-community/plugin-rbac-backend`) must be enabled in {product}.
* An administrator role must be assigned.

.Procedure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,18 @@

= Installing external dynamic plugins using a Helm chart

The NPM registry contains external dynamic plugins that you can use for demonstration purposes. For example, the following community plugins are available in the `janus-idp` organization in the NPMJS repository:
The NPM registry contains external dynamic plugins that you can enable in your {prod-short} instance.

* Notifications (frontend and backend)
* Kubernetes actions (scaffolder actions)

To install the Notifications and Kubernetes actions plugins, include them in the Helm chart values in the `global.dynamic.plugins` list as shown in the following example:
To install dynamic plugins from registry.npmjs.org, include them in the Helm chart values in the `global.dynamic.plugins` list as shown in the following example:

[source,yaml]
----
global:
dynamic:
plugins:
- package: '@janus-idp/[email protected]'
# Integrity can be found at https://registry.npmjs.org/@janus-idp/plugin-notifications-backend-dynamic
integrity: 'sha512-Qd8pniy1yRx+x7LnwjzQ6k9zP+C1yex24MaCcx7dGDPT/XbTokwoSZr4baSSn8jUA6P45NUUevu1d629mG4JGQ=='
- package: '@janus-idp/[email protected]'
# https://registry.npmjs.org/@janus-idp/plugin-notifications
integrity: 'sha512-GCdEuHRQek3ay428C8C4wWgxjNpNwCXgIdFbUUFGCLLkBFSaOEw+XaBvWaBGtQ5BLgE3jQEUxa+422uzSYC5oQ=='
pluginConfig:
dynamicPlugins:
frontend:
janus-idp.backstage-plugin-notifications:
appIcons:
- name: notificationsIcon
module: NotificationsPlugin
importName: NotificationsActiveIcon
dynamicRoutes:
- path: /notifications
importName: NotificationsPage
module: NotificationsPlugin
menuItem:
icon: notificationsIcon
text: Notifications
config:
pollingIntervalMs: 5000
- package: '@janus-idp/[email protected]'
- package: '@janus-idp/[email protected]'
# https://registry.npmjs.org/@janus-idp/backstage-scaffolder-backend-module-kubernetes-dynamic
integrity: 'sha512-19ie+FM3QHxWYPyYzE0uNdI5K8M4vGZ0SPeeTw85XPROY1DrIY7rMm2G0XT85L0ZmntHVwc9qW+SbHolPg/qRA=='
integrity: 'sha512-yLh2MbNB0zSWTrG0O2MVk/oVu007k+UNm+MJzpyoUE2ziRjgwwXGqJVqW6behPCOLlJU4jizs6g9UtRfMGN/mA=='
proxy:
endpoints:
/explore-backend-completed:
Expand All @@ -50,4 +24,4 @@ global:
- package: '@dfatwork-pkgs/[email protected]'
# https://registry.npmjs.org/@dfatwork-pkgs/plugin-catalog-backend-module-test-dynamic
integrity: 'sha512-YsrZMThxJk7cYJU9FtAcsTCx9lCChpytK254TfGb3iMAYQyVcZnr5AA/AU+hezFnXLsr6gj8PP7z/mCZieuuDA=='
----
----
2 changes: 1 addition & 1 deletion modules/dynamic-plugins/proc-topology-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-topology
- package: ./dynamic-plugins/dist/backstage-community-plugin-topology
disabled: false
----
48 changes: 8 additions & 40 deletions modules/dynamic-plugins/ref-rh-compatible-plugins.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
// cd /path/to/rhdh-documentation; ./modules/dynamic-plugins/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html

= Other installable plugins

The following Technology Preview plugins are not preinstalled and must be installed from an external source:
Expand All @@ -13,50 +10,21 @@ The following Technology Preview plugins are not preinstalled and must be instal
| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]

|Ansible Automation Platform
| `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0 |

|Ansible Automation Platform Scaffolder Backend
|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0 |


|Orchestrator Frontend|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator[@janus-idp/backstage-plugin-orchestrator]` |1.22.6| https://www.parodos.dev/1.2-rc/docs/[Learn more]

|Orchestrator Backend
|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator-backend-dynamic[@janus-idp/backstage-plugin-orchestrator-backend-dynamic]` |1.22.9 |


|===

// Without description - for consistency i.e. no descriptions in other table and we provide a 'Learn more' link to plugin documentation for users' convenience.
////
[%header,cols=5*]
|===
|*Name* |*Description*|*Plugin*|*Version* |*Installation Details*
|Ansible Automation Platform Frontend
.3+|Ansible plug-ins for RHDH delivers an Ansible-specific portal experience with curated learning paths, push-button content creation, integrated development tools, and other opinionated resources.
|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap]` |1.0.0
.3+| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
|Ansible Automation Platform
| `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0
| `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0
| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]

|Ansible Automation Platform Scaffolder Backend
|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0
|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0
| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]

|Orchestrator Frontend
.2+|Orchestrator brings serverless workflows into Red Hat Developer Hub, focusing on the journey for application migration to the cloud, on boarding developers, and user-made workflows of Backstage actions or external systems.
|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator[@janus-idp/backstage-plugin-orchestrator]` |1.22.6
.2+| https://www.parodos.dev/1.2-rc/docs/[Learn more]
// temporarily removed until we have a good installation story from the Orchestrator team
//|Orchestrator Frontend|`https://www.npmjs.com/package/@red-hat-developer-hub/backstage-plugin-orchestrator[@red-hat-developer-hub/backstage-plugin-orchestrator]` | N/A for RHDH 1.4 | https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator/[Learn more]

|Orchestrator Backend
|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator-backend-dynamic[@janus-idp/backstage-plugin-orchestrator-backend-dynamic]` |1.22.9
// temporarily removed until we have a good installation story from the Orchestrator team
//|Orchestrator Backend|`https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/[@redhat/backstage-plugin-orchestrator-backend-dynamic]` | N/A for RHDH 1.4 | https://github.com/redhat-developer/rhdh-plugins/tree/main/workspaces/orchestrator[Learn more]


|===
////


[NOTE]
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ You can enable the Bulk Import feature for users and give them the necessary per
.Procedure

. The Bulk Import plugins are installed but disabled by default.
To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` plugins,
To enable the `./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import` plugins,
edit your `dynamic-plugins.yaml` with the following content:
+
.`dynamic-plugins.yaml` fragment
[source,yaml]
----
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic
disabled: false
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
disabled: false
----
+
Expand Down
6 changes: 3 additions & 3 deletions modules/observe/proc-disabling-telemetry-using-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ You can also create a new Helm release by clicking the *Create* button and edit
+
*** If you have not configured the plugin, add the following value in the *Package specification of the dynamic plugin to install. It should be usable by the npm pack command.* field:
+
`./dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment`
`./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment`
+
image::rhdh/disabling-telemetry.png[]
+
*** If you have configured the plugin, find the *Package specification of the dynamic plugin to install. It should be usable by the npm pack command.* field with the `./dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment` value.
*** If you have configured the plugin, find the *Package specification of the dynamic plugin to install. It should be usable by the npm pack command.* field with the `./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment` value.

.. Select the *Disable the plugin* checkbox.
.. Click *Upgrade*.
Expand All @@ -49,7 +49,7 @@ image::rhdh/disabling-telemetry.png[]
global:
dynamic:
plugins:
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment'
- package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
disabled: true
# ...
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ data:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment'
- package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
disabled: true
----

Expand Down
6 changes: 3 additions & 3 deletions modules/observe/proc-enabling-telemetry-using-helm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ You can also create a new Helm release by clicking the *Create* button and edit
+
*** If you have not configured the plugin, add the following value in the *Package specification of the dynamic plugin to install. It should be usable by the npm pack command.* field:
+
`./dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment`
`./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment`
+
*** If you have configured the plugin, find the *Package specification of the dynamic plugin to install. It should be usable by the npm pack command.* field with the `./dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment` value.
*** If you have configured the plugin, find the *Package specification of the dynamic plugin to install. It should be usable by the npm pack command.* field with the `./dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment` value.

.. Clear the *Disable the plugin* checkbox.
.. Click *Upgrade*.
Expand All @@ -47,7 +47,7 @@ You can also create a new Helm release by clicking the *Create* button and edit
global:
dynamic:
plugins:
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment'
- package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
disabled: false
# ...
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ data:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: './dynamic-plugins/dist/janus-idp-backstage-plugin-analytics-provider-segment'
- package: './dynamic-plugins/dist/backstage-community-plugin-analytics-provider-segment'
disabled: false
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ global:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: ./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-servicenow-dynamic
- package: ./dynamic-plugins/dist/backstage-community-plugin-scaffolder-backend-module-servicenow-dynamic
disabled: false
----

Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ jira>=3.8.0
pip>=21.3.1
pyyaml>=6.0.2
tox>=4.21.0
setuptools

0 comments on commit cb0c238

Please sign in to comment.