From 3a2c380cf73114b9ca06ce9af0ed1ae753e03317 Mon Sep 17 00:00:00 2001 From: Jed Cunningham Date: Fri, 27 Jan 2023 16:28:02 -0700 Subject: [PATCH 1/2] Release notes for helm chart 1.8.0 --- chart/Chart.yaml | 226 +++++++++------------- chart/RELEASE_NOTES.rst | 105 +++++++++- chart/newsfragments/27353.significant.rst | 21 -- chart/newsfragments/27625.significant.rst | 4 - chart/newsfragments/29074.significant.rst | 3 - newsfragments/27698.significant.rst | 1 - 6 files changed, 194 insertions(+), 166 deletions(-) delete mode 100644 chart/newsfragments/27353.significant.rst delete mode 100644 chart/newsfragments/27625.significant.rst delete mode 100644 chart/newsfragments/29074.significant.rst delete mode 100644 newsfragments/27698.significant.rst diff --git a/chart/Chart.yaml b/chart/Chart.yaml index 028837cfa9757..8825df3549720 100644 --- a/chart/Chart.yaml +++ b/chart/Chart.yaml @@ -44,7 +44,7 @@ type: application annotations: artifacthub.io/links: | - name: Documentation - url: https://airflow.apache.org/docs/helm-chart/1.6.0/ + url: https://airflow.apache.org/docs/helm-chart/1.8.0/ artifacthub.io/screenshots: | - title: DAGs View url: https://airflow.apache.org/docs/apache-airflow/2.5.1/_images/dags.png @@ -67,187 +67,143 @@ annotations: - title: Task Instance Context Menu url: https://airflow.apache.org/docs/apache-airflow/2.5.1/_images/context.png artifacthub.io/changes: | - - description: Make cleanup job history configurable + - description: Add annotations on deployments kind: added links: - - name: '#26838' - url: https://github.com/apache/airflow/pull/26838 - - description: Added labels to specific Airflow components + - name: '#28688' + url: https://github.com/apache/airflow/pull/28688 + - description: Add global volume & volumeMounts to the chart kind: added links: - - name: '#25031' - url: https://github.com/apache/airflow/pull/25031 - - description: Add StatsD ``overrideMappings`` in Helm chart values - kind: added - links: - - name: '#26598' - url: https://github.com/apache/airflow/pull/26598 - - description: Adding ``podAnnotations`` to StatsD deployment template - kind: added - links: - - name: '#25732' - url: https://github.com/apache/airflow/pull/25732 - - description: Container specific extra environment variables - kind: added - links: - - name: '#24784' - url: https://github.com/apache/airflow/pull/24784 - - description: Custom labels for extrasecrets/configmaps - kind: added - links: - - name: '#25283' - url: https://github.com/apache/airflow/pull/25283 - - description: Add ``revisionHistoryLimit`` to all deployments - kind: added - links: - - name: '#25059' - url: https://github.com/apache/airflow/pull/25059 - - description: Adding ``podAnnotations`` to Redis StatefulSet - kind: added - links: - - name: '#23708' - url: https://github.com/apache/airflow/pull/23708 - - description: Provision Standalone Dag Processor - kind: added - links: - - name: '#23711' - url: https://github.com/apache/airflow/pull/23711 - - description: Add configurable scheme for webserver probes - kind: added + - name: '#27781' + url: https://github.com/apache/airflow/pull/27781 + - description: Add support for ``webserverConfigConfigMapName`` + kind: changed links: - - name: '#22815' - url: https://github.com/apache/airflow/pull/22815 - - description: Add support for KEDA HPA config to Helm chart - kind: added + - name: '#27419' + url: https://github.com/apache/airflow/pull/27419 + - description: Enhance chart to allow over-riding command-line args to statsd exporter + kind: changed links: - - name: '#24220' - url: https://github.com/apache/airflow/pull/24220 - - description: Add 'executor' label to Airflow scheduler deployment + - name: '#28041' + url: https://github.com/apache/airflow/pull/28041 + - description: Add support for NodePort in Services kind: changed links: - - name: '#25684' - url: https://github.com/apache/airflow/pull/25684 - - description: Add default ``flower_url_prefix`` in Helm chart values + - name: '#26945' + url: https://github.com/apache/airflow/pull/26945 + - description: Add worker log-groomer-sidecar enable option kind: changed links: - - name: '#26415' - url: https://github.com/apache/airflow/pull/26415 - - description: Add liveness probe to Celery workers + - name: '#27178' + url: https://github.com/apache/airflow/pull/27178 + - description: Add HostAliases to Pod template file kind: changed links: - - name: '#25561' - url: https://github.com/apache/airflow/pull/25561 - - description: Use ``sql_alchemy_conn`` for celery result backend when ``result_backend`` - is not set + - name: '#27544' + url: https://github.com/apache/airflow/pull/27544 + - description: Allow PgBouncer replicas to be configurable kind: changed links: - - name: '#24496' - url: https://github.com/apache/airflow/pull/24496 - - description: Fix pod template ``imagePullPolicy`` + - name: '#27439' + url: https://github.com/apache/airflow/pull/27439 + - description: Create scheduler service to serve task logs for LocalKubernetesExecutor kind: fixed links: - - name: '#26423' - url: https://github.com/apache/airflow/pull/26423 - - description: Do not declare a volume for ``sshKeySecret`` if dag persistence is - enabled + - name: '#28828' + url: https://github.com/apache/airflow/pull/28828 + - description: Fix NOTES.txt to show correct URL kind: fixed links: - - name: '#22913' - url: https://github.com/apache/airflow/pull/22913 - - description: Pass worker annotations to generated pod template + - name: '#28264' + url: https://github.com/apache/airflow/pull/28264 + - description: Add worker service account for LocalKubernetesExecutor kind: fixed links: - - name: '#24647' - url: https://github.com/apache/airflow/pull/24647 - - description: Fix semver compare number for ``jobs check`` command + - name: '#28813' + url: https://github.com/apache/airflow/pull/28813 + - description: Remove checks for 1.19 api checks kind: fixed links: - - name: '#24480' - url: https://github.com/apache/airflow/pull/24480 - - description: Use ``--local`` flag for liveness probes in Airflow 2.5+ + - name: '#28461' + url: https://github.com/apache/airflow/pull/28461 + - description: Add airflow_local_settings to all airflow containers kind: fixed links: - - name: '#24999' - url: https://github.com/apache/airflow/pull/24999 - - description: 'Docs: Improve documentation on helm hooks disabling' - kind: changed - links: - - name: '#26747' - url: https://github.com/apache/airflow/pull/26747 - - description: 'Docs: Remove ``ssh://`` prefix from git repo value' - kind: changed + - name: '#27779' + url: https://github.com/apache/airflow/pull/27779 + - description: Make custom env vars optional for job templates + kind: fixed links: - - name: '#26632' - url: https://github.com/apache/airflow/pull/26632 - - description: 'Docs: Update docs when not to use Helm hooks for starting jobs' - kind: changed + - name: '#27148' + url: https://github.com/apache/airflow/pull/27148 + - description: Decrease default gitSync wait + kind: fixed links: - - name: '#26604' - url: https://github.com/apache/airflow/pull/26604 - - description: 'Docs: Fix ``defaultAirflowRepository`` comment' - kind: changed + - name: '#27625' + url: https://github.com/apache/airflow/pull/27625 + - description: Add ``extraVolumeMounts`` to sidecars too + kind: fixed links: - - name: '#26428' - url: https://github.com/apache/airflow/pull/26428 - - description: 'Docs: Baking DAGs into Docker image' - kind: changed + - name: '#27420' + url: https://github.com/apache/airflow/pull/27420 + - description: Fix PgBouncer after PostgreSQL subchart upgrade + kind: fixed links: - - name: '#26401' - url: https://github.com/apache/airflow/pull/26401 - - description: 'Docs: Reload pods when using the same DAG tag' + - name: '#29207' + url: https://github.com/apache/airflow/pull/29207 + - description: 'Docs: Enhance production guide with a few Argo specific guidelines' kind: changed links: - - name: '#24576' - url: https://github.com/apache/airflow/pull/24576 - - description: 'Docs: Minor clarifications about ``result_backend``, dag processor, - and ``helm uninstall``' + - name: '#29078' + url: https://github.com/apache/airflow/pull/29078 + - description: 'Docs: Add doc note about Pod template images' kind: changed links: - - name: '#24929' - url: https://github.com/apache/airflow/pull/24929 - - description: 'Docs: Add hyperlinks to Github PRs for Release Notes' + - name: '#29032' + url: https://github.com/apache/airflow/pull/29032 + - description: 'Docs: Update production guide db section' kind: changed links: - - name: '#24532' - url: https://github.com/apache/airflow/pull/24532 - - description: 'Docs: Add Flux to chart gitops docs' + - name: '#28610' + url: https://github.com/apache/airflow/pull/28610 + - description: 'Docs: Fix to LoadBalancer snippet' kind: changed links: - - name: '#24288' - url: https://github.com/apache/airflow/pull/24288 - - description: 'Docs: Provide details on how to pull Airflow image from a private - repository' + - name: '#28014' + url: https://github.com/apache/airflow/pull/28014 + - description: 'Docs: Fix gitSync example code' kind: changed links: - - name: '#24394' - url: https://github.com/apache/airflow/pull/24394 - - description: 'Docs: Helm logo no longer a link' + - name: '#28083' + url: https://github.com/apache/airflow/pull/28083 + - description: 'Docs: Correct repo example for cloning via ssh' kind: changed links: - - name: '#23977' - url: https://github.com/apache/airflow/pull/23977 - - description: 'Docs: Document LocalKubernetesExecutor support in chart' + - name: '#27671' + url: https://github.com/apache/airflow/pull/27671 + - description: 'Misc: Update Airflow version to 2.5.1' kind: changed links: - - name: '#23876' - url: https://github.com/apache/airflow/pull/23876 - - description: 'Docs: Update Production Guide' + - name: '#29074' + url: https://github.com/apache/airflow/pull/29074 + - description: 'Misc: Update git-sync to 3.6.3' kind: changed links: - - name: '#23836' - url: https://github.com/apache/airflow/pull/23836 - - description: 'Misc: Default Airflow version to 2.5.0' + - name: '#27848' + url: https://github.com/apache/airflow/pull/27848 + - description: 'Misc: Upgrade ``bitnami/postgresql`` subchart to 12.1.9' kind: changed links: - - name: '#26485' - url: https://github.com/apache/airflow/pull/26485 - - description: 'Misc: Vendor in the bitnami chart' + - name: '#29071' + url: https://github.com/apache/airflow/pull/29071 + - description: 'Misc: Update redis to 7' kind: changed links: - - name: '#24395' - url: https://github.com/apache/airflow/pull/24395 - - description: 'Misc: Remove kubernetes 1.20 support' + - name: '#27443' + url: https://github.com/apache/airflow/pull/27443 + - description: 'Misc: Replace helm chart icon' kind: changed links: - - name: '#25871' - url: https://github.com/apache/airflow/pull/25871 + - name: '#27704' + url: https://github.com/apache/airflow/pull/27704 diff --git a/chart/RELEASE_NOTES.rst b/chart/RELEASE_NOTES.rst index 37d8fdcac5e98..ded8336fcb9a1 100644 --- a/chart/RELEASE_NOTES.rst +++ b/chart/RELEASE_NOTES.rst @@ -23,15 +23,116 @@ Run ``helm repo update`` before upgrading the chart to the latest version. .. towncrier release notes start +Airflow Helm Chart 1.8.0 (2023-02-02) +------------------------------------- + +Significant Changes +^^^^^^^^^^^^^^^^^^^ + +``bitnami/postgresql`` subchart updated to ``12.1.9`` (#29071) +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The version of postgresql installed is still version 11. + +If you are upgrading an existing helm release with the built-in postgres database, you will either need to delete your release and reinstall fresh, or manually delete these 2 objects: + +``` +kubectl delete secret {RELEASE_NAME}-postgresql +kubectl delete statefulset {RELEASE_NAME}-postgresql +``` + +As a reminder, it is recommended to `set up an external database `_ in production. + +This version of the chart uses different variable names for setting usernames and passwords in the postgres database. + +- ``postgresql.auth.enablePostgresUser`` is used to determine if the "postgres" admin account will be created. +- ``postgresql.auth.postgresPassword`` sets the password for the "postgres" user. +- ``postgresql.auth.username`` and ``postrgesql.auth.password`` are used to set credentials for a non-admin account if desired. +- ``postgresql.postgresqlUsername`` and ``postgresql.postresqlPassword``, which were used in the previous version of the chart, are no longer used. + +Users will need to make those changes in their values files if they are changing the Postgres configuration. + +Previously the subchart version was ``10.5.3``. + +Default ``dags.gitSync.wait`` reduced to ``5`` seconds (#27625) +""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The default for ``dags.gitSync.wait`` has been reduced from ``60`` seconds to ``5`` seconds to reduce the likelihood of DAGs +becoming inconsistent between Airflow components. This will, however, increase traffic to the remote git repository. + +Default Airflow image is updated to ``2.5.1`` (#29074) +"""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The default Airflow image that is used with the Chart is now ``2.5.1``, previously it was ``2.4.1``. + +Default git-sync image is updated to ``3.6.3`` (#27848) +""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The default git-sync image that is used with the Chart is now ``3.6.3``, previously it was ``3.4.0``. + +Default redis image is updated to ``7-bullseye`` (#27443) +""""""""""""""""""""""""""""""""""""""""""""""""""""""""" + +The default redis image that is used with the Chart is now ``7-bullseye``, previously it was ``6-bullseye``. + +New Features +^^^^^^^^^^^^ + +- Add annotations on deployments (#28688) +- Add global volume & volumeMounts to the chart (#27781) + +Improvements +^^^^^^^^^^^^ + +- Add support for ``webserverConfigConfigMapName`` (#27419) +- Enhance chart to allow over-riding command-line args to statsd exporter (#28041) +- Add support for NodePort in Services (#26945) +- Add worker log-groomer-sidecar enable option (#27178) +- Add HostAliases to Pod template file (#27544) +- Allow PgBouncer replicas to be configurable (#27439) + +Bug Fixes +^^^^^^^^^ + +- Create scheduler service to serve task logs for LocalKubernetesExecutor (#28828) +- Fix NOTES.txt to show correct URL (#28264) +- Add worker service account for LocalKubernetesExecutor (#28813) +- Remove checks for 1.19 api checks (#28461) +- Add airflow_local_settings to all airflow containers (#27779) +- Make custom env vars optional for job templates (#27148) +- Decrease default gitSync wait (#27625) +- Add ``extraVolumeMounts`` to sidecars too (#27420) +- Fix PgBouncer after PostgreSQL subchart upgrade (#29207) + +Doc only changes +^^^^^^^^^^^^^^^^ + +- Enhance production guide with a few Argo specific guidelines (#29078) +- Add doc note about Pod template images (#29032) +- Update production guide db section (#28610) +- Fix to LoadBalancer snippet (#28014) +- Fix gitSync example code (#28083) +- Correct repo example for cloning via ssh (#27671) + +Misc +^^^^ + +- Update Airflow version to 2.5.1 (#29074) +- Update git-sync to 3.6.3 (#27848) +- Upgrade ``bitnami/postgresql`` subchart to 12.1.9 (#29071) +- Update redis to 7 (#27443) +- Replace helm chart icon (#27704) + Airflow Helm Chart 1.7.0 (2022-10-14) ------------------------------------- Significant Changes ^^^^^^^^^^^^^^^^^^^ -- Default Airflow image is updated to ``2.4.1`` +Default Airflow image is updated to ``2.4.1`` (#26485) +"""""""""""""""""""""""""""""""""""""""""""""""""""""" - The default Airflow image that is used with the Chart is now ``2.4.1``, previously it was ``2.3.2``. (#26485) +The default Airflow image that is used with the Chart is now ``2.4.1``, previously it was ``2.3.2``. New Features ^^^^^^^^^^^^ diff --git a/chart/newsfragments/27353.significant.rst b/chart/newsfragments/27353.significant.rst deleted file mode 100644 index 1a79768787c06..0000000000000 --- a/chart/newsfragments/27353.significant.rst +++ /dev/null @@ -1,21 +0,0 @@ -The helm chart is now using a newer version of bitnami/postgresql (from 10.5.3 to 12.1.9) - -The version of postgresql installed is still version 11. - -This version of the chart uses different variable names for setting usernames and passwords in the postgres database. - -- ``postgresql.auth.enablePostgresUser`` is used to determine if the "postgres" admin account will be created. -- ``postgresql.auth.postgresPassword`` sets the password for the "postgres" user. -- ``postgresql.auth.username`` and ``postrgesql.auth.password`` are used to set credentials for a non-admin account if desired. -- ``postgresql.postgresqlUsername`` and ``postgresql.postresqlPassword``, which were used in the previous version of the chart, are no longer used. - -Users will need to change these variable names in their values files if they are using the helm chart. - -If you are upgrading an existing helm release with the built-in postgres database, you will either need to delete your release and reinstall fresh, or manually delete these 2 objects: - -``` -kubectl delete secret {RELEASE_NAME}-postgresql -kubectl delete statefulset {RELEASE_NAME}-postgresql -``` - -As a reminder, it is recommended to `set up an external database `_ in production. diff --git a/chart/newsfragments/27625.significant.rst b/chart/newsfragments/27625.significant.rst deleted file mode 100644 index 2fe472459e3ee..0000000000000 --- a/chart/newsfragments/27625.significant.rst +++ /dev/null @@ -1,4 +0,0 @@ -Default ``dags.gitSync.wait`` reduced to ``5`` seconds - -The default for ``dags.gitSync.wait`` has been reduced from ``60`` seconds to ``5`` seconds to reduce the likelihood of DAGs -becoming inconsistent between Airflow components. This will, however, increase traffic to the remote git repository. diff --git a/chart/newsfragments/29074.significant.rst b/chart/newsfragments/29074.significant.rst deleted file mode 100644 index 64c855a5edfb4..0000000000000 --- a/chart/newsfragments/29074.significant.rst +++ /dev/null @@ -1,3 +0,0 @@ -Default Airflow image is updated to ``2.5.1`` - -The default Airflow image that is used with the Chart is now ``2.5.1``, previously it was ``2.4.1``. diff --git a/newsfragments/27698.significant.rst b/newsfragments/27698.significant.rst deleted file mode 100644 index f55ab850acae3..0000000000000 --- a/newsfragments/27698.significant.rst +++ /dev/null @@ -1 +0,0 @@ -Use git-sync 3.6.3. From 13283a8153731cb654c889ab0f138dfd74a41db9 Mon Sep 17 00:00:00 2001 From: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com> Date: Tue, 31 Jan 2023 10:16:49 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Ephraim Anierobi --- chart/Chart.yaml | 2 +- chart/RELEASE_NOTES.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/chart/Chart.yaml b/chart/Chart.yaml index 8825df3549720..ba5c27f09b4ad 100644 --- a/chart/Chart.yaml +++ b/chart/Chart.yaml @@ -82,7 +82,7 @@ annotations: links: - name: '#27419' url: https://github.com/apache/airflow/pull/27419 - - description: Enhance chart to allow over-riding command-line args to statsd exporter + - description: Enhance chart to allow overriding command-line args to statsd exporter kind: changed links: - name: '#28041' diff --git a/chart/RELEASE_NOTES.rst b/chart/RELEASE_NOTES.rst index ded8336fcb9a1..37f4ca375b100 100644 --- a/chart/RELEASE_NOTES.rst +++ b/chart/RELEASE_NOTES.rst @@ -85,7 +85,7 @@ Improvements ^^^^^^^^^^^^ - Add support for ``webserverConfigConfigMapName`` (#27419) -- Enhance chart to allow over-riding command-line args to statsd exporter (#28041) +- Enhance chart to allow overriding command-line args to statsd exporter (#28041) - Add support for NodePort in Services (#26945) - Add worker log-groomer-sidecar enable option (#27178) - Add HostAliases to Pod template file (#27544)