diff --git a/assemblies/assembly-orchestrator-rhdh.adoc b/assemblies/assembly-orchestrator-rhdh.adoc index 2e8e0b7f4b..a155a47be6 100644 --- a/assemblies/assembly-orchestrator-rhdh.adoc +++ b/assemblies/assembly-orchestrator-rhdh.adoc @@ -24,7 +24,6 @@ To start using Orchestrator in {product-very-short}, you must: * Install the required infrastructure components, such as Red Hat OpenShift Serverless Operator, Knative Serving, Knative Eventing, and OpenShift Serverless Logic Operator * Configure your {product-custom-resource-type} custom resource (CR) or Helm values file for Orchestrator -* Import the Orchestrator software templates into the {product} catalog // orchestrator architecture include::modules/orchestrator/con-architecture-overview.adoc[leveloffset=+1] @@ -48,4 +47,4 @@ include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2] // best practices when creating workflows -include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1] \ No newline at end of file +include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1] diff --git a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc index 7fce154dcb..961515c066 100644 --- a/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc +++ b/modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc @@ -47,13 +47,10 @@ Provides the backend components for notification user experience enhancements al .Prerequisites -* When using the {product} Helm chart, you have installed the necessary OpenShift Serverless Operators. +* You have installed the following operators: + -[NOTE] -==== -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. -==== - +** Openshift Serverless +** Openshift Serverless Logic (OSL) * (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. * (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: disabled: false - package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic" disabled: false ----- \ 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 index 365c156245..0f1710d211 100644 --- a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc @@ -8,6 +8,16 @@ You can use Orchestrator Infrastructure for {product} to install components for .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. ++ +[source,terminal,subs="attributes+"] +---- +helm install redhat-developer/redhat-developer-hub-orchestrator-infra +---- ++ +[NOTE] +==== +You must complete this one-off requirement before enabling the Orchestrator plugin. +==== . Manually approve the install plans for the Operators. You must run the `oc patch installplan` commands provided in the output to approve their installation. diff --git a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc index 5aad946258..57588a4103 100644 --- a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -8,7 +8,11 @@ Use manual installation when you want full control of the setup process and comp .Procedure . Install the OpenShift Serverless components manually by following the instructions in the {rhoserverless-link}[{rhoserverless-brand-name}] 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 {rhoserverless-link}/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence]. - . (Optional) If required, deploy a custom PostgreSQL database. + +[IMPORTANT] +==== +Prevent workflow context from being lost when the Pod restarts by configuring workflow persistence. +You can configure persistence at the namespace level by using the `SonataFlowPlatform` or `SonataFlow` custom resources (CR). +For more information, check the {rhoserverless-link}/html-single/serverless_logic/index#serverless-logic-managing-persistence[Managing workflow persistence] documentation. +====