generated from redhat-developer/new-project-template
-
Notifications
You must be signed in to change notification settings - Fork 58
RHIDP-6573: Document resource requirements (Helm-based) for orchestrator in RHDH #1282
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
Closed
jmagak
wants to merge
5
commits into
redhat-developer:main
from
jmagak:RHIDP-6573-Document-resource-requirements-for-orchestrator-in-RHDH
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f972231
Resource requirements (Helm-based) for orchestrator
invalid-email-address 269885b
Resource requirements (Helm-based) for orchestrator
invalid-email-address c2dcf80
Resource requirements (Helm-based) for orchestrator
invalid-email-address bb44ce3
Resource requirements (Helm-based) for orchestrator
invalid-email-address 251d122
Resource requirements (Helm-based) for orchestrator
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
| 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 the Orchestrator plugin using Helm | ||
|
|
||
| :context: install-rhdh-orchestrator-helm | ||
|
|
||
| You can install {product} with Orchestrator by using Helm. This method provides flexibility and customization for managing workflow orchestration infrastructure. | ||
|
|
||
| include::modules/orchestrator/ref-orchestrator-resource-limits.adoc[leveloffset=+1] |
54 changes: 54 additions & 0 deletions
54
modules/orchestrator/ref-orchestrator-resource-limits.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,54 @@ | ||
| // Module included in the following assemblies | ||
| // assembly-install-rhdh-orchestrator-helm.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="ref-orchestrator-resource-limits.adoc_{context}"] | ||
| = Resource limits for installing {product} with the Orchestrator plugin | ||
|
|
||
| When installing {product} ({product-very-short}) with the Orchestrator plugin using Helm, the chart defines default CPU and memory limits for the `SonataFlowPlatform` component. | ||
|
|
||
| These limits are enforced by the cluster so that pods do not exceed their allocated resources. | ||
|
|
||
| . Default resource limits | ||
|
|
||
| [%header,cols=2*] | ||
| |=== | ||
| |*Resource* |*Default value* | ||
| |CPU limits |`500m` | ||
| |Memory limits|`1Gi` | ||
| |=== | ||
|
|
||
| .You can override these values in any of the following ways: | ||
|
|
||
| * With `values.yaml` | ||
| * With `--set` flags | ||
|
|
||
| . Override defaults with `values.yaml` as shown in the following example: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| orchestrator: | ||
| enabled: true | ||
| sonataflowPlatform: | ||
| resources: | ||
| limits: | ||
| cpu: "500m" | ||
| memory: "1Gi" | ||
| ---- | ||
|
|
||
| . Override with `--set` as shown in the following example: | ||
| + | ||
| [source,yaml] | ||
| ---- | ||
| helm upgrade --install <release_name> openshift-helm-charts/redhat-developer-hub \ | ||
| --set orchestrator.enabled=true \ | ||
| --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 | ||
| ---- | ||
| + | ||
| [NOTE] | ||
| ==== | ||
| These settings are applicable only when `orchestrator.enabled` is `true`. By default, it is set to `false`. | ||
| ==== | ||
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,16 @@ | ||
| include::artifacts/attributes.adoc[] | ||
| :context: orchestrator-install | ||
| :imagesdir: images | ||
| :title: Installing {product} with the Orchestrator plugin | ||
| :subtitle: Install, configure, and manage {product} with the Orchestrator plugin using Helm or the {product} Operator | ||
| :abstract: As a cluster administrator, you can install {product} ({product-very-short}) with the Orchestrator plugin enabled. | ||
|
|
||
| = {title} | ||
|
|
||
| You can install {product} ({product-very-short}) using one of the following methods: | ||
|
|
||
| * The {product} Operator | ||
| * The {product} Helm chart | ||
|
|
||
| // Helm chart method | ||
| 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.
Uh oh!
There was an error while loading. Please reload this page.