Skip to content

Commit 37f5f54

Browse files
openshift-cherrypick-robotGitHub Actions
andauthored
[release-1.7] RHIDP-8815: Updates on the Orchestrator documentation into RHDH (#1353)
* Update the orchestrator section * Update the orchestrator section --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent d45ad2c commit 37f5f54

5 files changed

+10
-10
lines changed

assemblies/assembly-orchestrator-rhdh.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ To start using Orchestrator in {product-very-short}, you must:
3030
include::modules/orchestrator/con-supported-architecture-for-orchestrator.adoc[leveloffset=+1]
3131

3232
// provisioning plugin dependencies
33-
include::modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc[leveloffset=+1]
33+
include::modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc[leveloffset=+1]
3434

3535
// installing the components for the orchestrator plugin
36-
include::modules/orchestrator/con-install-components-orchestrator-plugin.adoc[leveloffset=+1]
36+
include::modules/orchestrator/con-orchestrator-plugin-components.adoc[leveloffset=+1]
3737

3838
// Orchestrator Infrastructure for {product} Helm chart
3939
include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2]

modules/orchestrator/con-install-components-orchestrator-plugin.adoc renamed to modules/orchestrator/con-orchestrator-plugin-components.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:_mod-docs-content-type: CONCEPT
2-
[id="con-install-components-orchestrator-plugin_{context}"]
2+
[id="con-orchestrator-plugin-components.adoc_{context}"]
33
= Orchestrator plugin components on {ocp-short}
44

55
To run the Orchestrator plugin successfully on {ocp-short}, you must first install the following required components:
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
:_mod-docs-content-type: CONCEPT
2-
[id="con-understanding-orchestrator-plugin-dependencies-operator_{context}"]
3-
= Understanding Orchestrator plugin dependencies for Operator installation
2+
[id="con-orchestrator-plugin-dependencies-operator.adoc_{context}"]
3+
= Orchestrator plugin dependencies for Operator installation
44

5-
The Orchestrator plugin in {product-very-short} requires components such as SonataFlow and supporting network policies to run. When you enable the plugin in your {product-custom-resource-type} custom resource (CR), the Operator automatically provisions these dependencies for you:
5+
When you enable the Orchestrator plugin in your {product-custom-resource-type} custom resource (CR), the Operator automatically provisions the following required dependencies:
66

77
* A `SonataflowPlatform` CR
88
* `NetworkPolicies` that allow traffic between infrastructure resources (Knative, Serverless Logic Operator), monitoring traffic, and intra-namespace traffic
99
10-
The `orchestrator-backend` plugin uses the `sonataflow-platform-data-index-service`, which the `SonataFlowPlatform` CR creates to communicate with the SonataFlow platform.
10+
The Orchestrator plugin requires these components to run. For example, to communicate with the SonataFlow platform, the Orchestrator plugin uses the `sonataflow-platform-data-index-service`, which is created by the `SonataFlowPlatform` CR.
1111

1212
[IMPORTANT]
1313
====

modules/orchestrator/proc-helper-script-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
[id="proc-helper-script-overview.adoc_{context}"]
33
= Installing components using the `{product-very-short}` helper script
44

5-
You can use the `{product-very-short}` helper script `plugin-infra.sh` to quickly install the OpenShift Serverless infrastructure and Openshift Serverless Logic infrastructure required by the Orchestrator plugin.
5+
You can use the {product-very-short} helper script `plugin-infra.sh` to quickly install the OpenShift Serverless infrastructure and Openshift Serverless Logic infrastructure required by the Orchestrator plugin.
66

77
[WARNING]
88
====

modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:mod-docs-content-type: PROCEDURE
22
[id="proc-manual-install-orchestrator-plugin_{context}"]
3-
= Installing Orchestrator components on {ocp-short}
3+
= Installing Orchestrator components manually on {ocp-short}
44

55
Use manual installation when you want full control of the setup process and component versions. Manual installation method focuses on setting up the underlying infrastructure.
66

77
.Procedure
88

9-
. Install the OpenShift Serverless components. If you wish to manually install the OpenShift Serverless components, follow the instructions in the link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36[Red Hat OpenShift Serverless] documentation.
9+
. Install the OpenShift Serverless components manually by following the instructions in the link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36[Red Hat OpenShift Serverless] documentation.
1010

1111
. You must also configure workflow persistence to prevent workflow context from being lost when the Pod restarts. You can do this configuration at the namespace level using the `SonataFlowPlatform` or `SonataFlow` custom resources (CR). For detailed instructions on configuring persistence using the `SonataFlowPlatform` or `SonataFlow` custom resources, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence].
1212

0 commit comments

Comments
 (0)