Clarify how you need to configure builder for Helm air gap installs #3339
Conversation
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
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
paigecalvert
commented
Jun 27, 2025
paigecalvert
commented
Jun 27, 2025
paigecalvert
commented
Jun 27, 2025
paigecalvert
commented
Jun 27, 2025
paigecalvert
commented
Jun 27, 2025
paigecalvert
commented
Jun 27, 2025
paigecalvert
commented
Jul 1, 2025
| * Declare the SDK as a dependency in your Helm chart. For more information, see [Install the SDK as a Subchart](replicated-sdk-installing#install-the-sdk-as-a-subchart) in _Installing the Replicated SDK_. | ||
|
|
||
| Each tab provides instructions for how to install, perform a manual update, or configure automatic updates, respectively. | ||
| * If your Helm chart's default values do not expose all the required and optional images that might be needed to install in air-gapped environments, add the Replicated HelmChart custom resource to your release and configure `builder` key. For more information, see [builder](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_. If your default values expose all images needed for air gap installations, you do not need to configure the `builder` key. |
Contributor
Author
There was a problem hiding this comment.
Added "If your Helm chart's default values do not expose all the required and optional images that might be needed to install in air-gapped environments..." and "If your default values expose all images needed for air gap installations, you do not need to configure the builder key." per feedback
paigecalvert
commented
Jul 1, 2025
| The Vendor Portal uses this list of images to create the Helm air gap installation instructions that are automatically made available to customers in the Replicated Enterprise Portal or Download Portal. For more information about installing with Helm in air-gapped environments, see [Install and Update with Helm in Air Gap Environments](/vendor/helm-install-airgap). | ||
|
|
||
| For more information, see [Package Air Gap Bundles for Helm Charts](/vendor/helm-packaging-airgap-bundles). | ||
| The list of images is also used when you build the `.airgap` bundle for a release to support air gap installations with a Replicated installer (Embedded Cluster, KOTS, kURL). For more information about how to build `.airgap` bundles, see [Package Air Gap Bundles for Helm Charts](/vendor/helm-packaging-airgap-bundles). |
Contributor
Author
There was a problem hiding this comment.
^ Updated this description per feedback to explain how the air gap instructions are automatically available in the enterprise portal & how you have to trigger an air gap bundle build yourself
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update the Helm Air Gap Install page with a prerequisite to configure the
builderkey: https://deploy-preview-3339--replicated-docs.netlify.app/vendor/helm-install-airgapAdded new troubleshooting section about this builder requirement: https://deploy-preview-3339--replicated-docs.netlify.app/vendor/helm-install-troubleshooting#incomplete-list-of-required-images-in-the-helm-air-gap-instructions
Update the description of the
builderkey with info about how it's used to create helm air gap instructions: https://deploy-preview-3339--replicated-docs.netlify.app/reference/custom-resource-helmchart-v2#builder