Skip to content

Commit 5f27970

Browse files
committed
edits
1 parent db06511 commit 5f27970

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

docs/vendor/helm-v2-migrate.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,31 +87,54 @@ To migrate applications that were previously packaged as standard Kubernetes man
8787

8888
1. Create a new release containing the Kubernetes manifests for your application.
8989

90-
1. For each application manifest in the release, add the `kots.io/keep` annotation. This ensures that KOTS does not delete these existing resources from the cluster when deploying a new release using the HelmChart v2 method.
90+
1. For each of the application manifests in the release, add the `kots.io/keep` annotation.
91+
92+
This ensures that KOTS will not delete these resources from the cluster when deploying a new release that uses the HelmChart v2 method.
9193

9294
1. Save the release.
9395

9496
1. Create another new release:
9597

96-
1. Remove all the standard Kubernetes manifests and adds the new Helm chart(s) for the application instead.
98+
1. In the release, add your new application Helm chart or charts.
99+
100+
1. Remove the Kubernetes manifests that are replaced by the Helm chart(s).
97101

98-
1. In the Embedded Cluster Config for the new release, add the `--take-ownership` flag.
102+
1. In the Embedded Cluster Config, add the `--take-ownership` flag to the `helmUpgradeFlags` field, as shown below:
99103

100-
1. (Recommended) In the KOTS Application custom resource, set `minKotsVersion: 1.122.0` to ensure that the `--take-ownership` flag is supported.
104+
```yaml
105+
# HelmChart v1 beta2
106+
apiVersion: kots.io/v1beta2
107+
kind: HelmChart
108+
metadata:
109+
name: samplechart
110+
spec:
111+
helmUpgradeFlags:
112+
- --take-ownership
113+
```
114+
115+
When the `--take-ownership` flag is enabled, Helm automatically takes ownership of existing resources in the cluster during upgrade.
116+
117+
1. (Recommended) In the KOTS Application custom resource, set `minKotsVersion: 1.122.0`. The Helm `--take-ownership` flag is not supported on versions of KOTS earlier than 1.122.0.
118+
119+
1. Save the release.
101120

102121
1. Test the upgrade flow:
103122

104-
1. Promote the first release to an internal channel used for testing. Replicated recommends that you mark the release as required because customers will need to upgrade to this release first before they can upgrade to the second release in order to migrate to HelmChart v2.
123+
1. Promote the first release to an internal-only channel used for testing.
124+
125+
:::note
126+
Replicated recommends that you mark the release as required because customers must upgrade to this release first before they can upgrade to the release that migrates to HelmChart v2.
127+
:::
105128

106-
1. Install the release in a development environment.
129+
1. In a development environment, install the release.
107130

108131
1. Promote the second release to the same channel.
109132

110-
1. In your development environment, upgrade to the second release from the Admin Console to migrate to HelmChart v2. Confirm that none of the existing resources in the cluster were deleted during upgrade.
133+
1. In your development environment, upgrade to the second release to migrate the installation to HelmChart v2. Confirm that none of the existing resources in the cluster were deleted during upgrade.
111134

112-
1. When you are done testing, promote the first release containing the Kubernetes manifests to one or more customer-facing channels. Replicated recommends that you mark the release as required because customers will need to upgrade to this release first before they can upgrade to the second release in order to migrate to HelmChart v2.
135+
1. When you are ready, promote the first release containing your application manifests to one or more customer-facing channels.
113136

114-
1. Promote the second release containing your Helm chart(s) to the same channel(s).
137+
1. Promote the second release containing your application Helm chart to the same channel or channels.
115138

116139
1. Instruct customers to migrate by first upgrading to the release packaged with standard manifests, then upgrading to the release packaged with Helm second.
117140

0 commit comments

Comments
 (0)