Skip to content

RHDHBUGS-2009: Orchestrator docs update #1523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 10, 2025
Merged

RHDHBUGS-2009: Orchestrator docs update #1523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f90a07b
RHDHBUGS-2009
deerskindoll Nov 6, 2025
e3b9d2a
Merge branch 'main' into RHDHBUGS-2009
deerskindoll Nov 7, 2025
996659e
update
deerskindoll Nov 7, 2025
a456cbc
update
deerskindoll Nov 7, 2025
6798694
Update modules/orchestrator/proc-helm-install-components-orchestrator…
themr0c Nov 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions assemblies/assembly-orchestrator-rhdh.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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]
include::modules/orchestrator/ref-best-practices-for-creating-workflows.adoc[leveloffset=+1]
11 changes: 4 additions & 7 deletions modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -86,4 +83,4 @@ plugins:
disabled: false
- package: "./dynamic-plugins/dist/backstage-plugin-signals-backend-dynamic"
disabled: false
----
----
10 changes: 10 additions & 0 deletions modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <release_name> 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.

Expand Down
10 changes: 7 additions & 3 deletions modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
====
Loading