-
Bug
-
Resolution: Unresolved
-
Undefined
-
None
-
1.8.0
-
None
-
False
-
-
False
-
-
-
RHDH Documentation 3283
Description of problem:
The documentation to install the Orchestrator plugins using the Operator is wrong, as the version listed is not valid. The documentation refers to:
plugins: - package: "@redhat/backstage-plugin-orchestrator@1.8.0" disabled: false - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.8.0" disabled: false - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.8.0" disabled: false - package: "@redhat/backstage-plugin-orchestrator-form-widgets@1.8.0" disabled: false - package: "@redhat/backstage-plugin-orchestrator-common@1.8.0" disabled: false - package: "@redhat/backstage-plugin-orchestrator-form@1.8.0" disabled: false - package: "@redhat/backstage-plugin-orchestrator-form-api@1.8.0" disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-notifications" disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-signals" disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-notifications-backend-dynamic" disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" disabled: false
When the right configuration is:
- package: "@redhat/backstage-plugin-orchestrator@1.8.2" disabled: false - package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.8.2" disabled: false dependencies: - ref: sonataflow - package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.8.2" disabled: false - package: "@redhat/backstage-plugin-orchestrator-form-widgets@1.8.2" disabled: false
That definition is correctly described in the GitHub Operator repository: https://github.com/redhat-developer/rhdh-operator/blob/main/docs/orchestrator.md#installing-the-orchestrator-plugin
The following references are wrong:
- https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.8/html-single/orchestrator_in_red_hat_developer_hub/index#con-orchestrator-plugin-dependencies-operator.adoc_orchestrator-rhdh
- https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.8/html/orchestrator_in_red_hat_developer_hub/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator_install-rhdh-orchestrator#proc-install-rhdh-orchestrator-airgapped-env-using-operator-full_install-rhdh-orchestrator
Prerequisites (if any, like setup, operators/versions):
Steps to Reproduce
Following the original documentation, RHDH fails with the following error:
======= Installing dynamic plugin @redhat/backstage-plugin-orchestrator-backend-dynamic@1.8.0 Traceback (most recent call last): File "/opt/app-root/src/install-dynamic-plugins.py", line 658, in <module> main() File "/opt/app-root/src/install-dynamic-plugins.py", line 644, in main _, plugin_config = install_plugin(plugin, plugin_path_by_hash, dynamicPluginsRoot, skipIntegrityCheck) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/opt/app-root/src/install-dynamic-plugins.py", line 377, in install_plugin plugin_path = installer.install(plugin, plugin_path_by_hash) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/opt/app-root/src/install-dynamic-plugins.py", line 273, in install raise InstallException(f"No integrity hash provided for Package {package}") InstallException: No integrity hash provided for Package @redhat/backstage-plugin-orchestrator-backend-dynamic@1.8.0
