RHIDP-9237: Restructuring the existing Orchestrator Documentation

assemblies/assembly-install-rhdh-orchestrator-helm.adoc

@@ -15,4 +15,7 @@ include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[
 
 include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc[leveloffset=+1]
 
-include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1]
+include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1]
+
+// manual installation
+include::modules/orchestrator/proc-manual-install-components-orchestrator-plugin.adoc[leveloffset=+1]

assemblies/assembly-orchestrator-plugins-components.adoc

@@ -1,58 +1,8 @@
 :_mod-docs-content-type: ASSEMBLY
 
 [id="assembly-orchestrator-plugins-components_{context}"]
-=  Orchestrator plugins components
 
-To use the Orchestrator, enable the Orchestrator plugins for {product}, that are disabled by default:
-
-Orchestrator front end plugins::
-
-`backstage-plugin-orchestrator`:::
-Provides the interface for users to run and monitor workflows within {product-very-short}. You can run and track the execution status of processes.
-
-`backstage-plugin-orchestrator-form-widgets`:::
-Provides custom widgets for the workflow execution form, allowing you to customize input fields and streamline the process of launching workflows.
-
-`backstage-plugin-orchestrator-form`:::
-Provides the workflow execution form where you can define and submit the necessary input data required to start a new workflow instance.
-
-`backstage-plugin-orchestrator-form-api`:::
-Defines the API for extending the workflow execution form.
-
-Orchestrator backend plugins::
-
-`backstage-plugin-orchestrator-backend`:::
-Gets workflow data into {product-short} making sure {product-very-short} processes critical workflow metadata and runtime status fulfilling your need for visibility.
-
-`backstage-plugin-orchestrator-common`:::
-Contains the backend OpenAPI specification along with autogenerated API documentation and client libraries.
-
-`scaffolder-backend-module-orchestrator`:::
-Provides callable actions from scaffolder templates, such as `orchestrator:workflow:run` or `orchestrator:workflow:get_params`.
-
-Notification plugins::
-
-`backstage-plugin-notifications`:::
-Provides notification front end components that allow you to display immediate, visible alerts about key workflow state changes, allowing real-time status tracking.
-
-
-`backstage-plugin-signals`:::
-Provides notification front end components user experience enhancements so you can process the real-time lifecycle events.
-
-`backstage-plugin-notifications-backend-dynamic`:::
-Provides notification backend components allowing you to manage and store the stream of workflow events, making sure that critical notifications are ready to be served to the front-end user interface.
-
-`backstage-plugin-signals-backend-dynamic`:::
-Provides the backend components for notification user experience enhancements allowing you to establish the necessary communication channels for the event-driven orchestration that is core to Serverless Workflows.
+= Enabling Orchestrator plugins components
 
 // enabling orchestrator plugins components
-include::modules/orchestrator/proc-enabling-orchestrator-plugins-components.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]
+include::modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc[leveloffset=+1]

assemblies/assembly-orchestrator-plugins-technical-appendixes.adoc

@@ -0,0 +1,10 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="assembly-orchestrator-plugins-technical-appendixes_{context}"]
+
+= Technical appendix
+
+The following appendix provides technical information, and details on non-production tools, such as the {product-very-short} helper script, which might be helpful for understanding setup options or quick testing.
+
+// {product-very-short} helper script
+include::modules/orchestrator/proc-helper-script-overview.adoc[leveloffset=+1]

modules/orchestrator/con-getting-started.adoc

@@ -7,4 +7,11 @@ 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
+* Configure your {product-custom-resource-type} custom resource (CR) or Helm values file for Orchestrator
+
+[NOTE]
+====
+When using the {product-very-short} Operator, the required infrastructure components are provisioned automatically once the Orchestrator plugins are enabled in the {product-custom-resource-type} CR.
+
+When using the {product-very-short} Helm chart, the required infrastructure components are installed automatically using the dedicated `orchestrator-infra` Helm chart prior to enabling the Orchestrator plugins in the main {product-very-short} chart.
+====

modules/orchestrator/proc-enabling-orchestrator-plugins-components.adoc

@@ -3,6 +3,28 @@
 [id="proc-enabling-orchestrator-plugins-components_{context}"]
 = Enabling Orchestrator plugins components
 
+To use the Orchestrator, enable the following Orchestrator plugins for {product}, that are disabled by default:
+
+Orchestrator-frontend plugin::
+
+`backstage-plugin-orchestrator`:::
+Provides the interface for users to run and monitor workflows within {product-very-short}. You can run and track the execution status of processes.
+
+Orchestrator-backend plugin::
+
+`backstage-plugin-orchestrator-backend`:::
+Gets workflow data into {product-short} making sure {product-very-short} processes critical workflow metadata and runtime status fulfilling your need for visibility.
+
+Orchestrator-form-widget::
+
+`backstage-plugin-orchestrator-form-widgets`:::
+Provides custom widgets for the workflow execution form, allowing you to customize input fields and streamline the process of launching workflows.
+
+Orchestrator-scaffolder-backend-module::
+
+`scaffolder-backend-module-orchestrator`:::
+Provides callable actions from Scaffolder templates, such as `orchestrator:workflow:run` or `orchestrator:workflow:get_params`.
+
 .Prerequisites
 
 * You have installed the following operators:
@@ -27,12 +49,6 @@ plugins:
     disabled: false
   - package: "@redhat/backstage-plugin-orchestrator-form-widgets@{product-chart-version}"
     disabled: false
-  - package: "@redhat/backstage-plugin-orchestrator-common@{product-chart-version}"
-    disabled: false
-  - package: "@redhat/backstage-plugin-orchestrator-form@{product-chart-version}"
-    disabled: false
-  - package: "@redhat/backstage-plugin-orchestrator-form-api@{product-chart-version}"
-    disabled: false
   - package: "./dynamic-plugins/dist/backstage-plugin-notifications"
     disabled: false
   - package: "./dynamic-plugins/dist/backstage-plugin-signals"

modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc

@@ -14,6 +14,25 @@ This is a one-off requirement and must be completed before enabling the Orchestr
 
 .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.
+
+[IMPORTANT]
+====
+By default, Orchestrator Infrastructure for {product} Helm chart does *not* auto-approve the required Serverless Operators. You must manually approve the install plans.
+====
+
 . As an administrator, install relevant cluster-wide resources.
 +
 [source,yaml,subs="+quotes,+attributes"]

modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc

@@ -10,7 +10,8 @@ The following table lists the {product-very-short} Orchestrator plugin versions
 | Orchestrator plugin version | {product} ({product-very-short}) version | OpenShift version | OpenShift Serverless Logic (OSL) version | OpenShift Serverless version
 | Orchestrator `1.5` | `1.5` | `4.14` - `4.18` | OSL `1.35` | `1.35`
 | Orchestrator `1.6` | `1.6` | `4.14` - `4.18` | OSL `1.36` | `1.36`
-| Orchestrator `1.7` ({product-very-short} {product-version}) | {product-version} | `4.16` - `4.19` | OSL `1.36` | `1.36`
+| Orchestrator `1.7.1` | `1.7` | `4.16` - `4.19` | OSL `1.36` | `1.36`
+| Orchestrator `1.8.2` | {product-version} | `4.16` - `4.19` | OSL `1.36` | `1.36`
 |===
 
 [NOTE]

titles/orchestrator/master.adoc

@@ -18,4 +18,6 @@ include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-e
 
 include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc[leveloffset=+1]
 
-include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1]
+include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1]
+
+include::assemblies/assembly-orchestrator-plugins-technical-appendixes.adoc[leveloffset=+1]