Edit onboarding flow to rewite image names in helm chart #3357
+161
−23
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
Jul 3, 2025
| @@ -6,6 +6,9 @@ import Requirements from "../partials/embedded-cluster/_requirements.mdx" | |||
| import SDKOverview from "../partials/replicated-sdk/_overview.mdx" | |||
| import TestYourChanges from "../partials/getting-started/_test-your-changes.mdx" | |||
| import UnauthorizedError from "../partials/replicated-sdk/_401-unauthorized.mdx" | |||
| import StepCreds from "../partials/proxy-service/_step-creds.mdx" | |||
| import RewriteHelmValues from "../partials/proxy-service/_step-rewrite-helm-values.mdx" | |||
| import InjectPullSecret from "../partials/proxy-service/_step-inject-pull-secret.mdx" | |||
There was a problem hiding this comment.
^ preemptively putting these in partials so that these steps can be reused in the HelmChart v2 topic as part of follow on PRs
paigecalvert
commented
Jul 3, 2025
| @@ -450,7 +484,11 @@ To add support for air gap installations: | |||
|
|
|||
| 1. If there are any images for your application that are not listed in your Helm chart, list these images in the `additionalImages` attribute of the KOTS Application custom resource. This ensures that the images are included in the air gap bundle for the release. One common use case for this is applications that use Kubernetes Operators. See [Define Additional Images](/vendor/operator-defining-additional-images). | |||
|
|
|||
| 1. In the KOTS HelmChart custom resource `builder` key, pass any values that are required in order for `helm template` to yield all the images needed to successfully install your application. See [Package Air Gap Bundles for Helm Charts](/vendor/helm-packaging-airgap-bundles). | |||
| 1. For each Helm chart in your release, update the KOTS HelmChart custom resource `optionalValues` key to conditionally rewrite image names for air gap installations. This is done using the KOTS HasLocalRegistry, LocalRegistryHost, and LocalRegistryNamespace template functions to render the location of the given image in the user's own local registry. | |||
There was a problem hiding this comment.
^ Added this optionalValues step to Add Support for Air Gap Installations
paigecalvert
commented
Jul 3, 2025
| @@ -464,10 +502,6 @@ To add support for air gap installations: | |||
| For many applications, running `helm template` with the default values would not yield all the images required to install. In these cases, vendors can pass the additional values in the `builder` key to ensure that the air gap bundle includes all the necessary images. | |||
| </details> | |||
|
|
|||
| 1. If you have not done so already as part of [Task 4: Create and Install the Initial Release](#first-release), ensure that the `values` key in the KOTS HelmChart custom resource correctly rewrites image names for air gap installations. This is done using the KOTS HasLocalRegistry, LocalRegistryHost, and LocalRegistryNamespace template functions to render the location of the given image in the user's own local registry. | |||
|
|
|||
| For more information, see [Rewrite Image Names](/vendor/helm-native-v2-using#rewrite-image-names) in _Configuring the HelmChart Custom Resource v2_. | |||
There was a problem hiding this comment.
^ removed this step from Add Support for Air Gap Installations since it's not longer accurate
paigecalvert
commented
Jul 3, 2025
|
|
||
| :::note | ||
| Replicated also offers Alpha support for air gap installations with Helm. If you are interested in trying Helm air gap installations and providing feedback, please reach out to your account rep to enable this feature. | ||
| ::: |
There was a problem hiding this comment.
^ removed these old Alpha notes about helm air gap
paigecalvert
commented
Jul 3, 2025
| @@ -464,27 +494,60 @@ To add support for air gap installations: | |||
| For many applications, running `helm template` with the default values would not yield all the images required to install. In these cases, vendors can pass the additional values in the `builder` key to ensure that the air gap bundle includes all the necessary images. | |||
| </details> | |||
|
|
|||
| 1. If you have not done so already as part of [Task 4: Create and Install the Initial Release](#first-release), ensure that the `values` key in the KOTS HelmChart custom resource correctly rewrites image names for air gap installations. This is done using the KOTS HasLocalRegistry, LocalRegistryHost, and LocalRegistryNamespace template functions to render the location of the given image in the user's own local registry. | |||
| 1. For each Helm chart in your release, configure the corresponding KOTS HelmChart custom resource `optionalValues` key to conditionally rewrite image names to the user's local image registry. This is done using the KOTS [HasLocalRegistry](/reference/template-functions-config-context#haslocalregistry), [LocalRegistryHost](/reference/template-functions-config-context#localregistryhost), and [LocalRegistryNamespace](/reference/template-functions-config-context#localregistrynamespace) template functions to render the location of the given image in the user's own local registry. | |||
There was a problem hiding this comment.
^ added this step about how to conditionally rewrite image names to use the local registry for air gap
paigecalvert
commented
Jul 3, 2025
| </details> | ||
|
|
||
| 1. If your application is deployed as multiple Helm charts, repeat the step above to add a separate HelmChart custom resource for each Helm chart archive in the release. | ||
| 1. <InjectPullSecret/> |
There was a problem hiding this comment.
^ Added this step to "Task 4: Create the initial release..." to tell people how to inject the pull secret using the HelmChart values key
paigecalvert
commented
Jul 3, 2025
| :::note | ||
| Replicated also offers Alpha support for air gap installations with Helm. If you are interested in trying Helm air gap installations and providing feedback, please reach out to your account rep to enable this feature. | ||
| ::: | ||
| Replicated supports installations in _air gap_ environments with little or no outbound internet access. For Embedded Cluster and KOTS, users install by providing an air gap bundle which contains the required images for the Replicated installer and your application. For Helm installations, users install by following automatically-generated instructions provided in the Replicated Enterprise Portal to pull all images and push them to their local image registry. |
There was a problem hiding this comment.
^ Needed to update this because it hadn't been updated since Helm air gap was GA
paigecalvert
commented
Jul 3, 2025
| :::note | ||
| Replicated also offers Alpha support for air gap installations with Helm. If you are interested in trying Helm air gap installations and providing feedback, please reach out to your account rep to enable this feature. | ||
| ::: | ||
| Replicated supports installations in _air gap_ environments with little or no outbound internet access. For Embedded Cluster and KOTS, users install by providing an air gap bundle which contains the required images for the Replicated installer and your application. For Helm installations, users install by following automatically-generated instructions provided in the Replicated Enterprise Portal to pull all images and push them to their local image registry. | ||
|
|
||
| To add support for air gap installations: |
There was a problem hiding this comment.
Note: I think there are more edits that are needed to this Add Support for Air Gap Installations section. For example, we should probably split it out so that it's clear what steps are needed for Replicated installers and what steps are needed for Helm air gap. However, didn't want to get into all of that for this PR.
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.
Updates the Replicated Onboarding flow to reflect the new proxy registry process (as in, telling users to edit image names in their helm values rather than using the HelmChart custom resource):
They’ll then add the SDK and package their chart before adding it to a new release.
Related to: #3209