From 45999f76e70d86f74b3e10881c9f296bcc6a4619 Mon Sep 17 00:00:00 2001 From: Keane Lim Date: Wed, 29 Sep 2021 10:46:44 -0400 Subject: [PATCH] Added instructions for migrating releases from Helm v2 to Helm v3 Change-Id: I3566f689f7c39e93e10e18caf9d4a6ee8e8f6b07 Signed-off-by: Keane Lim --- doc/source/admintasks/kubernetes/index.rst | 1 + ...s-from-helm-v2-to-helm-v3-9984e7aa7374.rst | 57 +++++++++++++++++++ doc/source/usertasks/kubernetes/index.rst | 1 + ...s-from-helm-v2-to-helm-v3-a6066193c2a8.rst | 57 +++++++++++++++++++ 4 files changed, 116 insertions(+) create mode 100644 doc/source/admintasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374.rst create mode 100644 doc/source/usertasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8.rst diff --git a/doc/source/admintasks/kubernetes/index.rst b/doc/source/admintasks/kubernetes/index.rst index 3719c667a..f4c9b2612 100644 --- a/doc/source/admintasks/kubernetes/index.rst +++ b/doc/source/admintasks/kubernetes/index.rst @@ -22,6 +22,7 @@ Application management :maxdepth: 1 kubernetes-admin-tutorials-helm-package-manager + migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374 kubernetes-admin-tutorials-starlingx-application-package-manager admin-application-commands-and-helm-overrides diff --git a/doc/source/admintasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374.rst b/doc/source/admintasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374.rst new file mode 100644 index 000000000..d35089441 --- /dev/null +++ b/doc/source/admintasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374.rst @@ -0,0 +1,57 @@ +.. _migrate-releases-from-helm-v2-to-helm-v3-9984e7aa7374: + +======================================== +migrate-releases-from-helm-v2-to-helm-v3 +======================================== + +.. rubric:: |context| + +After upgrading a cluster, end users' Helm releases are not upgraded from +version 2. Run a custom script to migrate the end users' Helm releases or +installs to Helm v3. + +.. rubric:: |proc| + +#. Install the /helm-2to3 plugin. + + .. code-block:: none + + ~(keystone-admin)]$ mkdir plugin + wget https://github.com/helm/helm-2to3/releases/download/v0.9.0/helm-2to3_0.9.0_linux_amd64.tar.gz + pushd plugin/ + tar -xvzf ../helm-2to3_0.9.0_linux_amd64.tar.gz + mkdir bin + cp 2to3 bin + popd + export HELM_LINTER_PLUGIN_NO_INSTALL_HOOK=true + helm plugin install ./plugin + +#. Move the helm2 config to helm3. + + .. code-block:: none + + ~(keystone-admin)]$ helm 2to3 move config + +#. Choose a Helm v2 release to migrate. + + .. code-block:: none + + ~(keystone-admin)]$ helmv2-cli -- helm list -a + +#. Migrate a helm2 release, for example, myApplication. + + .. code-block:: none + + ~(keystone-admin)]$ ./migrate_helm_release.py myApplication + +#. Check if it migrated successfully. + + .. code-block:: none + + ~(keystone-admin)]$ helm list -A -a + +#. The migrated release should not appear in helm2. + + .. code-block:: none + + ~(keystone-admin)]$ helmv2-cli -- helm list -a diff --git a/doc/source/usertasks/kubernetes/index.rst b/doc/source/usertasks/kubernetes/index.rst index 907e9d968..6aade98fa 100644 --- a/doc/source/usertasks/kubernetes/index.rst +++ b/doc/source/usertasks/kubernetes/index.rst @@ -57,6 +57,7 @@ Application management :maxdepth: 1 kubernetes-user-tutorials-helm-package-manager + migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8 --------------------- Local Docker registry diff --git a/doc/source/usertasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8.rst b/doc/source/usertasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8.rst new file mode 100644 index 000000000..02d0c6b01 --- /dev/null +++ b/doc/source/usertasks/kubernetes/migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8.rst @@ -0,0 +1,57 @@ +.. _migrate-releases-from-helm-v2-to-helm-v3-a6066193c2a8: + +======================================== +Migrate Releases from Helm v2 to Helm v3 +======================================== + +.. rubric:: |context| + +After upgrading a cluster, end users' Helm releases are not upgraded from +version 2. Run a custom script to migrate the end users' Helm releases or +installs to Helm v3. + +.. rubric:: |proc| + +#. Install the /helm-2to3 plugin. + + .. code-block:: none + + ~(keystone-admin)]$ mkdir plugin + wget https://github.com/helm/helm-2to3/releases/download/v0.9.0/helm-2to3_0.9.0_linux_amd64.tar.gz + pushd plugin/ + tar -xvzf ../helm-2to3_0.9.0_linux_amd64.tar.gz + mkdir bin + cp 2to3 bin + popd + export HELM_LINTER_PLUGIN_NO_INSTALL_HOOK=true + helm plugin install ./plugin + +#. Move the helm2 config to helm3. + + .. code-block:: none + + ~(keystone-admin)]$ helm 2to3 move config + +#. Choose a Helm v2 release to migrate. + + .. code-block:: none + + ~(keystone-admin)]$ helmv2-cli -- helm list -a + +#. Migrate a helm2 release, for example, myApplication. + + .. code-block:: none + + ~(keystone-admin)]$ ./migrate_helm_release.py myApplication + +#. Check if it migrated successfully. + + .. code-block:: none + + ~(keystone-admin)]$ helm list -A -a + +#. The migrated release should not appear in helm2. + + .. code-block:: none + + ~(keystone-admin)]$ helmv2-cli -- helm list -a