From 2c190029e81cbfd77a858b5fd0779c7fbc9af373 Mon Sep 17 00:00:00 2001 From: Kaxil Naik Date: Wed, 28 Jul 2021 13:44:09 +0100 Subject: [PATCH] Chart: Add instructions to Update Helm Repo before upgrade (#17282) This adds some docs to make this more visible. Also updates the step to remove old artifacts after a day or keep current + last artifact in release svn repo. --- chart/UPDATING.rst | 2 ++ dev/README_RELEASE_HELM_CHART.md | 22 ++++++++++++++++------ docs/helm-chart/index.rst | 3 +++ 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/chart/UPDATING.rst b/chart/UPDATING.rst index f9e2ac29f3106..9413403ea209b 100644 --- a/chart/UPDATING.rst +++ b/chart/UPDATING.rst @@ -36,6 +36,8 @@ assists users migrating to a new version. Airflow Helm Chart 1.1.0 ------------------------ +Run ``helm repo update`` before upgrading the chart to the latest version. + Default Airflow version is updated to ``2.1.2`` """"""""""""""""""""""""""""""""""""""""""""""" diff --git a/dev/README_RELEASE_HELM_CHART.md b/dev/README_RELEASE_HELM_CHART.md index 2955e8908ab95..e5aea88e14dd9 100644 --- a/dev/README_RELEASE_HELM_CHART.md +++ b/dev/README_RELEASE_HELM_CHART.md @@ -37,6 +37,7 @@ - [Update `index.yaml` to Airflow Website](#update-indexyaml-to-airflow-website) - [Notify developers of release](#notify-developers-of-release) - [Update Announcements page](#update-announcements-page) + - [Remove old releases](#remove-old-releases) @@ -490,12 +491,6 @@ for f in ../../../airflow-dev/helm-chart/$RC/*; do svn cp $f ${$(basename $f)/}; svn rm index.yaml svn commit -m "Release Airflow Helm Chart Check ${VERSION} from ${RC}" -# Remove old release -# http://www.apache.org/legal/release-policy.html#when-to-archive -cd .. -export PREVIOUS_VERSION=1.0.0 -svn rm ${PREVIOUS_VERSION} -svn commit -m "Remove old Helm Chart release: ${PREVIOUS_VERSION}" ``` Verify that the packages appear in [Airflow Helm Chart](https://dist.apache.org/repos/dist/release/airflow/helm-chart/). @@ -590,3 +585,18 @@ EOF ## Update Announcements page Update "Announcements" page at the [Official Airflow website](https://airflow.apache.org/announcements/) + +## Remove old releases + +We should keep the old version a little longer than a day or at least until the updated +``index.yaml`` is published. This is to avoid errors for users who haven't run ``helm repo update``. + +It is probably ok if we leave last 2 versions on release svn repo too. + +```shell +# http://www.apache.org/legal/release-policy.html#when-to-archive +cd airflow-release/helm-chart +export PREVIOUS_VERSION=1.0.0 +svn rm ${PREVIOUS_VERSION} +svn commit -m "Remove old Helm Chart release: ${PREVIOUS_VERSION}" +``` diff --git a/docs/helm-chart/index.rst b/docs/helm-chart/index.rst index aa2e2050b675f..25318cc9bdb9d 100644 --- a/docs/helm-chart/index.rst +++ b/docs/helm-chart/index.rst @@ -103,6 +103,9 @@ To upgrade the chart with the release name ``airflow``: helm upgrade airflow apache-airflow/airflow --namespace airflow +.. note:: + To upgrade to a new version of the chart, run ``helm repo update`` first. + Uninstalling the Chart ----------------------