Skip to content

Commit 884e0f3

Browse files
authored
chore(orchestrator): Update list of main Orchestrator plugins in README (#983)
Signed-off-by: Marek Libra <marek.libra@gmail.com>
1 parent 95bc75b commit 884e0f3

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

workspaces/orchestrator/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,19 @@ The architecture adheres to standard Backstage plugin guidelines and requires th
1515
- Provides the frontend interface.
1616

1717
2. **`backstage-plugin-orchestrator-backend`**
18+
1819
- Serves as a backend proxy between Backstage and SonataFlow.
1920

21+
3. **`backstage-plugin-orchestrator-form-widgets`**
22+
23+
- Provides custom widgets for the workflow execution form.
24+
- Check for [more details](./docs/orchestratorFormWidgets.md).
25+
26+
4. **`scaffolder-backend-module-orchestrator`**
27+
28+
- Provides callable actions from [scaffolder templates](https://backstage.io/docs/features/software-templates/writing-custom-actions), like `orchestrator:workflow:run` or `orchestrator:workflow:get_params`.
29+
- Check for [more details](./plugins/scaffolder-backend-module-orchestrator/README.md).
30+
2031
These plugins farther import following isolated plugins:
2132

2233
1. **`backstage-plugin-orchestrator-swf-editor-envelope`**
@@ -36,10 +47,6 @@ These plugins farther import following isolated plugins:
3647
- Defines the API for extending the workflow execution form.
3748
- For more details, see the [Extensible Form Documentation](./docs/extensibleForm.md).
3849

39-
5. **`backstage-plugin-orchestrator-form-widgets`**
40-
41-
- Provides the workflow execution form custom widgets.
42-
4350
For more details about architecture, see the [Architecture](https://www.rhdhorchestrator.io/main/docs/architecture/) page.
4451

4552
## Install as a static plugin
@@ -118,7 +125,7 @@ Follows these instructions to install the orchestrator plugin in a backstage env
118125

119126
## Install as a dynamic plugin in Red Hat Developer Hub
120127

121-
Follow [these guidelines](https://github.com/rhdhorchestrator/orchestrator-helm-operator/blob/main/docs/release-1.3/existing-rhdh.md#install-the-orchestrator-operator) to install the orchestrator operator and configure the orchestrator as a dynamic plugin in Red Hat Developer Hub.
128+
Follow [these guidelines](https://github.com/rhdhorchestrator/orchestrator-helm-operator/blob/main/docs/main/existing-rhdh.md#install-the-orchestrator-operator) to install the orchestrator operator and configure the orchestrator as a dynamic plugin in Red Hat Developer Hub.
122129

123130
## Configuration
124131

@@ -204,7 +211,7 @@ Their implementation lives in the [plugins/scaffolder-backend-module-orchestrato
204211

205212
The orchestrator backend has audit logs for all incoming requests.
206213

207-
For more information about audit logs in RHDH, please refer to [the official documentation](https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.4/html/audit_log/assembly-audit-log).
214+
For more information about audit logs in RHDH, please refer to [the official documentation](https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html/audit_logs_in_red_hat_developer_hub/index).
208215
[The official Log storage OpenShift documentation](https://docs.openshift.com/container-platform/4.15/observability/logging/log_storage/about-log-storage.html) may also be of interest.
209216

210217
## Extensible workflow execution form
@@ -229,8 +236,6 @@ This will trigger a docker container run of devmode SonataFlow as described in [
229236

230237
More development guidelines available in the [contributors documentation](./docs/Contributors.md).
231238

232-
## Enable in rhdh repo locally
239+
## Enable in RHDH repo locally
233240

234241
If you're running a local clone of [Red Hat Developer Hub (RHDH)](https://github.com/redhat-developer/rhdh) and want to use the Orchestrator plugin as a dynamic plugin, we've included a helper script to streamline this setup.
235-
236-
Please refer to the [Enabling the Orchestrator Plugin in rhdh repo locally](./workspaces/orchestrator/README.md#-enabling-the-orchestrator-plugin-in-red-hat-developer-hub) section for detailed instructions.

0 commit comments

Comments
 (0)