Skip to content

Conversation

@sarah-reddit
Copy link
Contributor

This adds annotations to the following secret objects:

  • ElasticSearch
  • FernetKey
  • Flower
  • Metadata Connection
  • PgBouncer Certificates
  • PgBouncer Config
  • PgBouncer Stats
  • Redis Password
  • Redis Broker Url
  • Result Backend Connection
  • Webserver Secret Key

Motivation:
Our deploy tool by default versions secrets. This forces us to fork this helm chart and modify it to adding annotations to disable versioning. This would take us a step closer to not having to do that anymore. (Relevant: #29910)

This PR was mostly inspired by #33340.


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

@boring-cyborg boring-cyborg bot added the area:helm-chart Airflow Helm Chart label Apr 7, 2025
@boring-cyborg
Copy link

boring-cyborg bot commented Apr 7, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@sarah-reddit sarah-reddit force-pushed the add-secret-annotations branch from 4ab47fc to 8a742e6 Compare April 7, 2025 17:54
@sarah-reddit sarah-reddit marked this pull request as ready for review April 7, 2025 17:55
@sarah-reddit sarah-reddit force-pushed the add-secret-annotations branch from 8a742e6 to 6543090 Compare April 8, 2025 15:23
@sarah-reddit sarah-reddit force-pushed the add-secret-annotations branch from 6543090 to 05bb474 Compare April 10, 2025 16:12
@sarah-reddit
Copy link
Contributor Author

sarah-reddit commented Apr 21, 2025

@potiuk approved running CI a few days ago, it seems like there was an error in generating requirements.txt: https://github.com/apache/airflow/actions/runs/14385261556/job/40784592715

But AFAIK that should be unrelated to the helm chart? Since I didn't add any dependencies.

I tried rebasing off of main to see if that would help (if it was an unrelated error that has since been fixed). But if you think this might be related to my PR and I need to investigate more, please let me know! Thank you!

@sarah-reddit
Copy link
Contributor Author

It seems like all the checks pass now! @dstandish @jedcunningham @hussein-awala would you be up for reviewing this soon?

@sarah-reddit
Copy link
Contributor Author

It seems like all the checks pass now! @dstandish @jedcunningham @hussein-awala would you be up for reviewing this soon?

Hello! I was wondering if I might be able to get feedback on this soon? Thank you!

Copy link
Contributor

@SamWheating SamWheating left a comment

Choose a reason for hiding this comment

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

Alternatively - thoughts on just adding a common AirflowSecretsAnnotations value which is added to all secrets? Something similar is already supported for pods:

airflow/chart/values.yaml

Lines 290 to 292 in 4789fc2

# Extra annotations to apply to all
# Airflow pods
airflowPodAnnotations: {}

Will let the maintainers weigh in here with their best practices.

@sarah-reddit
Copy link
Contributor Author

Alternatively - thoughts on just adding a common AirflowSecretsAnnotations value which is added to all secrets? Something similar is already supported for pods:

airflow/chart/values.yaml

Lines 290 to 292 in 4789fc2

# Extra annotations to apply to all
# Airflow pods
airflowPodAnnotations: {}

Will let the maintainers weigh in here with their best practices.

We could! I thought that maybe people would want to add different annotations to different secrets. But for our use case, we want to add the same annotation to them all (turning off versioning in our deploy tool), so I'm okay with either approach. I'll defer to the maintainers.

@jedcunningham
Copy link
Member

Alternatively - thoughts on just adding a common AirflowSecretsAnnotations value which is added to all secrets? Something similar is already supported for pods:

airflow/chart/values.yaml

Lines 290 to 292 in 4789fc2

# Extra annotations to apply to all
# Airflow pods
airflowPodAnnotations: {}

Will let the maintainers weigh in here with their best practices.

Happy to take a PR for that as well :)

@jedcunningham jedcunningham merged commit 0812f3f into apache:main May 23, 2025
65 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented May 23, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@jedcunningham
Copy link
Member

Thanks @sarah-reddit! Congrats on your first PR 🎉!

dadonnelly316 pushed a commit to dadonnelly316/airflow that referenced this pull request May 26, 2025
@sarah-reddit
Copy link
Contributor Author

@jedcunningham Thanks so much for your review! Very exciting! :)

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants