Improve consistency of values.yaml & misc#64559
Conversation
jscheffl
left a comment
There was a problem hiding this comment.
Wow, impressive rework! Thanks!
bugraoz93
left a comment
There was a problem hiding this comment.
Thanks, Przemysław! Agree with Jens, impressive :D
80fb0c7 to
329bf02
Compare
There was a problem hiding this comment.
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.yamlcomments for consistency (descriptions above fields, examples below, standardized deprecation notes). - Tweaked
airflow.cfgrendering in the ConfigMap template to add spacing between sections. - Added a missing
default: nullforworkers.celery.priorityClassNamein 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. |
* Revert comments order to be consistent * Add default value for workers.celery.priorityClassName * Make values.yaml more consistent * New line between sections in config * Captialize some first letters & clean some comments * Fix params & clarify comment * Add missed pdb (cherry picked from commit c707a8a) Co-authored-by: Przemysław Mirowski <17602603+Miretpl@users.noreply.github.com>
Backport successfully created: chart/v1-2x-testNote: As of Merging PRs targeted for Airflow 3.X In matter of doubt please ask in #release-management Slack channel.
|
…64559) * Revert comments order to be consistent * Add default value for workers.celery.priorityClassName * Make values.yaml more consistent * New line between sections in config * Captialize some first letters & clean some comments * Fix params & clarify comment * Add missed pdb (cherry picked from commit c707a8a) Co-authored-by: Przemysław Mirowski <17602603+Miretpl@users.noreply.github.com>
…#64664) * Revert comments order to be consistent * Add default value for workers.celery.priorityClassName * Make values.yaml more consistent * New line between sections in config * Captialize some first letters & clean some comments * Fix params & clarify comment * Add missed pdb (cherry picked from commit c707a8a) Co-authored-by: Przemysław Mirowski <17602603+Miretpl@users.noreply.github.com>
The goal of this PR is to make Helm's
values.yamlfile more consistent in structure + some comments were rewritten to be clearer for users. After this PR, comments invalues.yamlfile are:Furthermore, the smaller changes were added to this PR, like:
workers.celery.priorityClassNamein thevalues.schema.jsonfileworkers.hostAliasessecurityContextdeprecations + forwebserverSecretAnnotationsWas generative AI tooling used to co-author this PR?
{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.