Skip to content

Commit e268eb7

Browse files
[release-1.9] docs(orchestrator): document workaround used for starting the Orchestrator in 1.9 [RHDHBUGS-2779] (#184)
Co-authored-by: Armel Soro <armel@rm3l.org> Co-authored-by: Armel Soro <asoro@redhat.com>
1 parent 3b771cb commit e268eb7

1 file changed

Lines changed: 25 additions & 7 deletions

File tree

orchestrator/README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,38 @@
33
> **Note:** All instructions in this guide apply to both Podman and Docker.
44
> Replace `podman compose` with `docker compose` if you are using Docker.
55
6-
Before you begin, ensure to add the `orchestrator/configs/dynamic-plugins/dynamic-plugins.yaml` file to the
7-
list of `includes` in your `configs/dynamic-plugins/dynamic-plugins.override.yaml` to enable orchestrator plugins within RHDH.
8-
Example:
6+
Before you begin, ensure to add the orchestrator plugins to your `configs/dynamic-plugins/dynamic-plugins.override.yaml` to enable them within RHDH.
7+
Copy the [plugins](./configs/dynamic-plugins/dynamic-plugins.yaml#L5-L21)
8+
from `orchestrator/configs/dynamic-plugins/dynamic-plugins.yaml` directly into your override file. Example:
99

1010
```yaml
11-
1211
includes:
1312
- dynamic-plugins.default.yaml
14-
- orchestrator/configs/dynamic-plugins/dynamic-plugins.yaml # <-- to add to enable the Orchestrator plugins
1513

16-
# Below you can add your own custom dynamic plugins, including local ones.
17-
plugins: []
14+
# Add the Orchestrator plugins directly, and add any other plugins you want to install, including local ones.
15+
plugins:
16+
- package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator:{{inherit}}'
17+
disabled: false
18+
- package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-backend:{{inherit}}'
19+
disabled: false
20+
pluginConfig:
21+
orchestrator:
22+
dataIndexService:
23+
url: http://sonataflow:8899
24+
- package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-scaffolder-backend-module-orchestrator:{{inherit}}'
25+
disabled: false
26+
pluginConfig:
27+
orchestrator:
28+
dataIndexService:
29+
url: http://sonataflow:8899
30+
- package: 'oci://registry.access.redhat.com/rhdh/red-hat-developer-hub-backstage-plugin-orchestrator-form-widgets:{{inherit}}'
31+
disabled: false
1832
```
1933
34+
> **Warning:** Do **not** use the `includes` directive to reference `orchestrator/configs/dynamic-plugins/dynamic-plugins.yaml`.
35+
> Due to a [known issue (RHDHBUGS-2779)](https://redhat.atlassian.net/browse/RHDHBUGS-2779), using `includes` for the orchestrator
36+
> dynamic plugins file prevents the Orchestrator profile from starting correctly.
37+
2038
To set up the infrastructure for developing workflow with Orchestrator, you must merge and run these two compose files:
2139
[`compose.yaml`](../compose.yaml) and [`orchestrator/compose.yaml`](./compose.yaml) configs.
2240

0 commit comments

Comments
 (0)