RHIDP-6574: Document resource required (Helm-based) for air-gapped environment #1283
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-airgapped-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,60 @@ | ||
| // Module included in the following assemblies | ||
| // assembly-install-rhdh-orchestrator-helm.adoc | ||
|
|
||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="con-airgapped-requirements-orchestrator_{context}"] | ||
| = Resource requirements for air-gapped environments | ||
|
|
||
| You can deploy the Orchestrator flavor of {product} in air-gapped environments by ensuring that all container images, and Helm charts required by {product} and SonataFlow are available internally. | ||
|
|
||
| For workflow orchestration in air-gapped environments, the following resources are recommended: | ||
|
|
||
| [cols="2,2", options="header"] | ||
| |=== | ||
| | Resource component | ||
| | Recommended resources | ||
|
|
||
| | RHDH Orchestrator plugin | ||
| | 2 vCPUs, 2–4 GiB memory | ||
|
|
||
| | SonataFlow runtime | ||
| | 1 vCPU, 1–2 GiB memory | ||
|
|
||
| | Knative Serving and Eventing | ||
| | 1–2 vCPUs, 1.5 GiB memory | ||
|
|
||
| | PostgreSQL or External DB | ||
| | 1 vCPU, 1 GiB memory | ||
|
|
||
| | Persistent storage | ||
| | 5 GiB (minimum), adjust based on workflow logs and artifacts | ||
| |=== | ||
|
|
||
| To prepare for an air-gapped deployment, complete the following steps: | ||
|
|
||
| . **Mirror container images** | ||
|
|
||
| Mirror all required {product-very-short}, SonataFlow, Knative, and orchestrator plugin images to an internal container registry. Ensure that the image versions match the Helm chart values. | ||
|
|
||
| . **Mirror Helm charts** | ||
|
|
||
| Pre-download the Helm charts for `redhat-developer-hub`, `orchestrator-infra`, and any dependent charts (for example, `bitnami` and `backstage`). Host them in an internal chart repository or file server. | ||
|
|
||
| . **CRD and operator installation** | ||
|
|
||
| Download the required CRDs and YAML manifests for SonataFlow and Knative operators and apply them manually. | ||
|
|
||
| . **Configure network policies** | ||
|
|
||
| Validate inter-pod communication and ensure internal DNS resolution to the mirrored image registry. | ||
|
Comment on lines
+35
to
+49
There was a problem hiding this comment. Shouldn't the concrete steps/commands to do this be documented? Like, which version of the plugins, Helm chart to mirror exactly? We should also consider the following scenarios: partially disconnected vs fully disconnected environments. See https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.6/html-single/installing_red_hat_developer_hub_in_an_air-gapped_environment/index#assembly-install-rhdh-airgapped-environment-ocp-helm_title-install-rhdh-air-grapped |
||
|
|
||
| . **Use `imagePullSecrets`** | ||
|
|
||
| Update your `values.yaml` file with credentials for the internal registry if it is private: | ||
|
|
||
| [source,yaml] | ||
| ---- | ||
| global: | ||
| imagePullSecrets: | ||
| - name: internal-registry-secret | ||
| ---- | ||
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.
Just curious, where are these recommended values coming from? I guess these should not be only for air-gapped environments, but for any env requiring workflow orchestration, no?