From ff2b5051f332cd2c90e6b4c59565a30767dd95bd Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 29 Aug 2025 17:00:40 +0200 Subject: [PATCH 1/9] Update the orchestrator modules --- assemblies/assembly-orchestrator-rhdh.adoc | 15 +++- .../con-helper-scripts-overview.adoc | 15 ++++ ...nstall-components-orchestrator-plugin.adoc | 28 ++++++++ ...nstall-components-orchestrator-plugin.adoc | 16 +++++ ...ll-components-for-orchestrator-plugin.adoc | 72 ------------------- ...all-rhdh-with-orchestrator-helm-webui.adoc | 10 ++- ...nstall-components-orchestrator-plugin.adoc | 65 +++++++++++++++++ .../proc-plugin-infra-install.adoc | 26 +++++++ .../proc-setup-sh-init-script.adoc | 69 ++++++++++++++++++ 9 files changed, 237 insertions(+), 79 deletions(-) create mode 100644 modules/orchestrator/con-helper-scripts-overview.adoc create mode 100644 modules/orchestrator/con-install-components-orchestrator-plugin.adoc create mode 100644 modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc delete mode 100644 modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc create mode 100644 modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc create mode 100644 modules/orchestrator/proc-plugin-infra-install.adoc create mode 100644 modules/orchestrator/proc-setup-sh-init-script.adoc diff --git a/assemblies/assembly-orchestrator-rhdh.adoc b/assemblies/assembly-orchestrator-rhdh.adoc index 6956a6c6c4..bb0fcbc480 100644 --- a/assemblies/assembly-orchestrator-rhdh.adoc +++ b/assemblies/assembly-orchestrator-rhdh.adoc @@ -33,4 +33,17 @@ 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] + +// 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] + +// Orchestrator Infrastructure for {product} Helm chart +include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2] diff --git a/modules/orchestrator/con-helper-scripts-overview.adoc b/modules/orchestrator/con-helper-scripts-overview.adoc new file mode 100644 index 0000000000..fcf31c1b57 --- /dev/null +++ b/modules/orchestrator/con-helper-scripts-overview.adoc @@ -0,0 +1,15 @@ +:mod-docs-content-type: CONCEPT +[id="con-helper-scripts-overview_{context}"] += Helper scripts overview for the Orchestrator on {ocp-short} + +You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. The following helper scripts are available to 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. It can use defaults or prompt for values. +* `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**. +==== + +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]. \ No newline at end of file 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..197e1e1bb6 --- /dev/null +++ b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc @@ -0,0 +1,28 @@ +:_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 install components that provide the runtime environment and the dependencies that the plugin requires. + +.Required components + +* The Orchestrator plugin depends on the following components: + +** OpenShift Serverless Logic Operator +** OpenShift Serverless Operator +*** Knative Serving +*** Knative Eventing +** {product} ({product-very-short}) {product-custom-resource-type} +** (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. ++ +[NOTE] +==== +You must preinstall the components, or install them by using one of the supported methods. +==== + +You can install the components (Operators) that provide the dependencies required by the Orchestrator plugin on {ocp-short} using the following methods: + +* Manual installation +* {product-very-short} helper script +* Orchestrator Infrastructure for {product} Helm chart \ 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..b2e0332e5e --- /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 the Orchestrator plugin components using the 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. +==== + +.Procedure + +. Add or update the Helm repository for Orchestrator Infrastructure for {product}. +. Install the chart with the required configuration for your environment. +. Approve the install plans for the Serverless Operators when prompted. \ 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..8b9fe02988 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 menu:Workloads[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..8ebcb583ba --- /dev/null +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -0,0 +1,65 @@ +:mod-docs-content-type: PROCEDURE +[id="proc-manual-install-orchestrator-plugin_{context}"] += Manually installing the Orchestrator plugin components on {ocp-short} + +Use manual installation when you want full control of the setup process and component versions. + +.Procedure + +. Deploy the PostgreSQL reference implementation for persistence support in SonataFlow. + +. Create a namespace for the Orchestrator solution as shown in the following example: ++ +[subs="quotes+"] +---- +oc new-project ${orchestrator} +---- + +. Run the setup script. +Follow the steps in the _Installing the Orchestrator plugin components using the {product-very-short} helper script_ section to download and execute the `setup.sh` script, which initializes the {product-very-short} environment. + +. Install the Orchestrator Operator in the {ocp-short} cluster by applying the following manifest: ++ +[source,yaml] +---- +apiVersion: operators.coreos.com/v1alpha1 +kind: Subscription +metadata: + name: orchestrator-operator + namespace: openshift-operators +spec: + channel: stable + installPlanApproval: Automatic + name: orchestrator-operator + source: redhat-operators + sourceNamespace: openshift-marketplace +---- + +. Verify installation by running the following command: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +wget https://raw.githubusercontent.com/rhdhorchestrator/orchestrator-go-operator/release-${PRODUCT_VERSION}/hack/wait_for_operator_installed.sh -O /tmp/wait_for_operator_installed.sh \ && chmod u+x /tmp/wait_for_operator_installed.sh \ && /tmp/wait_for_operator_installed.sh # Specify the {product} version in the URL +---- + +During installation, the Orchestrator Operator creates the following sub-components: + +* {product-very-short} Operator +* OpenShift Serverless Operator +* OpenShift Serverless Logic Operator + +It also creates the necessary custom resources (CRs) for Orchestrator to function properly. + +. Apply the Orchestrator custom resource (CR) to the cluster to create an instance of {product-very-short} and resources for OpenShift Serverless and OpenShift Serverless Logic: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +oc apply -n orchestrator -f https://raw.githubusercontent.com/rhdhorchestrator/orchestrator-go-operator/refs/heads/release-${PRODUCT_VERSION}/config/samples/_v1alpha3_orchestrator.yaml # Specify the {product} version in the URL +---- + +[NOTE] +==== +After the first reconciliation of the Orchestrator CR, changes to some fields might not propagate to the intended resources. For example, updating the `platform.resources.requests` field in the Orchestrator CR has no effect on the running SonataFlowPlatform (SFP) resource. +==== + +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]. diff --git a/modules/orchestrator/proc-plugin-infra-install.adoc b/modules/orchestrator/proc-plugin-infra-install.adoc new file mode 100644 index 0000000000..c91c6459bb --- /dev/null +++ b/modules/orchestrator/proc-plugin-infra-install.adoc @@ -0,0 +1,26 @@ +:mod-docs-content-type: PROCEDURE +[id="proc-plugin-infra-install_{context}"] += Installing dependencies with `plugin-infra.sh` + +You can use the `{product-very-short}` helper script `plugin-infra.sh` to 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 +---- \ No newline at end of file diff --git a/modules/orchestrator/proc-setup-sh-init-script.adoc b/modules/orchestrator/proc-setup-sh-init-script.adoc new file mode 100644 index 0000000000..47ac7b8277 --- /dev/null +++ b/modules/orchestrator/proc-setup-sh-init-script.adoc @@ -0,0 +1,69 @@ +:mod-docs-content-type: PROCEDURE +[id="proc-setup-sh-init-script_{context}"] += Installing the Orchestrator plugin components using the `setup.sh` script + +The `setup.sh` script simplifies the initialization of the {product-very-short} environment by: + +* Creating the required authentication secret. +* Labeling GitOps namespaces based on the cluster configuration. + +.Procedure + +. Create a namespace for the {product-very-short} instance. This namespace is predefined as the default in both the `setup.sh` script and the Orchestrator CR, but you can override it as shown in the following example: ++ +[subs="quotes+"] +---- +oc new-project ${product-very-short} +---- + +. Download the setup script from the GitHub repository: ++ +[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 +---- ++ +[NOTE] +==== +To specify custom values, omit the `--use-default` option. The script will then prompt you for input. +==== + +The contents of the secret vary depending on cluster configuration and can include the following keys: + +* `BACKEND_SECRET`: Randomly generated. This is mandatory for the {product-very-short} Operator to start. +* `K8S_CLUSTER_URL`: Dynamically obtained with `oc whoami --show-server`. +* `K8S_CLUSTER_TOKEN`: Dynamically obtained from the service account and namespace. +* `GITHUB_TOKEN`: Prompted from the user. +* `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET`: Used to authenticate against GitHub. +* `GITLAB_HOST` and `GITLAB_TOKEN`: Used to authenticate against GitLab. +* `ARGOCD_URL`: Obtained from the first ArgoCD instance available. +* `ARGOCD_USERNAME`: Defaults to `admin`. +* `ARGOCD_PASSWORD`: Obtained dynamically from the ArgoCD instance. + +Keys without values are omitted. For example, if no GitOps operator is installed, the ArgoCD-related keys are excluded. + +.Sample secret in a GitOps environment: +[source,yaml] +---- +apiVersion: v1 +data: + ARGOCD_PASSWORD: ... + ARGOCD_URL: ... + ARGOCD_USERNAME: ... + BACKEND_SECRET: ... + GITHUB_TOKEN: ... + K8S_CLUSTER_TOKEN: ... + K8S_CLUSTER_URL: ... +kind: Secret +metadata: + name: backstage-backend-auth-secret + namespace: rhdh +type: Opaque +---- \ No newline at end of file From 75d879685f496e9bae480969e5e71e2fb2927702 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 29 Aug 2025 17:09:20 +0200 Subject: [PATCH 2/9] Update the orchestrator modules --- .../proc-install-rhdh-with-orchestrator-helm-webui.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 8b9fe02988..dda809419d 100644 --- a/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc +++ b/modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc @@ -25,7 +25,7 @@ As a regular user, search for the {product} chart and install it by setting the . Wait until they are successfully deployed. -. Monitor the deployment status by navigating to menu:Workloads[Pods] or releases. +. Monitor the deployment status by navigating to *Pods* or releases. .Verification From e355f93e25deaa41ca0e8a4c926d4ad486c93a1b Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 2 Sep 2025 01:48:26 +0200 Subject: [PATCH 3/9] Update the orchestrator modules --- .../con-helper-scripts-overview.adoc | 10 +++- ...nstall-components-orchestrator-plugin.adoc | 15 +---- ...nstall-components-orchestrator-plugin.adoc | 2 +- ...nstall-components-orchestrator-plugin.adoc | 58 ++----------------- .../proc-plugin-infra-install.adoc | 4 +- .../proc-setup-sh-init-script.adoc | 49 ++-------------- 6 files changed, 25 insertions(+), 113 deletions(-) diff --git a/modules/orchestrator/con-helper-scripts-overview.adoc b/modules/orchestrator/con-helper-scripts-overview.adoc index fcf31c1b57..6a66dbfd65 100644 --- a/modules/orchestrator/con-helper-scripts-overview.adoc +++ b/modules/orchestrator/con-helper-scripts-overview.adoc @@ -2,9 +2,10 @@ [id="con-helper-scripts-overview_{context}"] = Helper scripts overview for the Orchestrator on {ocp-short} -You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. The following helper scripts are available to streamline non-production setup: +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. -* `setup.sh`: Initializes the {product-very-short} environment by creating the required authentication secret and labeling GitOps namespaces based on cluster configuration. It can use defaults or prompt for values. * `plugin-infra.sh`: Installs the OpenShift Serverless infrastructure required by the Orchestrator plugin. [NOTE] @@ -12,4 +13,9 @@ You can install the OpenShift Serverless infrastructure for the Orchestrator plu 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]. \ No newline at end of file diff --git a/modules/orchestrator/con-install-components-orchestrator-plugin.adoc b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc index 197e1e1bb6..42542f0173 100644 --- a/modules/orchestrator/con-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc @@ -2,26 +2,17 @@ [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 install components that provide the runtime environment and the dependencies that the plugin requires. - -.Required components - -* The Orchestrator plugin depends on the following components: +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 -** {product} ({product-very-short}) {product-custom-resource-type} ** (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. -+ -[NOTE] -==== -You must preinstall the components, or install them by using one of the supported methods. -==== -You can install the components (Operators) that provide the dependencies required by the Orchestrator plugin on {ocp-short} using the following methods: +You can install the components for the Orchestrator plugin on {ocp-short} using one of the following methods: * Manual installation * {product-very-short} helper script diff --git a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc index b2e0332e5e..0553b77215 100644 --- a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc @@ -1,6 +1,6 @@ :mod-docs-content-type: PROCEDURE [id="proc-helm-install-components-orchestrator-plugin_{context}"] -= Installing the Orchestrator plugin components using the Orchestrator Infrastructure for {product} Helm chart += Installing components using the Orchestrator Infrastructure for {product} Helm chart You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins. diff --git a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc index 8ebcb583ba..1d5c81ff20 100644 --- a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -1,65 +1,19 @@ :mod-docs-content-type: PROCEDURE [id="proc-manual-install-orchestrator-plugin_{context}"] -= Manually installing the Orchestrator plugin components on {ocp-short} += Manually installing components on {ocp-short} -Use manual installation when you want full control of the setup process and component versions. +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 . Deploy the PostgreSQL reference implementation for persistence support in SonataFlow. -. Create a namespace for the Orchestrator solution as shown in the following example: -+ -[subs="quotes+"] ----- -oc new-project ${orchestrator} ----- +. 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 to install the following: -. Run the setup script. -Follow the steps in the _Installing the Orchestrator plugin components using the {product-very-short} helper script_ section to download and execute the `setup.sh` script, which initializes the {product-very-short} environment. - -. Install the Orchestrator Operator in the {ocp-short} cluster by applying the following manifest: -+ -[source,yaml] ----- -apiVersion: operators.coreos.com/v1alpha1 -kind: Subscription -metadata: - name: orchestrator-operator - namespace: openshift-operators -spec: - channel: stable - installPlanApproval: Automatic - name: orchestrator-operator - source: redhat-operators - sourceNamespace: openshift-marketplace ----- - -. Verify installation by running the following command: -+ -[source,terminal,subs="+attributes,+quotes"] ----- -wget https://raw.githubusercontent.com/rhdhorchestrator/orchestrator-go-operator/release-${PRODUCT_VERSION}/hack/wait_for_operator_installed.sh -O /tmp/wait_for_operator_installed.sh \ && chmod u+x /tmp/wait_for_operator_installed.sh \ && /tmp/wait_for_operator_installed.sh # Specify the {product} version in the URL ----- - -During installation, the Orchestrator Operator creates the following sub-components: - -* {product-very-short} Operator * OpenShift Serverless Operator -* OpenShift Serverless Logic Operator - -It also creates the necessary custom resources (CRs) for Orchestrator to function properly. -. Apply the Orchestrator custom resource (CR) to the cluster to create an instance of {product-very-short} and resources for OpenShift Serverless and OpenShift Serverless Logic: -+ -[source,terminal,subs="+attributes,+quotes"] ----- -oc apply -n orchestrator -f https://raw.githubusercontent.com/rhdhorchestrator/orchestrator-go-operator/refs/heads/release-${PRODUCT_VERSION}/config/samples/_v1alpha3_orchestrator.yaml # Specify the {product} version in the URL ----- +* Knative Serving -[NOTE] -==== -After the first reconciliation of the Orchestrator CR, changes to some fields might not propagate to the intended resources. For example, updating the `platform.resources.requests` field in the Orchestrator CR has no effect on the running SonataFlowPlatform (SFP) resource. -==== +* Knative Eventing -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]. +* OpenShift Serverless Logic Operator \ No newline at end of file diff --git a/modules/orchestrator/proc-plugin-infra-install.adoc b/modules/orchestrator/proc-plugin-infra-install.adoc index c91c6459bb..5f9b1ae0ea 100644 --- a/modules/orchestrator/proc-plugin-infra-install.adoc +++ b/modules/orchestrator/proc-plugin-infra-install.adoc @@ -1,8 +1,8 @@ :mod-docs-content-type: PROCEDURE [id="proc-plugin-infra-install_{context}"] -= Installing dependencies with `plugin-infra.sh` += Installing dependencies using `plugin-infra.sh` -You can use the `{product-very-short}` helper script `plugin-infra.sh` to install the OpenShift Serverless infrastructure required by the Orchestrator plugin. +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] ==== diff --git a/modules/orchestrator/proc-setup-sh-init-script.adoc b/modules/orchestrator/proc-setup-sh-init-script.adoc index 47ac7b8277..672949d52b 100644 --- a/modules/orchestrator/proc-setup-sh-init-script.adoc +++ b/modules/orchestrator/proc-setup-sh-init-script.adoc @@ -1,22 +1,19 @@ :mod-docs-content-type: PROCEDURE [id="proc-setup-sh-init-script_{context}"] -= Installing the Orchestrator plugin components using the `setup.sh` script += Installing components using the `setup.sh` script -The `setup.sh` script simplifies the initialization of the {product-very-short} environment by: - -* Creating the required authentication secret. -* Labeling GitOps namespaces based on the cluster configuration. +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 both the `setup.sh` script and the Orchestrator CR, but you can override it as shown in the following example: +. 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 from the GitHub repository: +. Download the setup script: + [source,terminal,subs="+attributes,+quotes"] ---- @@ -30,40 +27,4 @@ wget https://raw.githubusercontent.com/rhdhorchestrator/orchestrator-go-operator /tmp/setup.sh --use-default ---- + -[NOTE] -==== -To specify custom values, omit the `--use-default` option. The script will then prompt you for input. -==== - -The contents of the secret vary depending on cluster configuration and can include the following keys: - -* `BACKEND_SECRET`: Randomly generated. This is mandatory for the {product-very-short} Operator to start. -* `K8S_CLUSTER_URL`: Dynamically obtained with `oc whoami --show-server`. -* `K8S_CLUSTER_TOKEN`: Dynamically obtained from the service account and namespace. -* `GITHUB_TOKEN`: Prompted from the user. -* `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET`: Used to authenticate against GitHub. -* `GITLAB_HOST` and `GITLAB_TOKEN`: Used to authenticate against GitLab. -* `ARGOCD_URL`: Obtained from the first ArgoCD instance available. -* `ARGOCD_USERNAME`: Defaults to `admin`. -* `ARGOCD_PASSWORD`: Obtained dynamically from the ArgoCD instance. - -Keys without values are omitted. For example, if no GitOps operator is installed, the ArgoCD-related keys are excluded. - -.Sample secret in a GitOps environment: -[source,yaml] ----- -apiVersion: v1 -data: - ARGOCD_PASSWORD: ... - ARGOCD_URL: ... - ARGOCD_USERNAME: ... - BACKEND_SECRET: ... - GITHUB_TOKEN: ... - K8S_CLUSTER_TOKEN: ... - K8S_CLUSTER_URL: ... -kind: Secret -metadata: - name: backstage-backend-auth-secret - namespace: rhdh -type: Opaque ----- \ No newline at end of file +To specify custom values, omit the `--use-default` option. The script will then prompt you for input. \ No newline at end of file From f958b33664d7ff50856410a3fdf001aaf5efaba6 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 2 Sep 2025 13:05:29 +0200 Subject: [PATCH 4/9] Apply Elai and Piotr suggestions --- assemblies/assembly-orchestrator-rhdh.adoc | 5 +++-- ...n-install-components-orchestrator-plugin.adoc | 6 ++---- ...m-install-components-orchestrator-plugin.adoc | 16 ++++++++-------- ...l-install-components-orchestrator-plugin.adoc | 12 ++---------- 4 files changed, 15 insertions(+), 24 deletions(-) diff --git a/assemblies/assembly-orchestrator-rhdh.adoc b/assemblies/assembly-orchestrator-rhdh.adoc index bb0fcbc480..2b8c0c191a 100644 --- a/assemblies/assembly-orchestrator-rhdh.adoc +++ b/assemblies/assembly-orchestrator-rhdh.adoc @@ -35,6 +35,9 @@ include::modules/orchestrator/con-understanding-orchestrator-plugin-dependencies // installing the components for the orchestrator plugin 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] @@ -45,5 +48,3 @@ include::modules/orchestrator/proc-setup-sh-init-script.adoc[leveloffset=+3] include::modules/orchestrator/proc-plugin-infra-install.adoc[leveloffset=+3] -// Orchestrator Infrastructure for {product} Helm chart -include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc[leveloffset=+2] diff --git a/modules/orchestrator/con-install-components-orchestrator-plugin.adoc b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc index 42542f0173..fdfc3af00f 100644 --- a/modules/orchestrator/con-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc @@ -12,8 +12,6 @@ To run the Orchestrator plugin successfully on {ocp-short}, you must first insta ** (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. -You can install the components for the Orchestrator plugin on {ocp-short} using one of the following methods: +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. -* Manual installation -* {product-very-short} helper script -* Orchestrator Infrastructure for {product} Helm chart \ No newline at end of file +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 index 0553b77215..ccc1d43b16 100644 --- a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc @@ -4,13 +4,13 @@ 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. -==== - .Procedure -. Add or update the Helm repository for Orchestrator Infrastructure for {product}. -. Install the chart with the required configuration for your environment. -. Approve the install plans for the Serverless Operators when prompted. \ No newline at end of file +. 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 istallplan` 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. +==== \ No newline at end of file diff --git a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc index 1d5c81ff20..6aa7458548 100644 --- a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -6,14 +6,6 @@ Use manual installation when you want full control of the setup process and comp .Procedure -. Deploy the PostgreSQL reference implementation for persistence support in SonataFlow. +. 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. -. 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 to install the following: - -* OpenShift Serverless Operator - -* Knative Serving - -* Knative Eventing - -* OpenShift Serverless Logic Operator \ No newline at end of file +. Deploy a PostgreSQL database and 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]. \ No newline at end of file From 2df56e67fdff4c759385712f9a8a80af4cc52fb0 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 2 Sep 2025 19:46:35 +0200 Subject: [PATCH 5/9] Apply Yona's comments --- .../proc-helm-install-components-orchestrator-plugin.adoc | 2 +- .../proc-manual-install-components-orchestrator-plugin.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc index ccc1d43b16..5a7622fac3 100644 --- a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc @@ -8,7 +8,7 @@ You can use Orchestrator Infrastructure for {product} to install components for . 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 istallplan` commands provided in the output to approve their installation. +. 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] ==== diff --git a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc index 6aa7458548..a0a26eb748 100644 --- a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -8,4 +8,4 @@ Use manual installation when you want full control of the setup process and comp . 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. -. Deploy a PostgreSQL database and 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]. \ No newline at end of file +. 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]. \ No newline at end of file From 51448c42a61b32c29c1127ee08edbd8041f4a889 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 3 Sep 2025 13:13:16 +0200 Subject: [PATCH 6/9] Apply Elai and Jona's suggestions --- assemblies/assembly-orchestrator-rhdh.adoc | 6 +--- .../con-helper-scripts-overview.adoc | 21 ------------- ....adoc => proc-helper-script-overview.adoc} | 4 +-- .../proc-setup-sh-init-script.adoc | 30 ------------------- 4 files changed, 3 insertions(+), 58 deletions(-) delete mode 100644 modules/orchestrator/con-helper-scripts-overview.adoc rename modules/orchestrator/{proc-plugin-infra-install.adoc => proc-helper-script-overview.adoc} (85%) delete mode 100644 modules/orchestrator/proc-setup-sh-init-script.adoc diff --git a/assemblies/assembly-orchestrator-rhdh.adoc b/assemblies/assembly-orchestrator-rhdh.adoc index 2b8c0c191a..94f6aeea98 100644 --- a/assemblies/assembly-orchestrator-rhdh.adoc +++ b/assemblies/assembly-orchestrator-rhdh.adoc @@ -42,9 +42,5 @@ include::modules/orchestrator/proc-helm-install-components-orchestrator-plugin.a 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] +include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2] diff --git a/modules/orchestrator/con-helper-scripts-overview.adoc b/modules/orchestrator/con-helper-scripts-overview.adoc deleted file mode 100644 index 6a66dbfd65..0000000000 --- a/modules/orchestrator/con-helper-scripts-overview.adoc +++ /dev/null @@ -1,21 +0,0 @@ -: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]. \ No newline at end of file diff --git a/modules/orchestrator/proc-plugin-infra-install.adoc b/modules/orchestrator/proc-helper-script-overview.adoc similarity index 85% rename from modules/orchestrator/proc-plugin-infra-install.adoc rename to modules/orchestrator/proc-helper-script-overview.adoc index 5f9b1ae0ea..9b675b5ea5 100644 --- a/modules/orchestrator/proc-plugin-infra-install.adoc +++ b/modules/orchestrator/proc-helper-script-overview.adoc @@ -1,6 +1,6 @@ :mod-docs-content-type: PROCEDURE -[id="proc-plugin-infra-install_{context}"] -= Installing dependencies using `plugin-infra.sh` +[id="proc-helper-script-overview.adoc_{context}"] += Installing dependencies 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 required by the Orchestrator plugin. diff --git a/modules/orchestrator/proc-setup-sh-init-script.adoc b/modules/orchestrator/proc-setup-sh-init-script.adoc deleted file mode 100644 index 672949d52b..0000000000 --- a/modules/orchestrator/proc-setup-sh-init-script.adoc +++ /dev/null @@ -1,30 +0,0 @@ -: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. \ No newline at end of file From 82a26378644b0bf7a8b13a1cb5e1b83344f7eca0 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 3 Sep 2025 14:27:08 +0200 Subject: [PATCH 7/9] Apply Jennifer's suggestion --- modules/orchestrator/proc-helper-script-overview.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/orchestrator/proc-helper-script-overview.adoc b/modules/orchestrator/proc-helper-script-overview.adoc index 9b675b5ea5..27991f4892 100644 --- a/modules/orchestrator/proc-helper-script-overview.adoc +++ b/modules/orchestrator/proc-helper-script-overview.adoc @@ -2,7 +2,7 @@ [id="proc-helper-script-overview.adoc_{context}"] = Installing dependencies 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 required by the Orchestrator plugin. +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] ==== From e5fee653c190d37d8e66f7ef1fdb3148fdb3cf58 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 3 Sep 2025 14:29:19 +0200 Subject: [PATCH 8/9] Apply Jennifer's suggestion --- modules/orchestrator/proc-helper-script-overview.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/orchestrator/proc-helper-script-overview.adoc b/modules/orchestrator/proc-helper-script-overview.adoc index 27991f4892..3c0c4b0901 100644 --- a/modules/orchestrator/proc-helper-script-overview.adoc +++ b/modules/orchestrator/proc-helper-script-overview.adoc @@ -1,6 +1,6 @@ :mod-docs-content-type: PROCEDURE [id="proc-helper-script-overview.adoc_{context}"] -= Installing dependencies using the `{product-very-short}` helper script += 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. From acd1f67266761f51fa42574198cfd553d21dde3f Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 3 Sep 2025 16:20:23 +0200 Subject: [PATCH 9/9] Incorporate Peer reviewers comments --- .../con-install-components-orchestrator-plugin.adoc | 10 +++++----- ...oc-helm-install-components-orchestrator-plugin.adoc | 4 ++-- ...-manual-install-components-orchestrator-plugin.adoc | 6 ++++-- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/modules/orchestrator/con-install-components-orchestrator-plugin.adoc b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc index fdfc3af00f..70c2ece6aa 100644 --- a/modules/orchestrator/con-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/con-install-components-orchestrator-plugin.adoc @@ -1,17 +1,17 @@ :_mod-docs-content-type: CONCEPT [id="con-install-components-orchestrator-plugin_{context}"] -= Installing components for the Orchestrator plugin on {ocp-short} += Orchestrator plugin components 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: +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) 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. +** (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 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. +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 index 5a7622fac3..2f1352bc03 100644 --- a/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc @@ -6,11 +6,11 @@ You can use Orchestrator Infrastructure for {product} to install components for .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. +. 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 approve the install plans. +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-manual-install-components-orchestrator-plugin.adoc b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc index a0a26eb748..3fea61fa71 100644 --- a/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc +++ b/modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc @@ -1,6 +1,6 @@ :mod-docs-content-type: PROCEDURE [id="proc-manual-install-orchestrator-plugin_{context}"] -= Manually installing components on {ocp-short} += 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. @@ -8,4 +8,6 @@ Use manual installation when you want full control of the setup process and comp . 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]. \ No newline at end of file +. 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