Merge branch 'main' into RHIDP-8548

Author: themr0c

.gitignore

@@ -2,6 +2,7 @@
 titles/*/build
 index.html
 titles-generated/
+.vale-styles/AsciiDocDITA
 .vale-styles/RedHat
 .vscode
 .cache/

.vale.ini

@@ -10,9 +10,14 @@ StylesPath = ".vale-styles"
 MinAlertLevel = suggestion
 
 # Styles to download:
-Packages = RedHat
+Packages = RedHat,https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
 
 # Display alerts on AsciiDoc files:
 [*.adoc]
 # Apply these styles:
-BasedOnStyles = RedHat,DeveloperHub
+BasedOnStyles = RedHat,DeveloperHub,AsciiDocDITA
+
+# Disable certain rules:
+AsciiDocDITA.AttributeReference = NO
+AsciiDocDITA.ShortDescription = NO
+AsciiDocDITA.CrossReference = NO

artifacts/snip-conscious-language.adoc

@@ -33,4 +33,14 @@ 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]
+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]
+
+// {product-very-short} helper script
+include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+2]
+

assemblies/assembly-orchestrator-rhdh.adoc

@@ -0,0 +1,17 @@
+:_mod-docs-content-type: CONCEPT
+[id="con-install-components-orchestrator-plugin_{context}"]
+= Orchestrator plugin components on {ocp-short}
+
+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) 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 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.

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

@@ -0,0 +1,16 @@
+:mod-docs-content-type: PROCEDURE
+[id="proc-helm-install-components-orchestrator-plugin_{context}"]
+= Installing components using the Orchestrator Infrastructure for {product} Helm chart
+
+You can use Orchestrator Infrastructure for {product} to install components for the Orchestrator plugins.
+
+.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.
+
+. 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 manually approve the install plans.
+====

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

@@ -0,0 +1,26 @@
+:mod-docs-content-type: PROCEDURE
+[id="proc-helper-script-overview.adoc_{context}"]
+= 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.
+
+[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
+----

modules/orchestrator/proc-helper-script-overview.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 *Pods* or releases.
 
 .Verification
 

modules/orchestrator/proc-install-components-for-orchestrator-plugin.adoc

@@ -0,0 +1,13 @@
+:mod-docs-content-type: PROCEDURE
+[id="proc-manual-install-orchestrator-plugin_{context}"]
+= 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.
+
+.Procedure
+
+. 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.
+
+. 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.