Skip to content
Merged
2 changes: 1 addition & 1 deletion assemblies/assembly-install-rhdh-orchestrator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To install {product}, use one of the following methods:
* The {product} Helm chart

// {product} Operator
include::modules/orchestrator/proc-install-orchestrator-plugin.adoc[leveloffset=+1]
include::modules/orchestrator/proc-enable-orchestrator-plugin.adoc[leveloffset=+1]

// {product} Helm chart
include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1]
Expand Down
6 changes: 3 additions & 3 deletions assemblies/assembly-orchestrator-rhdh.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ You can streamline and automate your work by using the Orchestrator in {product}

[NOTE]
====
Orchestrator currently supports only {ocp-short}; it is not available on AKS, EKS, or GKE.
Orchestrator currently supports only {ocp-brand-name} ({ocp-short}); it is not available on {aks-brand-name} ({aks-short}), {eks-brand-name} ({eks-short}), or {gke-brand-name} ({gke-short}).
====

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) for Orchestrator
* 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-supported-architecture-for-orchestrator.adoc[leveloffset=+1]

// provisioning plugin dependencies
include::modules/orchestrator/con-orchestrator-plugin-dependencies.adoc[leveloffset=+1]
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]
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
:_mod-docs-content-type: CONCEPT
[id="con-orchestrator-plugin-dependencies_{context}"]
= Orchestrator Plugin dependencies
[id="con-understanding-orchestrator-plugin-dependencies-operator_{context}"]
= Understanding Orchestrator plugin dependencies for Operator installation

The Orchestrator plugin in {product-very-short} requires components such as SonataFlow and supporting network policies to run. When you enable the plugin in your {product-custom-resource-type} custom resource (CR), the Operator automatically provisions these dependencies for you:

* A `SonataflowPlatform` CR
* `NetworkPolicies` that allow traffic between infrastructure resources (Knative, Serverless Logic Operator), monitoring traffic, and intra-namespace traffic

[NOTE]
====
Orchestrator currently supports only {ocp-short}; it is not available on AKS, EKS, or GKE.
====

The `orchestrator-backend` plugin uses the `sonataflow-platform-data-index-service`, which the `SonataFlowPlatform` CR creates to communicate with the SonataFlow platform.

The Operator resolves the dependency reference SonataFlow against the `sonataflow.yaml` manifest included in its profile configuration (`config/profile/rhdh/plugin-deps/sonataflow.yaml`) and applies it to create the required resources.
Expand All @@ -21,7 +16,7 @@ The Operator automatically applies the `sonataflow.yaml` manifest, creating the
[IMPORTANT]
====
The `SonataFlowPlatform` CR contains Data Index service that requires PostgreSQL database as shown in the following example:
+

[source,yaml,subs="+quotes,+attributes"]
----
persistence:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE
[id="proc-install-orchestrator-plugin_{context}"]
= Installing the Orchestrator plugin using Operator
[id="proc-enable-orchestrator-plugin_{context}"]
= Enabling the Orchestrator plugin using Operator

You can enable the Orchestrator plugin in {product-very-short} by configuring dynamic plugins in your {product-custom-resource-type} custom resource (CR).

Expand All @@ -9,31 +9,13 @@ You can enable the Orchestrator plugin in {product-very-short} by configuring dy
* You have access to edit or create ConfigMaps in the namespace where the {product-custom-resource-type} CR is deployed.

.Procedure
. Identify the Orchestrator plugin dynamic plugins that are included by default in the default `dynamic-plugins.yaml` file of the `install-dynamic-plugins` container:
+
* `@redhat/backstage-plugin-orchestrator` (frontend)
* `@redhat/backstage-plugin-orchestrator-backend-dynamic` (backend)
* `@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic`
* `@redhat/backstage-plugin-orchestrator-form-widgets`

. To enable the Orchestrator plugin, update the ConfigMap file with the following data:
+
[source,yaml,subs="+attributes,+quotes"]
. To enable the Orchestrator plugin with default settings, set `disabled: false` for the package. For example, `package: "@redhat/backstage-plugin-orchestrator@<plugin_version>` is set to `disabled: false`:
+
[source,yaml]
----
includes:
- dynamic-plugins.default.yaml
plugins:
- package: "@redhat/backstage-plugin-orchestrator@1.6.0"
disabled: false
- package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@1.6.0"
disabled: false
dependencies:
- ref: sonataflow
- package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@1.6.0"
disabled: false
- package: "@redhat/backstage-plugin-orchestrator-form-widgets@${ORCHESTRATOR_PLUGIN_VERSION}"
disabled: false
- package: "@redhat/backstage-plugin-orchestrator@<plugin_version>"
disabled: false
----

.Example: Complete configuration of the Orchestrator plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To run the Orchestrator plugin successfully on {ocp-short}, you must install com
+
[NOTE]
====
The {product} Operator provisions these components automatically. Alternatively, you can install them manually by using another Operator.
You must preinstall the components, or install them by using one of the supported methods.
====

.Procedure
Expand All @@ -24,7 +24,7 @@ To install components (Operators) that provide the dependencies required by the

* Manual installation
* {product-very-short} helper script
* {product-very-short} Orchestrator Infra Helm Chart
* Orchestrator Infrastructure for {product}
+
These components enable the creation of the `SonataFlowPlatform` custom resource and several supporting `NetworkPolicy` resources.

Expand All @@ -45,16 +45,11 @@ For more information on preparing the required infrastructure, see link:https://
* 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. You can use the script in empty clusters, however, use with caution in production clusters because the script installs Operators with automatic upgrades and default settings, which can introduce unplanned changes, version conflicts, or policy misalignments.
You can install the OpenShift Serverless infrastructure for the Orchestrator plugin in empty clusters by using the {product-very-short} helper script.
You can install the OpenShift Serverless infrastructure for the Orchestrator plugin using the {product-very-short} helper script. You can use the script in empty clusters.

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]
====
This method of installation is not suitable for production clusters. The {product-very-short} helper script installs Operators with automatic upgrades and default settings, which can introduce unplanned changes, version conflicts, or policy misalignments.
====
WARNING: Use the {product-very-short} helper script for a quick-start on an empty cluster. Do not use it in production.

.Procedure
. Download the `plugin-infra.sh` script as shown in the following example:
Expand All @@ -70,5 +65,10 @@ curl -sSLO https://raw.githubusercontent.com/redhat-developer/rhdh-operator/refs
$ ./plugin-infra.sh
----

.{product-very-short} Orchestrator Infra Helm Chart
You can use {product-very-short} Orchestrator Infra Helm Chart to install components for the Orchestrator plugins in empty clusters.
.Orchestrator Infrastructure for {product}
You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins in empty clusters.

[IMPORTANT]
====
Orchestrator Infrastructure for {product} is suitable for production use. By default, it does *not* auto-install or auto-upgrade the required Serverless Operators: you or a cluster administrator must approve the install plans.
====