chore!: Bump RHDH image to 1.9 and update the dynamic plugins configuration accordingly [RHDHBUGS-2646] (#164)

Co-authored-by: Christoph Jerolimov <jerolimov+git@redhat.com>
Co-authored-by: Nick Boldt <nboldt@redhat.com>
Co-authored-by: Armel Soro <asoro@redhat.com>

Author: 4 people

README.md

@@ -87,6 +87,28 @@ To browse the existing issues, you can use this [Query](https://issues.redhat.co
 
 Contributions are welcome!
 
+
+## Breaking changes and known issues
+
+### Upgrading to RHDH 1.9
+
+More details in the [RHDH 1.9 Release Notes](https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.9/html/red_hat_developer_hub_release_notes/index).
+
+If you switch your `RHDH_IMAGE` to 1.9+ (default value in this branch), you may need to:
+
+1. **Update your `dynamic-plugins.override.yaml`**
+
+Some plugins are no longer bundled in the RHDH image, but have been moved to OCI references.
+
+See [Migration Steps](https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.9/html/dynamic_plugins_reference/ref-community-plugins-migration_title-plugins-rhdh-about#migration-steps) for more information.
+
+Also see [configs/dynamic-plugins/dynamic-plugins.override.example.yaml](configs/dynamic-plugins/dynamic-plugins.override.example.yaml) for an example.
+
+2. **Update any scaffolder modules**
+
+Ensure they are built for the Backstage version used in RHDH 1.9. Otherwise the backend may fail to start (e.g. `TypeError: Cannot read properties of undefined (reading 'id')`). See [RHDHBUGS-2497](https://issues.redhat.com/browse/RHDHBUGS-2497) as a known issue.
+
+
 ## License
 
 ```txt

compose-with-corporate-proxy.yaml

@@ -22,6 +22,11 @@ services:
     networks:
       - internal_net
       - default
+    healthcheck:
+      test: ["CMD-SHELL", "bash -c 'exec 3<>/dev/tcp/127.0.0.1/3128'"]
+      interval: 5s
+      timeout: 3s
+      retries: 5
 
   rhdh:
     environment:
@@ -36,6 +41,9 @@ services:
       # As a workaround, we are adding it to the default network,
       # but note that there is as such nothing preventing requests from bypassing the proxy to reach the outside.
       - default
+    depends_on:
+      proxy:
+        condition: service_healthy
 
   install-dynamic-plugins:
     environment:
@@ -44,3 +52,6 @@ services:
       # NO_PROXY configured in the .env file, but can be overridden here
     networks:
       - internal_net
+    depends_on:
+      proxy:
+        condition: service_healthy

compose.yaml

@@ -23,7 +23,7 @@ services:
 
   rhdh:
     container_name: rhdh
-    image: ${RHDH_IMAGE:-quay.io/rhdh-community/rhdh:1.8}
+    image: ${RHDH_IMAGE:-quay.io/rhdh-community/rhdh:1.9}
     env_file:
       - path: "./default.env"
         required: true
@@ -42,7 +42,7 @@ services:
       - ./docs:/opt/app-root/src/docs:Z
       - ./catalog-info.yaml:/opt/app-root/src/catalog-info.yaml:Z
       - ./wait-for-plugins-and-start.sh:/opt/app-root/src/wait-for-plugins-and-start.sh:Z
-      - ./configs:/opt/app-root/src/configs:Z
+      - ./configs:/opt/app-root/src/configs:z
       - dynamic-plugins-root:/opt/app-root/src/dynamic-plugins-root
       - extensions-catalog:/extensions
     depends_on:
@@ -53,7 +53,7 @@ services:
 
   install-dynamic-plugins:
     container_name: rhdh-plugins-installer
-    image: ${RHDH_IMAGE:-quay.io/rhdh-community/rhdh:1.8}
+    image: ${RHDH_IMAGE:-quay.io/rhdh-community/rhdh:1.9}
     # docker compose volumes are owned by root, so we need to run as root to write to them
     # the main rhdh container will be able to read from this as files are world readable
     user: "root"
@@ -67,7 +67,7 @@ services:
     volumes:
       - ./prepare-and-install-dynamic-plugins.sh:/opt/app-root/src/prepare-and-install-dynamic-plugins.sh:Z
       - ./local-plugins:/opt/app-root/src/local-plugins:Z
-      - ./configs:/opt/app-root/src/configs:Z
+      - ./configs:/opt/app-root/src/configs:z
       - dynamic-plugins-root:/dynamic-plugins-root
       - extensions-catalog:${CATALOG_ENTITIES_EXTRACT_DIR:-/extensions}
 

configs/dynamic-plugins/dynamic-plugins.override.example.yaml

@@ -3,7 +3,7 @@
 
 includes:
   - dynamic-plugins.default.yaml
-  # Uncomment the following line (and the corresponding 'red-hat-developer-hub-backstage-plugin-marketplace*' plugins)
+  # Uncomment the following line (and the corresponding 'red-hat-developer-hub-backstage-plugin-extensions*' plugins)
   # to enable dynamic plugins installation using the Extensions UI.
   # - /dynamic-plugins-root/dynamic-plugins.extensions.yaml
 
@@ -98,30 +98,14 @@ includes:
 #                 importName: RbacPage
 
 # # Uncomment the following two plugins to enable dynamic plugins installation via the Extensions UI
-# - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace
+# # TODO: Replace the `./dynamic-plugins/dist/` path with the OCI reference once we switch to that in the dynamic-plugins.default.yaml (DPDY) file in the catalog index image - see https://issues.redhat.com/browse/RHDHPLAN-934 and https://issues.redhat.com/browse/RHDHPLAN-256
+# # - package: 'oci://quay.io/rhdh/red-hat-developer-hub-backstage-plugin-extensions:{{inherit}}'
+# - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions
 #   disabled: false
-#   pluginConfig:
-#     dynamicPlugins:
-#       frontend:
-#         red-hat-developer-hub.backstage-plugin-marketplace:
-#           translationResources:
-#             - importName: marketplaceTranslations
-#               ref: marketplaceTranslationRef
-#               module: Alpha
-#           appIcons:
-#             - name: pluginsIcon
-#               importName: PluginsIcon
-#           dynamicRoutes:
-#             - path: /extensions
-#               importName: DynamicMarketplacePluginRouter
-#               menuItem:
-#                 icon: pluginsIcon
-#                 text: Extensions
-#                 textKey: menuItem.extensions
-#           menuItems:
-#             extensions:
-#               parent: default.admin
-# - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic
+
+# # TODO: Replace the `./dynamic-plugins/dist/` path with the OCI reference once we switch to that in the dynamic-plugins.default.yaml (DPDY) file in the catalog index image - see https://issues.redhat.com/browse/RHDHPLAN-934 and https://issues.redhat.com/browse/RHDHPLAN-256
+# # - package: 'oci://quay.io/rhdh/red-hat-developer-hub-backstage-plugin-extensions-backend:{{inherit}}'
+# - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions-backend-dynamic
 #   disabled: false
 #   pluginConfig:
 #     extensions:

configs/dynamic-plugins/dynamic-plugins.yaml

@@ -6,18 +6,25 @@ includes:
 
 plugins:
   # Tech Radar frontend plugin
+# # TODO: Replace the `./dynamic-plugins/dist/` path with the OCI reference once we switch to that in the dynamic-plugins.default.yaml (DPDY) file in the catalog index image - see https://issues.redhat.com/browse/RHDHPLAN-934 and https://issues.redhat.com/browse/RHDHPLAN-256
+  # - package: 'oci://quay.io/rhdh/backstage-community-plugin-tech-radar:{{inherit}}'
   - package: ./dynamic-plugins/dist/backstage-community-plugin-tech-radar
     disabled: false
 
   # Quay plugin
-  - package: ./dynamic-plugins/dist/backstage-community-plugin-quay
+# # TODO: Replace the `./dynamic-plugins/dist/` path with the OCI reference once we switch to that in the dynamic-plugins.default.yaml (DPDY) file in the catalog index image - see https://issues.redhat.com/browse/RHDHPLAN-934 and https://issues.redhat.com/browse/RHDHPLAN-256
+  # - package: 'oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay-backend:{{inherit}}'
+  #   disabled: false
+  - package: 'oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-quay:{{inherit}}'
     disabled: false
 
   # Scaffolder Github plugin - used by Dynamic Plugin Software Templates
   - package: ./dynamic-plugins/dist/backstage-plugin-scaffolder-backend-module-github-dynamic
     disabled: false
 
   # Floating Action Button plugin with submenu actions
+  # TODO: Replace the `./dynamic-plugins/dist/` path with the OCI reference once we switch to that in the dynamic-plugins.default.yaml (DPDY) file in the catalog index image - see https://issues.redhat.com/browse/RHDHPLAN-934 and https://issues.redhat.com/browse/RHDHPLAN-256
+  # - package: 'oci://quay.io/rhdh/red-hat-developer-hub-backstage-plugin-global-floating-action-button:{{inherit}}'
   - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-floating-action-button
     disabled: false
     pluginConfig:
@@ -58,31 +65,15 @@ plugins:
   #########################################################
   # Enable dynamic plugins installation by using Extensions
   #########################################################
-  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace
+
+  # TODO: Replace the `./dynamic-plugins/dist/` path with the OCI reference once we switch to that in the dynamic-plugins.default.yaml (DPDY) file in the catalog index image - see https://issues.redhat.com/browse/RHDHPLAN-934 and https://issues.redhat.com/browse/RHDHPLAN-256
+  # - package: 'oci://quay.io/rhdh/red-hat-developer-hub-backstage-plugin-extensions:{{inherit}}'
+  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions
     disabled: false
-    pluginConfig:
-      dynamicPlugins:
-        frontend:
-          red-hat-developer-hub.backstage-plugin-marketplace:
-            translationResources:
-              - importName: marketplaceTranslations
-                ref: marketplaceTranslationRef
-                module: Alpha
-            appIcons:
-              - name: pluginsIcon
-                importName: PluginsIcon
-            dynamicRoutes:
-              - path: /extensions
-                importName: DynamicMarketplacePluginRouter
-                menuItem:
-                  icon: pluginsIcon
-                  text: Extensions
-                  textKey: menuItem.extensions
-            menuItems:
-              extensions:
-                parent: default.admin
 
-  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic
+  # TODO: Replace the `./dynamic-plugins/dist/` path with the OCI reference once we switch to that in the dynamic-plugins.default.yaml (DPDY) file in the catalog index image - see https://issues.redhat.com/browse/RHDHPLAN-934 and https://issues.redhat.com/browse/RHDHPLAN-256
+  # - package: 'oci://quay.io/rhdh/red-hat-developer-hub-backstage-plugin-extensions-backend:{{inherit}}'
+  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-extensions-backend-dynamic
     disabled: false
     pluginConfig:
       extensions:

default.env

@@ -9,7 +9,7 @@ BASE_URL=http://localhost:7007
 
 # configure image to use: default to using the latest stable tag of the community builds, which are built for both amd64 and arm64 architectures
 # to use bleeding edge :next images or commercially supported images, see README.md for details
-# RHDH_IMAGE=quay.io/rhdh-community/rhdh:1.8
+# RHDH_IMAGE=quay.io/rhdh-community/rhdh:1.9
 
 # Default plugin catalog index image
 # Requires RHDH 1.9+ to be handled.

developer-lightspeed/configs/dynamic-plugins/dynamic-plugins.lightspeed.yaml

@@ -4,7 +4,7 @@
 includes:
   - dynamic-plugins.default.yaml
 plugins:
-  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:bs_1.45.3__1.2.3!red-hat-developer-hub-backstage-plugin-lightspeed
+  - package: 'oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed:bs_1.45.3__1.2.3'
     disabled: false
     pluginConfig:
       lightspeed:
@@ -37,5 +37,5 @@ plugins:
                 config:
                   id: lightspeed
                   priority: 100
-  - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:bs_1.45.3__1.2.3!red-hat-developer-hub-backstage-plugin-lightspeed-backend
+  - package: 'oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/red-hat-developer-hub-backstage-plugin-lightspeed-backend:bs_1.45.3__1.2.3'
     disabled: false

docs/getting-started-rhdh/comparison.md

@@ -78,7 +78,7 @@ Both platforms share the same foundational features:
 |---------|----------------|------------------------|
 | **Dynamic Plug-Ins** (no need to recompile) | ❌ | ✅ |
 | **Verified Plugin Compatibility** | ⚠️ (self-verify) | ✅ |
-| **Extensions Catalog Plugin** (marketplace) | ❌ | ✅ |
+| **Extensions Catalog Plugin** (catalog) | ❌ | ✅ |
 | **Adoption Insights Plugin** (user metrics) | ❌ | ✅ |
 | **20+ Red Hat Plugins** (e.g., Tekton, ArgoCD, Kiali, 3scale, ACS, Ansible) | ❌ | ✅ |
 | **[Free Software Templates Library](https://github.com/redhat-developer/red-hat-developer-hub-software-templates)** | ❌ | ✅ |

docs/getting-started-rhdh/extensions.md

@@ -45,10 +45,10 @@ Integrating these entity plugins means you don't have to leave Developer Hub to
 
 How do you know what plugins are available?
 
-Red Hat Developer Hub includes a built-in [**Extensions**](/extensions) marketplace (sometimes called the "Extensions Plugin") that lists available plugins.
+Red Hat Developer Hub includes a built-in [**Extensions**](/extensions) catalog (sometimes called the "Extensions Plugin") that lists available plugins.
 
 !!! note "For Administrators Only 🔒"
-    The Extensions marketplace is primarily a tool for **Administrators** and **Platform Engineers**. It allows them to see which plugins are installed, which are available, and to manage their configuration.
+    The Extensions catalog is primarily a tool for **Administrators** and **Platform Engineers**. It allows them to see which plugins are installed, which are available, and to manage their configuration.
 
     As a user, you typically won't use this page to "install" plugins yourself. Instead, you'll work with your administrator to request the plugins your team needs.
 

orchestrator/configs/dynamic-plugins/dynamic-plugins.yaml

@@ -3,40 +3,19 @@ includes:
   - dynamic-plugins.default.yaml
 
 plugins:
-  - package: "https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-1.8.2.tgz"
-    integrity: sha512-rnUA6iZ2JVAyASfwS4P9HeFmpqCgH6FQouzzg4s6lCPAsYUFvu6tifJ3df5lThXPUTJ2cDvvQgamU+4DiHP2jw==
+  - package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator:{{inherit}}'
+    disabled: false
+  - package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-backend:{{inherit}}'
     disabled: false
-    pluginConfig:
-      dynamicPlugins:
-        frontend:
-          red-hat-developer-hub.backstage-plugin-orchestrator:
-            appIcons:
-              - importName: OrchestratorIcon
-                name: orchestratorIcon
-            dynamicRoutes:
-              - importName: OrchestratorPage
-                menuItem:
-                  icon: orchestratorIcon
-                  text: Orchestrator
-                path: /orchestrator
-  - disabled: false
-    package: "https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-1.8.2.tgz"
-    integrity: sha512-6G0YguzCM5nCDpOrIGJpLTXVMr6EBdIVqSXtsLH9RvBH25RTuFpfJ7q6eEp26DqveaiqUCfBpJ51smdjcsEzFQ==
     pluginConfig:
       orchestrator:
         dataIndexService:
           url: http://sonataflow:8899
-  - disabled: false
-    package: "https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-1.8.2.tgz"
-    integrity: sha512-N2hCn9RI/QVEoK56FAkGkSDbvfQCOIzVsJTwDX0kf//npO++2crRSJpB1Lr/m2UtYxfaXZX53p8sPcK3g8yWkQ==
+  - package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-scaffolder-backend-module-orchestrator:{{inherit}}'
+    disabled: false
     pluginConfig:
       orchestrator:
         dataIndexService:
           url: http://sonataflow:8899
-  - disabled: false
-    package: "https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-1.8.2.tgz"
-    integrity: sha512-Pe0dn3g+YTK3jbl36E8nt4zdyH/3w+MWgRyFWPc2B0eV4/L/aRfRC4KxcktmHPdamRGXTIaXL6cFae8TZl8Htw==
-    pluginConfig:
-      dynamicPlugins:
-        frontend:
-          red-hat-developer-hub.backstage-plugin-orchestrator-form-widgets: {}
+  - package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-form-widgets:{{inherit}}'
+    disabled: false