generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 56
RHIDP-9237: Restructuring the existing Orchestrator Documentation #1604
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.
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
Open
jmagak
wants to merge
9
commits into
redhat-developer:main
Choose a base branch
from
jmagak:RHIDP-9237-Restructuring-the-existing-Orchestrator-Documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
e068258
Restructure the Orchestrator
invalid-email-address fab3f05
Restructure the Orchestrator
invalid-email-address 2d6dd1d
Restructure the Orchestrator
invalid-email-address a7bde0c
Restructure the Orchestrator
invalid-email-address 730456c
Restucture Orchestrator documentation
invalid-email-address fb815fc
Restructure the Orchestrator
invalid-email-address fabfbdf
Restructure the Orchestrator
invalid-email-address eb1b040
Apply suggestions
invalid-email-address 511aeef
Apply suggestions
invalid-email-address File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| :_mod-docs-content-type: ASSEMBLY | ||
|
|
||
| ifndef::context[] | ||
| [id="install-rhdh-orchestrator-helm.adoc"] | ||
| endif::[] | ||
| ifdef::context[] | ||
| [id="assembly-install-rhdh-orchestrator-helm"] | ||
| endif::[] | ||
| :context: install-rhdh-orchestrator | ||
| = Installing {product} with Orchestrator by using the {product} Helm chart | ||
|
|
||
| You can install {product} with Orchestrator by using the {product} Helm chart. | ||
|
|
||
| include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-cli.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/orchestrator/proc-install-rhdh-with-orchestrator-helm-webui.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1] |
16 changes: 16 additions & 0 deletions
16
assemblies/assembly-install-rhdh-orchestrator-operator.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| :_mod-docs-content-type: ASSEMBLY | ||
|
|
||
| ifndef::context[] | ||
| [id="install-rhdh-orchestrator-operator"] | ||
| endif::[] | ||
| ifdef::context[] | ||
| [id="assembly-install-rhdh-orchestrator-operator"] | ||
| endif::[] | ||
| :context: install-rhdh-orchestrator | ||
| = Installing {product} with Orchestrator by using the {product} Operator | ||
|
|
||
| You can install {product} with Orchestrator by using the {product} Operator. | ||
|
|
||
| include::modules/orchestrator/proc-enable-orchestrator-plugin.adoc[leveloffset=+1] | ||
|
|
||
| include::modules/orchestrator/proc-upgrading-the-orchestrator-plugin.adoc[leveloffset=+1] |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| :_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. | ||
|
Check failure on line 43 in assemblies/assembly-orchestrator-plugins-components.adoc
|
||
|
|
||
| `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 | ||
| 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] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
modules/orchestrator/con-environment-variables-supported-by-the-build-script.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| :_mod-docs-content-type: CONCEPT | ||
|
|
||
| [id="con-getting-started_{context}"] | ||
| = Getting started with Orchestrator | ||
|
|
||
| To start using Orchestrator in {product-very-short}, you must: | ||
jmagak marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| * 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 | ||
2 changes: 1 addition & 1 deletion
2
modules/orchestrator/con-orchestrator-plugin-dependencies-operator.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
modules/orchestrator/ref-best-practices-for-creating-workflows.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
modules/orchestrator/ref-compatibility-guide-for-orchestrator.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.