diff --git a/assemblies/assembly-orchestrator-rhdh.adoc b/assemblies/assembly-orchestrator-rhdh.adoc index 6956a6c6c4..94f6aeea98 100644 --- a/assemblies/assembly-orchestrator-rhdh.adoc +++ b/assemblies/assembly-orchestrator-rhdh.adoc @@ -33,4 +33,14 @@ 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] \ No newline at end of file +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/proc-helper-script-overview.adoc[leveloffset=+2] + diff --git a/modules/orchestrator/con-install-components-orchestrator-plugin.adoc b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc new file mode 100644 index 0000000000..70c2ece6aa --- /dev/null +++ b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc @@ -0,0 +1,17 @@ +:_mod-docs-content-type: CONCEPT +[id="con-install-components-orchestrator-plugin_{context}"] += Orchestrator plugin components on {ocp-short} + +To run the Orchestrator plugin successfully on {ocp-short}, you must first install the following required components: + +** {product} ({product-very-short}) {product-custom-resource-type} +** OpenShift Serverless Logic Operator +** OpenShift Serverless Operator +*** Knative Serving +*** Knative Eventing +** (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. +** (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. + +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. + +For specific use cases, you can choose to install the dependencies manually or use helper utilities. \ No newline at end of file diff --git a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc new file mode 100644 index 0000000000..2f1352bc03 --- /dev/null +++ b/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 command 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 manually approve the install plans. +==== \ No newline at end of file diff --git a/modules/orchestrator/proc-helper-script-overview.adoc b/modules/orchestrator/proc-helper-script-overview.adoc new file mode 100644 index 0000000000..3c0c4b0901 --- /dev/null +++ b/modules/orchestrator/proc-helper-script-overview.adoc @@ -0,0 +1,26 @@ +:mod-docs-content-type: PROCEDURE +[id="proc-helper-script-overview.adoc_{context}"] += Installing components using the `{product-very-short}` helper script + +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. + +[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 +---- \ No newline at end of file diff --git a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc b/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc deleted file mode 100644 index fd0d5c8ad9..0000000000 --- a/modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc +++ /dev/null @@ -1,72 +0,0 @@ -:_mod-docs-content-type: PROCEDURE -[id="proc-install-components-for-orchestrator-plugin_{context}"] -= Installing the components for the Orchestrator plugin on {ocp-short} - -To run the Orchestrator plugin successfully on {ocp-short}, you must install components that provide the runtime environment and the dependencies that the plugin requires. - -.Prerequisites - -* To install the Orchestrator plugin on {ocp-short}, you require the following components installed: - -** OpenShift Serverless Operator -** Knative Serving -** Knative Eventing -** OpenShift Serverless Logic Operator -+ -[NOTE] -==== -You must preinstall the components, or install them by using one of the supported methods. -==== - -.Procedure - -To install components (Operators) that provide the dependencies required by the Orchestrator plugin on {ocp-short}, use the following methods: - -* Manual installation -* {product-very-short} helper script -* Orchestrator Infrastructure for {product} Helm chart - -.Manual installation - -Use manual installation for production environments. Choose this method when you have installed the required components versions, such as when other applications are using OpenShift Serverless. - -For more information on preparing the required infrastructure, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.36[Red Hat OpenShift Serverless] to do the following: - -* Prepare for OpenShift Serverless installation - -* Install the OpenShift Serverless Operator - -* Install Knative Serving - -* Install Knative Eventing - -* Install the OpenShift Serverless Logic Operator - -.{product-very-short} helper script -You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. - -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]. - -WARNING: Use the {product-very-short} helper script for a quick-start. Do not use it 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 as shown in the following example: -+ -[source,shell] ----- -$ ./plugin-infra.sh ----- - -.Orchestrator Infrastructure for {product} Helm chart -You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins. - -[IMPORTANT] -==== -By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-install or auto-upgrade the required Serverless Operators: you must approve the install plans. -==== \ No newline at end of file diff --git a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc index 0798af20e3..dda809419d 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc +++ b/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 diff --git a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc new file mode 100644 index 0000000000..3fea61fa71 --- /dev/null +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -0,0 +1,13 @@ +:mod-docs-content-type: PROCEDURE +[id="proc-manual-install-orchestrator-plugin_{context}"] += Installing Orchestrator 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. + +. 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]. + +. (Optional) If required, deploy a custom PostgreSQL database. \ No newline at end of file