Edit configuring helmchart v2 #3377
Conversation
✅ 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
|
|
||
| <details> | ||
| <summary>What is the registry namespace?</summary> | ||
| # Support Installations with HelmChart v2 |
There was a problem hiding this comment.
Configure the HelmChart Custom Resource v2 --> Support Installations with HelmChart v2 since it's walking you through the whole process which involves editing your Helm values now (not just the HelmChart resource)
|
|
||
| This topic describes how to configure the Replicated HelmChart custom resource version `kots.io/v1beta2` to support Helm chart installations with Replicated KOTS. | ||
|
|
||
| ## Workflow |
There was a problem hiding this comment.
^ removed "Workflow" and subheadings in favor of just making this a numbered list. This was possible since we are now linking off to a lot of content and overall there was a lot of content that could be cut down on
|
|
||
| To configure a release to support installations with HelmChart v2: | ||
|
|
||
| 1. For each Helm chart used by your application, update all image references in the Helm values to use the domain of the Replicated proxy registry. See [Configure Your Application to Use the Proxy Registry](/vendor/private-images-kots) in _Use the Proxy Registry with Replicated Installers_. |
There was a problem hiding this comment.
^ first steps links to the now-updated page on how to configure helm values for proxy registry
|
|
||
| 1. For each HelmChart v2 resource in the release, configure the `builder` key. This ensures that all the required and optional images for your application are available for users to push to their own local image registry. Using a local image registry is required in air gap installations and optional in online installations. See [`builder`](/reference/custom-resource-helmchart-v2#builder) in _HelmChart v2_. | ||
|
|
||
| 1. For each HelmChart v2 resource in the release, configure the [`optionalValues`](/reference/custom-resource-helmchart-v2#optionalValues) key so that KOTS conditionally rewrites any application image references in your Helm values if a local image registry is used. |
There was a problem hiding this comment.
This step was updated so show how to use optionalValues instead of ternary operators for conditionally rewriting image refs to local registries
| The registry namespace is the path between the registry and the image name. For example, `images.registry.com/namespace/image:tag`. | ||
| </details> | ||
|
|
||
| 1. In the HelmChart v2 custom resource that corresponds to the chart where the Replicated SDK is declared as a dependency, configure the [`optionalValues`](/reference/custom-resource-helmchart-v2#optionalValues) key using the same method as in the previous step to conditionally rewrite the Replicated SDK image reference. |
There was a problem hiding this comment.
^ also added a corresponding step for updating the sdk image to be conditionally rewritten to local registries
| <summary>What is the registry namespace?</summary> | ||
|
|
||
| The registry namespace is the path between the registry and the image name. For example, `images.registry.com/namespace/image:tag`. | ||
| </details> |
There was a problem hiding this comment.
^ I moved a lot of the explanatory content to
|
|
||
| 1. Promote the release a channel that your team uses for testing, and install the release in a development environment to test your changes. | ||
|
|
||
| ## Next Step: Migrate Existing Installations to HelmChart v2 |
There was a problem hiding this comment.
^ updated this heading to say Next Step
docs/vendor/helm-native-v2-using.md
Outdated
|
|
||
| 1. For each Helm chart in the release, ensure that there is a corresponding HelmChart v2 custom resource (version `kots.io/v1beta2`) . See [HelmChart v2](/reference/custom-resource-helmchart-v2). | ||
|
|
||
| 1. If you are migrating from HelmChart v1, remove any unsupported fields from the HelmChart custom resource(s) in the release. See [Differences From HelmChart v1](#differences) below. |
There was a problem hiding this comment.
^ added a few new small steps to walk people through actually adding the packaged chart archives to a new release and setting up the helmchart v2 resource (ie, update your helm values, package all the charts, add all the archives to a release, add or update the helmchart custom resources for each chart to use v2)
https://deploy-preview-3377--replicated-docs.netlify.app/vendor/helm-native-v2-using