Skip to content

Improve consistency of values.yaml & misc#64559

Open
Miretpl wants to merge 5 commits intoapache:mainfrom
Miretpl:misc
Open

Improve consistency of values.yaml & misc#64559
Miretpl wants to merge 5 commits intoapache:mainfrom
Miretpl:misc

Conversation

@Miretpl
Copy link
Copy Markdown
Contributor

@Miretpl Miretpl commented Mar 31, 2026

The goal of this PR is to make Helm's values.yaml file more consistent in structure + some comments were rewritten to be clearer for users. After this PR, comments in values.yaml file are:

  1. If it is a field description, it is over the field
  2. If it is an example, it is under the field
  3. One format for deprecation comments

Furthermore, the smaller changes were added to this PR, like:

  1. Make sections in the airflow config file in the ConfigMap, separated by a new line
  2. Add a missing default value for workers.celery.priorityClassName in the values.schema.json file
  3. Fix wrong deprecation comment next to workers.hostAliases
  4. Add missing securityContext deprecations + for webserverSecretAnnotations

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

  • Read the Pull Request Guidelines for more information. Note: commit author/co-author name and email in commits become permanently public when merged.
  • For fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

@boring-cyborg boring-cyborg bot added the area:helm-chart Airflow Helm Chart label Mar 31, 2026
@Miretpl Miretpl marked this pull request as ready for review April 1, 2026 16:09
@Miretpl Miretpl changed the title Make values.yaml more consistent & misc Improve consistency of values.yaml & misc Apr 1, 2026
Copy link
Copy Markdown
Contributor

@jscheffl jscheffl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, impressive rework! Thanks!

@jscheffl jscheffl added the backport-to-chart/v1-2x-test Automatic backport to chart 1.2x maintenance branch label Apr 1, 2026
Copy link
Copy Markdown
Contributor

@bugraoz93 bugraoz93 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Przemysław! Agree with Jens, impressive :D

@potiuk potiuk added the ready for maintainer review Set after triaging when all criteria pass. label Apr 1, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refactors the Helm chart configuration documentation to make values.yaml structure and commenting more consistent, and includes a few small functional/schema tweaks to align defaults and improve generated airflow.cfg formatting.

Changes:

  • Reorganized and rewrote many chart/values.yaml comments for consistency (descriptions above fields, examples below, standardized deprecation notes).
  • Tweaked airflow.cfg rendering in the ConfigMap template to add spacing between sections.
  • Added a missing default: null for workers.celery.priorityClassName in the JSON schema.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 3 comments.

File Description
chart/values.yaml Large-scale comment/documentation consistency updates plus a few clarified deprecation notes/examples.
chart/values.schema.json Adds an explicit default for priorityClassName to match chart defaults/intent.
chart/templates/configmaps/configmap.yaml Adjusts whitespace trimming to separate rendered airflow.cfg sections with a blank line.

# The secret name should follow naming convention of the application where resources are
# name {{ .Release-name }}-<POSTFIX>. In case of the keytab file, the postfix is "kerberos-keytab"
# So if your release is named "my-release" the name of the secret should be "my-release-kerberos-keytab"
# name '{{ .Release-name }}-<postfix>'. In case of the keytab file, the '<postfix>' is "kerberos-keytab".
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Helm template reference in this example is invalid: .Release-name is not a valid field. This should use .Release.Name (and keep naming consistent with other chart examples).

Copilot uses AI. Check for mistakes.
# kubectl create secret generic {{ .Release.name }}-kerberos-keytab --from-file=kerberos.keytab
#
# If you have keytab file you can do it with similar:
# kubectl create secret generic {{ .Release.name }}-kerberos-keytab --from-file=kerberos.keytab
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example uses .Release.name, which is not a valid Helm template field (Helm uses .Release.Name). As written, users copy/pasting this will get template rendering errors.

Copilot uses AI. Check for mistakes.
Comment on lines +3807 to +3808
# This is automatically generated from `.Values.dagProcessor.dagBundleConfigList` using the `dag_bundle_config_list` helper function.
# Direct override is only possible via `dagProcessor.dagBundleConfigList` configuration
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The comment says direct override is only possible via dagProcessor.dagBundleConfigList, but config.dag_processor.dag_bundle_config_list can still be overridden directly in user-supplied values (since config is rendered into airflow.cfg). Please adjust the wording to avoid misleading users (e.g., describe it as generated by default and recommend using dagProcessor.dagBundleConfigList).

Suggested change
# This is automatically generated from `.Values.dagProcessor.dagBundleConfigList` using the `dag_bundle_config_list` helper function.
# Direct override is only possible via `dagProcessor.dagBundleConfigList` configuration
# This value is generated by default from `.Values.dagProcessor.dagBundleConfigList` using the `dag_bundle_config_list` helper function.
# It is recommended to configure this via `dagProcessor.dagBundleConfigList` rather than overriding `config.dag_processor.dag_bundle_config_list` directly.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:helm-chart Airflow Helm Chart backport-to-chart/v1-2x-test Automatic backport to chart 1.2x maintenance branch ready for maintainer review Set after triaging when all criteria pass.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants