Skip to content

Commit 871d3a5

Browse files
committed
edits
1 parent 850bdfd commit 871d3a5

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/vendor/helm-v2-migrate.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,13 @@ To migrate existing installations from HelmChart v1 with `useHelmInstall: true`
3030

3131
### Migrate From HelmChart v1 with `useHelmInstall: false`
3232

33-
This section describes how to migrate existing HelmChart v1 installations with `useHelmInstall: false`. These migration steps ensure that KOTS does not uninstall any resources that were previously deployed without Helm, and that Helm takes ownership of these existing resources.
33+
This section describes how to migrate existing HelmChart v1 installations with `useHelmInstall: false`.
34+
35+
:::note
36+
When the `useHelmInstall` field is _not_ set in the HelmChart custom resource, `false` is the default value.
37+
:::
38+
39+
These migration steps ensure that KOTS does not uninstall any resources that were previously deployed without Helm, and that Helm takes ownership of these existing resources.
3440

3541
To migrate existing installations from HelmChart v1 and `useHelmInstall: false` to HelmChart v2:
3642

@@ -54,7 +60,7 @@ To migrate existing installations from HelmChart v1 and `useHelmInstall: false`
5460
5561
1. Create another new release:
5662
57-
1. For each Helm chart in the release, configure the corresponding HelmChart custom resource to update `apiVersion` to `kots.io/v1beta2`, rewrite images, inject image pull secrets, and add backup labels. See [Configuring the HelmChart Custom Resource v2](helm-native-v2-using).
63+
1. For each Helm chart in the release, find the corresponding HelmChart custom resource and update `apiVersion` to `kots.io/v1beta2`. Then update it to rewrite images, inject image pull secrets, and add backup labels. See [Configuring the HelmChart Custom Resource v2](helm-native-v2-using).
5864

5965
1. In the HelmChart custom resource, under the `helmUpgradeFlags` field, add the `--take-ownership` flag:
6066

@@ -89,7 +95,7 @@ To migrate existing installations from HelmChart v1 and `useHelmInstall: false`
8995

9096
1. Instruct customers to migrate by first upgrading to the release where the `kots.io.keep` annotation is applied to your resources, then upgrading to the release with HelmChart v2.
9197

92-
1. In subsequent releases, remove the `helmUpgradeFlags` field (including the `--take-ownership` flag) from the HelmChart custom resource. This flag is only required during one upgrade to allow Helm to take ownership of your application resources.
98+
1. In subsequent releases, remove the `--take-ownership` flag from the `helmUpgradeFlags` field and remove the `kots.io/keep` annotation from resources in your Helm templates.
9399

94100
### Migrate From Standard Kubernetes Manifests
95101

@@ -153,7 +159,7 @@ To migrate applications that were previously packaged as standard Kubernetes man
153159

154160
1. Instruct customers to migrate by first upgrading to the release containing the standard manifests, then upgrading to the release packaged with Helm.
155161

156-
1. In subsequent releases, remove the `helmUpgradeFlags` field (including the `--take-ownership` flag) from the HelmChart custom resource. This flag is only required during one upgrade to allow Helm to take ownership of your application resources.
162+
1. In subsequent releases, remove the `--take-ownership` flag from the `helmUpgradeFlags` field and remove the `kots.io/keep` annotation from resources in your Helm templates.
157163

158164
## Support Customers on KOTS Versions Earlier Than v1.99.0 {#support-both-v1-v2}
159165

0 commit comments

Comments
 (0)