Skip to content

Commit 6983232

Browse files
author
GitHub Actions
committed
Apply Janas suggestions
1 parent 89f410a commit 6983232

File tree

6 files changed

+36
-29
lines changed

6 files changed

+36
-29
lines changed

assemblies/assembly-orchestrator-rhdh.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ include::modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc
3535
// installing the components for the orchestrator plugin
3636
include::modules/orchestrator/con-orchestrator-plugin-components.adoc[leveloffset=+1]
3737

38+
// enabling orchestrator plugins components
39+
include::modules/orchestrator/proc-enabling-orchestrator-plugins.adoc[leveloffset=+1]
40+
3841
// Orchestrator Infrastructure for {product} Helm chart
3942
include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2]
4043

-669 KB
Binary file not shown.
-505 KB
Binary file not shown.
-298 KB
Binary file not shown.

modules/orchestrator/con-architecture-overview.adoc

Lines changed: 10 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,25 @@
33
[id="con-architecture-overview.adoc_{context}"]
44
= Architecture overview
55

6-
You can use Orchestrator to design, run, and monitor workflows that automate key tasks. The Orchestrator relies on core components, such as SonataFlow and OpenShift Serverless, to provide the necessary runtime environment and event-driven capabilities needed to power your workflows.
7-
8-
image::rhdh/system-context-diagram-orch.png[]
9-
10-
The Orchestrator architecture is composed of several integral components, each contributing to the seamless execution and management of workflows.
11-
12-
image::rhdh/container-diagram-orch.png[]
13-
14-
The following is a breakdown of these components:
6+
The Orchestrator architecture is composed of several integral components, each contributing to the seamless running and management of workflows.
157

168
{product} ({product-very-short}):: Serves as the primary interface. {product-custom-resource-type} fulfills the following roles:
179

18-
* Orchestrator Plugins: Both frontend and backend present deployed workflows for execution and monitoring.
19-
* Notifications Plugin: Inform users about workflow events.
10+
* Orchestrator Plugins: Both frontend and backend plugins provide the interface and necessary data retrieval for users to run and monitor workflows within {product-very-short}.
11+
* Notifications Plugin: Informs users about workflow events.
2012

21-
image::rhdh/orchestrator-plugins.png[]
13+
OpenShift Serverless Logic Operator:: Manages the Sonataflow custom resource (CR), where each CR represents a deployed workflow.
2214

23-
OpenShift Serverless Logic Operator:: This controller manages the Sonataflow custom resource (CR), where each CR denotes a deployed workflow.
24-
25-
Sonataflow Runtime/Workflow Application:: Functions as a deployed workflow. Sonataflow Runtime is managed as a Kubernetes (K8s) deployment by the Operator. It operates as an HTTP server catering to requests for executing workflow instances. Within the Orchestrator deployment, each Sonataflow custom resource (CR) corresponds to a singular workflow. However, outside this scope, Sonataflow Runtime can handle multiple workflows. The Orchestrator backend plugin facilitates the interaction with Sonataflow Runtime for workflow execution.
15+
Sonataflow Runtime/Workflow Application:: Functions as a deployed workflow. Operates as an HTTP server, catering to requests for running workflow instances. Sonataflow Runtime is managed as a Kubernetes (K8s) deployment by the Openshift Serverless Logic Operator. Within the Orchestrator deployment, each Sonataflow custom resource (CR) corresponds to a singular workflow. However, outside this scope, Sonataflow Runtime can handle multiple workflows. The Orchestrator backend plugin facilitates the interaction with Sonataflow Runtime for workflow execution.
2616

2717
Data Index Service:: Serves as a repository for workflow definitions, instances, and associated jobs. It exposes a GraphQL API used by the Orchestrator backend plugin to retrieve workflow definitions and instances.
2818

29-
Job Service:: Dedicated to orchestrating scheduled tasks for workflows.
30-
31-
OpenShift Serverless:: This Operator furnishes serverless capabilities essential for workflow communication. It employs Knative eventing to interface with the Data Index service and uses Knative functions to introduce more intricate logic to workflows.
32-
33-
PostgreSQL Server:: PostgreSQL Server provides a robust and reliable database solution essential for data persistence within the Orchestrator ecosystem. The system uses PostgreSQL Server for storing both Sonataflow information and {product-custom-resource-type} data.
34-
35-
KeyCloak:: KeyCloak is essential for authentication and security services within applications. KeyCloak must be provisioned externally to manage authentication, as the Orchestrator Operator does not install it.
19+
Job Service:: Orchestrates scheduled tasks for workflows.
3620

37-
OpenShift AMQ Streams (Strimzi/Kafka):: This Operator is crucial for ensuring the reliability of the eventing system. While the eventing can work without Kafka by using direct HTTP calls, this approach is not reliable. The AMQ Streams Operator is not natively present or integrated into the deployment current iteration.
21+
OpenShift Serverless:: Furnishes serverless capabilities essential for workflow communication. It employs Knative eventing to interface with the Data Index service and uses Knative functions to introduce more intricate logic to workflows.
3822

39-
{product-very-short} includes the following Orchestrator plugin components in the `dynamic-plugins.default.yaml` file, but it disables them by default:
23+
PostgreSQL Server:: Provides a robust and reliable database solution essential for data persistence within the Orchestrator ecosystem. The system uses PostgreSQL Server for storing both Sonataflow information and {product-custom-resource-type} data.
4024

41-
* `"backstage-plugin-orchestrator"`
42-
* `"backstage-plugin-orchestrator-backend-dynamic"`
43-
* `"backstage-plugin-scaffolder-backend-module-orchestrator-dynamic"`
44-
* `"backstage-plugin-orchestrator-form-widgets"`
25+
KeyCloak:: Provides authentication and security services within applications. KeyCloak must be provisioned externally to manage authentication, as the Orchestrator Operator does not install it.
4526

46-
To enable these plugins, you must set the `plugins.disabled` parameter to `false`.
27+
OpenShift AMQ Streams (Strimzi/Kafka):: Ensures the reliability of the eventing system. While the eventing can work without Kafka by using direct HTTP calls, this approach is not reliable. The AMQ Streams Operator is not natively present or integrated into the deployment current iteration.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="proc-enabling-orchestrator-plugins.adoc_{context}"]
4+
= Enabling Orchestrator plugins components
5+
6+
{product} includes the following Orchestrator plugin components in the `dynamic-plugins.default.yaml` file, but they are disabled by default:
7+
8+
* `"backstage-plugin-orchestrator"`
9+
* `"backstage-plugin-orchestrator-backend-dynamic"`
10+
* `"backstage-plugin-scaffolder-backend-module-orchestrator-dynamic"`
11+
* `"backstage-plugin-orchestrator-form-widgets"`
12+
13+
.Procedure
14+
* To enable the Orchestrator plugins, locate your {product-short} configuration and set the `plugins.disabled` parameter to `false` for each required plugin package.
15+
+
16+
For example, to enable the core Orchestrator frontend plugin:
17+
+
18+
[source,yaml,subs="+attributes,+quotes"]
19+
----
20+
plugins:
21+
- package: "@redhat/backstage-plugin-orchestrator@{product-chart-version}"
22+
disabled: false
23+
----

0 commit comments

Comments
 (0)