Skip to content

Commit 3fcd253

Browse files
author
GitHub Actions
committed
Update the orchestrator modules
1 parent 85e8425 commit 3fcd253

6 files changed

+25
-113
lines changed

‎modules/orchestrator/con-helper-scripts-overview.adoc‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,20 @@
22
[id="con-helper-scripts-overview_{context}"]
33
= Helper scripts overview for the Orchestrator on {ocp-short}
44

5-
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:
5+
The following scripts streamline non-production setup:
6+
7+
* `setup.sh`: Initializes the {product-very-short} environment by creating the required authentication secret and labeling GitOps namespaces based on cluster configuration.
68
7-
* `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.
89
* `plugin-infra.sh`: Installs the OpenShift Serverless infrastructure required by the Orchestrator plugin.
910
1011
[NOTE]
1112
====
1213
These scripts are intended for quick-start scenarios and are **not recommended for production**.
1314
====
1415

16+
[IMPORTANT]
17+
====
18+
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.
19+
====
20+
1521
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].

‎modules/orchestrator/con-install-components-orchestrator-plugin.adoc‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,17 @@
22
[id="con-install-components-orchestrator-plugin_{context}"]
33
= Installing components for the Orchestrator plugin on {ocp-short}
44

5-
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.
6-
7-
.Required components
8-
9-
* The Orchestrator plugin depends on the following components:
5+
To run the Orchestrator plugin successfully on {ocp-short}, you must first install the required dependencies. The Orchestrator plugin depends on the following components:
106

7+
** {product} ({product-very-short}) {product-custom-resource-type}
118
** OpenShift Serverless Logic Operator
129
** OpenShift Serverless Operator
1310
*** Knative Serving
1411
*** Knative Eventing
15-
** {product} ({product-very-short}) {product-custom-resource-type}
1612
** (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.
1713
** (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.
18-
+
19-
[NOTE]
20-
====
21-
You must preinstall the components, or install them by using one of the supported methods.
22-
====
2314

24-
You can install the components (Operators) that provide the dependencies required by the Orchestrator plugin on {ocp-short} using the following methods:
15+
You can install the components for the Orchestrator plugin on {ocp-short} using one of the following methods:
2516

2617
* Manual installation
2718
* {product-very-short} helper script

‎modules/orchestrator/proc-helm-install-components-orchestrator-plugin.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:mod-docs-content-type: PROCEDURE
22
[id="proc-helm-install-components-orchestrator-plugin_{context}"]
3-
= Installing the Orchestrator plugin components using the Orchestrator Infrastructure for {product} Helm chart
3+
= Installing components using the Orchestrator Infrastructure for {product} Helm chart
44

55
You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins.
66

‎modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc‎

Lines changed: 6 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,19 @@
11
:mod-docs-content-type: PROCEDURE
22
[id="proc-manual-install-orchestrator-plugin_{context}"]
3-
= Manually installing the Orchestrator plugin components on {ocp-short}
3+
= Manually installing components on {ocp-short}
44

5-
Use manual installation when you want full control of the setup process and component versions.
5+
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.
66

77
.Procedure
88

99
. Deploy the PostgreSQL reference implementation for persistence support in SonataFlow.
1010

11-
. Create a namespace for the Orchestrator solution as shown in the following example:
12-
+
13-
[subs="quotes+"]
14-
----
15-
oc new-project ${orchestrator}
16-
----
11+
. 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:
1712

18-
. Run the setup script.
19-
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.
20-
21-
. Install the Orchestrator Operator in the {ocp-short} cluster by applying the following manifest:
22-
+
23-
[source,yaml]
24-
----
25-
apiVersion: operators.coreos.com/v1alpha1
26-
kind: Subscription
27-
metadata:
28-
name: orchestrator-operator
29-
namespace: openshift-operators
30-
spec:
31-
channel: stable
32-
installPlanApproval: Automatic
33-
name: orchestrator-operator
34-
source: redhat-operators
35-
sourceNamespace: openshift-marketplace
36-
----
37-
38-
. Verify installation by running the following command:
39-
+
40-
[source,terminal,subs="+attributes,+quotes"]
41-
----
42-
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
43-
----
44-
45-
During installation, the Orchestrator Operator creates the following sub-components:
46-
47-
* {product-very-short} Operator
4813
* OpenShift Serverless Operator
49-
* OpenShift Serverless Logic Operator
50-
51-
It also creates the necessary custom resources (CRs) for Orchestrator to function properly.
5214
53-
. 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:
54-
+
55-
[source,terminal,subs="+attributes,+quotes"]
56-
----
57-
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
58-
----
15+
* Knative Serving
5916
60-
[NOTE]
61-
====
62-
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.
63-
====
17+
* Knative Eventing
6418
65-
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].
19+
* OpenShift Serverless Logic Operator

‎modules/orchestrator/proc-plugin-infra-install.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
:mod-docs-content-type: PROCEDURE
22
[id="proc-plugin-infra-install_{context}"]
3-
= Installing dependencies with `plugin-infra.sh`
3+
= Installing dependencies using `plugin-infra.sh`
44

5-
You can use the `{product-very-short}` helper script `plugin-infra.sh` to install the OpenShift Serverless infrastructure required by the Orchestrator plugin.
5+
You can use the `{product-very-short}` helper script `plugin-infra.sh` to quickly install the OpenShift Serverless infrastructure required by the Orchestrator plugin.
66

77
[WARNING]
88
====

‎modules/orchestrator/proc-setup-sh-init-script.adoc‎

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
:mod-docs-content-type: PROCEDURE
22
[id="proc-setup-sh-init-script_{context}"]
3-
= Installing the Orchestrator plugin components using the `setup.sh` script
3+
= Installing components using the `setup.sh` script
44

5-
The `setup.sh` script simplifies the initialization of the {product-very-short} environment by:
6-
7-
* Creating the required authentication secret.
8-
* Labeling GitOps namespaces based on the cluster configuration.
5+
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.
96

107
.Procedure
118

12-
. 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:
9+
. 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:
1310
+
1411
[subs="quotes+"]
1512
----
1613
oc new-project ${product-very-short}
1714
----
1815

19-
. Download the setup script from the GitHub repository:
16+
. Download the setup script:
2017
+
2118
[source,terminal,subs="+attributes,+quotes"]
2219
----
@@ -30,40 +27,4 @@ wget https://raw.githubusercontent.com/rhdhorchestrator/orchestrator-go-operator
3027
/tmp/setup.sh --use-default
3128
----
3229
+
33-
[NOTE]
34-
====
35-
To specify custom values, omit the `--use-default` option. The script will then prompt you for input.
36-
====
37-
38-
The contents of the secret vary depending on cluster configuration and can include the following keys:
39-
40-
* `BACKEND_SECRET`: Randomly generated. This is mandatory for the {product-very-short} Operator to start.
41-
* `K8S_CLUSTER_URL`: Dynamically obtained with `oc whoami --show-server`.
42-
* `K8S_CLUSTER_TOKEN`: Dynamically obtained from the service account and namespace.
43-
* `GITHUB_TOKEN`: Prompted from the user.
44-
* `GITHUB_CLIENT_ID` and `GITHUB_CLIENT_SECRET`: Used to authenticate against GitHub.
45-
* `GITLAB_HOST` and `GITLAB_TOKEN`: Used to authenticate against GitLab.
46-
* `ARGOCD_URL`: Obtained from the first ArgoCD instance available.
47-
* `ARGOCD_USERNAME`: Defaults to `admin`.
48-
* `ARGOCD_PASSWORD`: Obtained dynamically from the ArgoCD instance.
49-
50-
Keys without values are omitted. For example, if no GitOps operator is installed, the ArgoCD-related keys are excluded.
51-
52-
.Sample secret in a GitOps environment:
53-
[source,yaml]
54-
----
55-
apiVersion: v1
56-
data:
57-
ARGOCD_PASSWORD: ...
58-
ARGOCD_URL: ...
59-
ARGOCD_USERNAME: ...
60-
BACKEND_SECRET: ...
61-
GITHUB_TOKEN: ...
62-
K8S_CLUSTER_TOKEN: ...
63-
K8S_CLUSTER_URL: ...
64-
kind: Secret
65-
metadata:
66-
name: backstage-backend-auth-secret
67-
namespace: rhdh
68-
type: Opaque
69-
----
30+
To specify custom values, omit the `--use-default` option. The script will then prompt you for input.

0 commit comments

Comments
 (0)