RHIDP-7556: Update-Orchestrator-documentation-1.7

assemblies/assembly-orchestrator-rhdh.adoc

@@ -33,4 +33,18 @@ include::modules/orchestrator/con-supported-architecture-for-orchestrator.adoc[l
 include::modules/orchestrator/con-understanding-orchestrator-plugin-dependencies-operator.adoc[leveloffset=+1]
 
 // installing the components for the orchestrator plugin
-include::modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc[leveloffset=+1]
+include::modules/orchestrator/con-install-components-orchestrator-plugin.adoc[leveloffset=+1]
+
+// Orchestrator Infrastructure for {product} Helm chart
+include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2]
+
+// manual installation
+include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+2]
+
+// {product-very-short} helper script
+include::modules/orchestrator/con-helper-scripts-overview.adoc[leveloffset=+2]
+
+include::modules/orchestrator/proc-setup-sh-init-script.adoc[leveloffset=+3]
+
+include::modules/orchestrator/proc-plugin-infra-install.adoc[leveloffset=+3]
+

modules/orchestrator/con-helper-scripts-overview.adoc

@@ -0,0 +1,21 @@
+:mod-docs-content-type: CONCEPT
+[id="con-helper-scripts-overview_{context}"]
+= Helper scripts overview for the Orchestrator on {ocp-short}
+
+The following scripts streamline non-production setup:
+
+* `setup.sh`: Initializes the {product-very-short} environment by creating the required authentication secret and labeling GitOps namespaces based on cluster configuration.
+
+* `plugin-infra.sh`: Installs the OpenShift Serverless infrastructure required by the Orchestrator plugin.
+
+[NOTE]
+====
+These scripts are intended for quick-start scenarios and are **not recommended for production**.
+====
+
+[IMPORTANT]
+====
+The `setup.sh` script is no longer needed for the core Orchestrator installation in {product-very-short}. The scripts primary function is to ease the installation of GitOps prerequisites like ArgoCD and to connect an authentication provider.
+====
+
+For more information on controlling the installation of the Operators, see link:https://olm.operatorframework.io/docs/tasks/install-operator-with-olm/[Install your Operator with OLM].

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

@@ -0,0 +1,17 @@
+:_mod-docs-content-type: CONCEPT
+[id="con-install-components-orchestrator-plugin_{context}"]
+= Installing components for the Orchestrator plugin on {ocp-short}
+
+To run the Orchestrator plugin successfully on {ocp-short}, you must first install the required dependencies. The Orchestrator plugin depends on the following components:
+
+** {product} ({product-very-short}) {product-custom-resource-type}
+** OpenShift Serverless Logic Operator
+** OpenShift Serverless Operator
+*** Knative Serving
+*** Knative Eventing
+** (Optional) An ArgoCD project named orchestrator requires a pre-installed ArgoCD or {company-name} OpenShift GitOps instance in the cluster. It is disabled by default.
+** (Optional) Tekton tasks and build pipeline. These require a pre-installed Tekton or {company-name} OpenShift Pipelines instance in the cluster, and are disabled by default.
+
+The most recommended approach to installing the dependencies for the Orchestrator plugin is by enabling the Orchestrator plugin's dependencies 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.
+
+For specific use cases, you can choose to install the dependencies manually or use helper utilities.

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

@@ -0,0 +1,16 @@
+:mod-docs-content-type: PROCEDURE
+[id="proc-helm-install-components-orchestrator-plugin_{context}"]
+= Installing components using the Orchestrator Infrastructure for {product} Helm chart
+
+You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins.
+
+.Procedure
+
+. Run the `helm install` command for the `orchestrator-infra` chart. This initiates the installation of the Red Hat Serverless Operator and Red Hat Serverless Logic Operator components.
+
+. Manually approve the install plans for the Operators. You must run the `oc patch installplan` commands provided in the output to approve their installation.
+
+[IMPORTANT]
+====
+By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-approve the required Serverless Operators. You must approve the install plans.
+====

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

@@ -12,22 +12,20 @@ You can install {product} ({product-very-short}) with the Orchestrator by using
 
 .Procedure
 
-. In the {ocp-short} web console, go to menu:Helm[Helm Charts].
+. In the {ocp-short} web console, go to the Helm Charts and verify that the {product} Helm chart repository is available.
 
-. Click btn:[Repository] and confirm that the {product} Helm chart repository is available.
-
-. Search for the Orchestrator infrastructure for {product} and click btn:[Install].
+. Search for the Orchestrator infrastructure for {product} and select *Install*.
 +
 [IMPORTANT]
 ====
-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.
+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.
 ====
 +
 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.
 
 . Wait until they are successfully deployed.
 
-. Monitor the deployment status by navigating to menu:Workloads[Pods] or menu:Helm[Releases].
+. Monitor the deployment status by navigating to *Pods* or releases.
 
 .Verification
 

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

@@ -0,0 +1,11 @@
+:mod-docs-content-type: PROCEDURE
+[id="proc-manual-install-orchestrator-plugin_{context}"]
+= Manually installing components on {ocp-short}
+
+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.
+
+.Procedure
+
+. 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.
+
+. If required, deploy a custom PostgreSQL database. You must also configure workflow persistence. You must configure persistence to prevent workflow context from being lost when the pod restarts. You can do this 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].

modules/orchestrator/proc-plugin-infra-install.adoc

@@ -0,0 +1,26 @@
+:mod-docs-content-type: PROCEDURE
+[id="proc-plugin-infra-install_{context}"]
+= Installing dependencies using `plugin-infra.sh`
+
+You can use the `{product-very-short}` helper script `plugin-infra.sh` to quickly install the OpenShift Serverless infrastructure required by the Orchestrator plugin.
+
+[WARNING]
+====
+Do not use `plugin-infra.sh` in production.
+====
+
+.Procedure
+
+. Download the `plugin-infra.sh` script as shown in the following example:
++
+[source,terminal,subs="+attributes,+quotes"]
+----
+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
+----
+
+. Run the script:
++
+[source,terminal]
+----
+$ ./plugin-infra.sh
+----

modules/orchestrator/proc-setup-sh-init-script.adoc

@@ -0,0 +1,30 @@
+:mod-docs-content-type: PROCEDURE
+[id="proc-setup-sh-init-script_{context}"]
+= Installing components using the `setup.sh` script
+
+The `setup.sh` script simplifies the installation of GitOps prerequisites, such as getting the ArgoCD URL and password, or for connecting to an authentication provider.
+
+.Procedure
+
+. Create a namespace for the {product-very-short} instance. This namespace is predefined as the default in the script, but you can override it as shown in the following example:
++
+[subs="quotes+"]
+----
+oc new-project ${product-very-short}
+----
+
+. Download the setup script:
++
+[source,terminal,subs="+attributes,+quotes"]
+----
+wget https://raw.githubusercontent.com/rhdhorchestrator/orchestrator-go-operator/release-${PRODUCT_VERSION}/hack/setup.sh -O /tmp/setup.sh \ && chmod u+x /tmp/setup.sh # Specify the {product} version in the URL
+----
+
+. Run the setup script:
++
+[source,terminal]
+----
+/tmp/setup.sh --use-default
+----
++
+To specify custom values, omit the `--use-default` option. The script will then prompt you for input.