Skip to content

Commit 1fecce1

Browse files
jmagakGitHub Actions
andauthored
RHIDP-7556: Update-Orchestrator-documentation-1.7 (#1338)
* Update the orchestrator modules * Update the orchestrator modules * Update the orchestrator modules * Apply Elai and Piotr suggestions * Apply Yona's comments * Apply Elai and Jona's suggestions * Apply Jennifer's suggestion * Apply Jennifer's suggestion * Incorporate Peer reviewers comments --------- Co-authored-by: GitHub Actions <[email protected]>
1 parent 203f27e commit 1fecce1

7 files changed

+87
-79
lines changed

assemblies/assembly-orchestrator-rhdh.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,14 @@ include::modules/orchestrator/con-supported-architecture-for-orchestrator.adoc[l
3333
include::modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc[leveloffset=+1]
3434

3535
// installing the components for the orchestrator plugin
36-
include::modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc[leveloffset=+1]
36+
include::modules/orchestrator/con-install-components-orchestrator-plugin.adoc[leveloffset=+1]
37+
38+
// Orchestrator Infrastructure for {product} Helm chart
39+
include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2]
40+
41+
// manual installation
42+
include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+2]
43+
44+
// {product-very-short} helper script
45+
include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2]
46+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
:_mod-docs-content-type: CONCEPT
2+
[id="con-install-components-orchestrator-plugin_{context}"]
3+
= Orchestrator plugin components on {ocp-short}
4+
5+
To run the Orchestrator plugin successfully on {ocp-short}, you must first install the following required components:
6+
7+
** {product} ({product-very-short}) {product-custom-resource-type}
8+
** OpenShift Serverless Logic Operator
9+
** OpenShift Serverless Operator
10+
*** Knative Serving
11+
*** Knative Eventing
12+
** (Optional) For managing the Orchestrator project, you need a preinstalled instance of Argo CD or {company-name} OpenShift GitOps in the cluster. It is disabled by default.
13+
** (Optional) To use Tekton tasks and the build pipeline, you need a preinstalled instance of Tekton or {company-name} OpenShift Pipelines in the cluster. These features are disabled by default.
14+
15+
The most recommended approach to install the dependencies for the Orchestrator plugin is by enabling the dependencies for the Orchestrator plugin directly during your {product-very-short} installation. When you configure {product-very-short} to include the Orchestrator plugin, the {product-very-short} Operator installs the necessary OpenShift Serverless operators, eliminating the need for separate scripts or Helm charts.
16+
17+
For specific use cases, you can choose to install the dependencies manually or use helper utilities.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:mod-docs-content-type: PROCEDURE
2+
[id="proc-helm-install-components-orchestrator-plugin_{context}"]
3+
= Installing components using the Orchestrator Infrastructure for {product} Helm chart
4+
5+
You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins.
6+
7+
.Procedure
8+
9+
. 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.
10+
11+
. Manually approve the install plans for the Operators. You must run the `oc patch installplan` commands provided in the output to approve their installation.
12+
13+
[IMPORTANT]
14+
====
15+
By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-approve the required Serverless Operators. You must manually approve the install plans.
16+
====
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
:mod-docs-content-type: PROCEDURE
2+
[id="proc-helper-script-overview.adoc_{context}"]
3+
= Installing components using the `{product-very-short}` helper script
4+
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.
6+
7+
[WARNING]
8+
====
9+
Do not use `plugin-infra.sh` in production.
10+
====
11+
12+
.Procedure
13+
14+
. Download the `plugin-infra.sh` script as shown in the following example:
15+
+
16+
[source,terminal,subs="+attributes,+quotes"]
17+
----
18+
curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs/heads/release-${PRODUCT_VERSION}/config/profile/rhdh/plugin-infra/plugin-infra.sh # Specify the {product} version in the URL or use main
19+
----
20+
21+
. Run the script:
22+
+
23+
[source,terminal]
24+
----
25+
$ ./plugin-infra.sh
26+
----

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

Lines changed: 0 additions & 72 deletions
This file was deleted.

modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,20 @@ You can install {product} ({product-very-short}) with the Orchestrator by using
1212
1313
.Procedure
1414

15-
. In the {ocp-short} web console, go to menu:Helm[Helm Charts].
15+
. In the {ocp-short} web console, go to the Helm Charts and verify that the {product} Helm chart repository is available.
1616

17-
. Click btn:[Repository] and confirm that the {product} Helm chart repository is available.
18-
19-
. Search for the Orchestrator infrastructure for {product} and click btn:[Install].
17+
. Search for the Orchestrator infrastructure for {product} and select *Install*.
2018
+
2119
[IMPORTANT]
2220
====
23-
You must be an administrator to install the Orchestrator Infrastructure for {product} Helm chart because it deploys cluster-scoped resources. As an administrator, you need to manually approve the install plans for OpenShift Serverless and Serverless Logic Operators.
21+
You must be an administrator to install the Orchestrator Infrastructure for {product} Helm chart because it deploys cluster-scoped resources. As an administrator, you must manually approve the install plans for OpenShift Serverless and Serverless Logic Operators.
2422
====
2523
+
2624
As a regular user, search for the {product} chart and install it by setting the value of `orchestrator.enabled` to `true`. Otherwise, the Orchestrator will not be deployed.
2725

2826
. Wait until they are successfully deployed.
2927

30-
. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases].
28+
. Monitor the deployment status by navigating to *Pods* or releases.
3129

3230
.Verification
3331

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:mod-docs-content-type: PROCEDURE
2+
[id="proc-manual-install-orchestrator-plugin_{context}"]
3+
= Installing Orchestrator components on {ocp-short}
4+
5+
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.
6+
7+
.Procedure
8+
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.
10+
11+
. 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].
12+
13+
. (Optional) If required, deploy a custom PostgreSQL database.

0 commit comments

Comments
 (0)