Skip to content

Helm Chart Documentation Update#66970

Open
Miretpl wants to merge 9 commits into
apache:mainfrom
Miretpl:update-doc
Open

Helm Chart Documentation Update#66970
Miretpl wants to merge 9 commits into
apache:mainfrom
Miretpl:update-doc

Conversation

@Miretpl
Copy link
Copy Markdown
Contributor

@Miretpl Miretpl commented May 14, 2026

Update of Helm Chart documentation, which consists of:

  1. Parametrisation of min kubernetes and current helm chart versions in the doc
  2. Update doc due to the finished separation of workers to workers.celery/workers.kubernetes sections
  3. Update the minimum supported Helm version to match our current CI
  4. Update all minimum versions of providers to match currently supported minimum Airflow version
  5. Filter out deprecated parameters from Parameters documentation and add new Deprecated Parameters section
  6. Automatic generation of resources-related doc
  7. Updates to Upgrading to Airflow 3 doc (mostly to not recommend users to use Helm Chart version with a lot of bugs which were fixed in later versions)
  8. Misc

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.

@Miretpl
Copy link
Copy Markdown
Contributor Author

Miretpl commented May 14, 2026

Also goes for 1.2x line.

Newsfragment - I'm not sure if it should be added here (to main) or in backport PR. I was also wondering if it should be added, but I think that it would be good for users to know (in one way or the other) that we do not know if the chart will render properly on lower versions than min in our CI.

@Miretpl Miretpl marked this pull request as ready for review May 14, 2026 22:09
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.

Cool! Just found 1 typo

Comment thread chart/docs/index.rst

.. note::

Due to security concerts, it is not advised to set sensitive values like passwords within the ``values.yaml``.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Typo

Suggested change
Due to security concerts, it is not advised to set sensitive values like passwords within the ``values.yaml``.
Due to security concerns, it is not advised to set sensitive values like passwords within the ``values.yaml``.


Chart ``1.17.0`` raised the minimum supported Kubernetes version to ``1.30``. Upgrade your cluster before upgrading
the chart if needed.
Chart ``1.19.0`` supports ``1.30+`` Kubernetes version. Upgrade your cluster before upgrading the chart if needed.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Adding Jinja constants here as well?

Comment thread chart/docs/index.rst
.. jinja:: global_ctx

- Kubernetes {{ min_k8s_version }}+ cluster
- Helm 3.19+
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we make Helm version also a Jinja value?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants