RHIDP-6573: Document resource requirements (Helm-based) for orchestrator in RHDH #1282
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| :_mod-docs-content-type: ASSEMBLY | ||
|
|
||
| ifndef::context[] | ||
| [id="install-rhdh-orchestrator-helm"] | ||
| endif::[] | ||
| ifdef::context[] | ||
| [id="install-rhdh-orchestrator-helm_{context}"] | ||
| endif::[] | ||
| = Installing {product} with Orchestrator using Helm | ||
|
|
||
| :context: install-rhdh-orchestrator-helm | ||
|
|
||
| You can install {product} with Orchestrator by using Helm, review resource requirements for Orchestrator, and plan for resource considerations in air-gapped environments. | ||
|
|
||
| include::modules/installation/con-resource-requirements-orchestrator.adoc[leveloffset=+1] |
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,37 @@ | ||||||
| // Module included in the following assemblies | ||||||
| // assembly-install-rhdh-orchestrator-helm.adoc | ||||||
|
|
||||||
| :_mod-docs-content-type: PROCEDURE | ||||||
| [id="con-resource-requirements-orchestrator_{context}"] | ||||||
| == Resource requirements for Orchestrator | ||||||
|
|
||||||
| The Orchestrator flavor of {product} comes with the following default resource requests and limits as defined in the Helm chart: | ||||||
|
|
||||||
| [cols="2,2", options="header"] | ||||||
| |=== | ||||||
| | Resource | ||||||
| | Default value | ||||||
|
|
||||||
| | CPU requests | ||||||
| | 250m | ||||||
|
|
||||||
| | Memory requests | ||||||
| | 64Mi | ||||||
|
|
||||||
| | CPU limits | ||||||
| | 500m | ||||||
|
|
||||||
| | Memory limits | ||||||
| | 1Gi | ||||||
| |=== | ||||||
|
|
||||||
| You can customize these values by updating your `values.yaml` file or by passing `--set` flags during installation as shown in the following example : | ||||||
|
|
||||||
| [source,bash] | ||||||
| ---- | ||||||
| helm install <release_name> redhat-developer/backstage \ | ||||||
|
There was a problem hiding this comment.
Suggested change
And similar to my comment here, we should use the official OpenShift Helm Charts repo. |
||||||
| --set orchestrator.sonataflowPlatform.resources.requests.cpu=500m \ | ||||||
| --set orchestrator.sonataflowPlatform.resources.requests.memory=128Mi \ | ||||||
| --set orchestrator.sonataflowPlatform.resources.limits.cpu=1 \ | ||||||
| --set orchestrator.sonataflowPlatform.resources.limits.memory=2Gi | ||||||
| ---- | ||||||
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 @@ | ||
| ../../artifacts |
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 @@ | ||
| ../../assemblies |
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,13 @@ | ||
| <title>{title}</title> | ||
| <productname>{product}</productname> | ||
| <productnumber>{product-version}</productnumber> | ||
| <subtitle>{subtitle} | ||
| </subtitle> | ||
| <abstract> | ||
| <para>{abstract}</para> | ||
| </abstract> | ||
| <authorgroup> | ||
| <orgname>{company-name} Customer Content Services</orgname> | ||
| </authorgroup> | ||
| <xi:include href="Common_Content/Legal_Notice.xml" | ||
| xmlns:xi="http://www.w3.org/2001/XInclude" /> |
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 @@ | ||
| ../../images |
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,11 @@ | ||
| include::artifacts/attributes.adoc[] | ||
| :context: orchestrator-helm | ||
| :imagesdir: images | ||
| :title: Orchestrator flavor installation using Helm | ||
| :subtitle: Install, configure, and manage the Orchestrator flavor in {product} using Helm | ||
| :abstract: As a {product} ({product-very-short}) administrator, you can install and configure the Orchestrator flavor using Helm, ensuring your environment is prepared for workflow orchestration with {product}. | ||
|
|
||
| = {title} | ||
|
|
||
| //Helm-based | ||
| include::assemblies/assembly-install-rhdh-orchestrator-helm.adoc[leveloffset=+1] |
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 @@ | ||
| ../../modules |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think users would only be interested in resource limits (not requests), as this is what is enforced by the cluster.