Skip to content

Commit bce42f9

Browse files
deerskindolljmagakthemr0c
authored
RHDHBUGS-2009: Orchestrator docs update (#1523)
Co-authored-by: Judith Magak <[email protected]> Co-authored-by: Fabrice Flore-Thébault <[email protected]>
1 parent 53311ee commit bce42f9

File tree

4 files changed

+22
-12
lines changed

4 files changed

+22
-12
lines changed

assemblies/assembly-orchestrator-rhdh.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ To start using Orchestrator in {product-very-short}, you must:
2424

2525
* Install the required infrastructure components, such as Red Hat OpenShift Serverless Operator, Knative Serving, Knative Eventing, and OpenShift Serverless Logic Operator
2626
* Configure your {product-custom-resource-type} custom resource (CR) or Helm values file for Orchestrator
27-
* Import the Orchestrator software templates into the {product} catalog
2827
2928
// orchestrator architecture
3029
include::modules/orchestrator/con-architecture-overview.adoc[leveloffset=+1]
@@ -48,4 +47,4 @@ include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin
4847
include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2]
4948

5049
// best practices when creating workflows
51-
include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1]
50+
include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1]

modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,10 @@ Provides the backend components for notification user experience enhancements al
4747

4848
.Prerequisites
4949

50-
* When using the {product} Helm chart, you have installed the necessary OpenShift Serverless Operators.
50+
* You have installed the following operators:
5151
+
52-
[NOTE]
53-
====
54-
When using the {product} Operator, the Operator installs the necessary OpenShift Serverless Operators automatically. For specific use cases, install the dependencies manually or use helper utilities.
55-
====
56-
52+
** Openshift Serverless
53+
** Openshift Serverless Logic (OSL)
5754
* (Optional) For managing the Orchestrator project, you have an instance of Argo CD or Red Hat OpenShift GitOps in the cluster. It is disabled by default.
5855

5956
* (Optional) To use Tekton tasks and the build pipeline, you have an instance of Tekton or Red Hat OpenShift Pipelines in the cluster. These features are disabled by default.
@@ -86,4 +83,4 @@ plugins:
8683
disabled: false
8784
- package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"
8885
disabled: false
89-
----
86+
----

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ You can use Orchestrator Infrastructure for {product} to install components for
88
.Procedure
99

1010
. Run the `helm install` command for the `orchestrator-infra` chart. This command initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components.
11+
+
12+
[source,terminal,subs="attributes+"]
13+
----
14+
helm install <release_name> redhat-developer/redhat-developer-hub-orchestrator-infra
15+
----
16+
+
17+
[NOTE]
18+
====
19+
You must complete this one-off requirement before enabling the Orchestrator plugin.
20+
====
1121

1222
. Manually approve the install plans for the Operators. You must run the `oc patch installplan` commands provided in the output to approve their installation.
1323

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

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,11 @@ Use manual installation when you want full control of the setup process and comp
88
.Procedure
99

1010
. Install the OpenShift Serverless components manually by following the instructions in the {rhoserverless-link}[{rhoserverless-brand-name}] documentation.
11-
12-
. 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 {rhoserverless-link}/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence].
13-
1411
. (Optional) If required, deploy a custom PostgreSQL database.
12+
13+
[IMPORTANT]
14+
====
15+
Prevent workflow context from being lost when the Pod restarts by configuring workflow persistence.
16+
You can configure persistence at the namespace level by using the `SonataFlowPlatform` or `SonataFlow` custom resources (CR).
17+
For more information, check the {rhoserverless-link}/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence] documentation.
18+
====

0 commit comments

Comments
 (0)