Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added functionality to automatically ingest custom airflow.cfg file upon startup #36289

Merged
merged 6 commits into from Dec 19, 2023

Conversation

dominikhei
Copy link
Contributor

closes: #35812

I have made the necessary changes to the docker-compose.yaml file as proposed within the issue. The relevant line is currently outcommented, but the documentation in the index.rst and comments above the outcommented line tell users
what to do. If one deletes the comment, an airflow.cfg file within ${AIRFLOW_PROJ_DIR:-.} is now added to /opt/airflow/airflow.cfgwithin the containers, once docker compose uphas been executed. The new line also should make it clear where the airflow.cfg is stored in the containers, as brought up by the issue.

As mentioned, I also added documentation for the changes in the index.rst file, such that users know how to automatically ingest their own airflow.cfg upon startup.

@potiuk Can you maybe have a look at this, since you also approved the original issue?

If I should change anything please let me know :)


^ 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 newsfragments.

Copy link

boring-cyborg bot commented Dec 18, 2023

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 Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.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

…pon startup and the associated documentation
@dominikhei dominikhei force-pushed the add-local-airflowcfg-automatically branch from e4743c6 to 05bfc1a Compare December 18, 2023 20:39
Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

Looks cool.

Copy link
Contributor

@Taragolis Taragolis left a comment

Choose a reason for hiding this comment

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

  • Redundant whitespaces / newlines
  • Missing whitespaces in the beginning of the comment (needs for pass statics checks)

@potiuk potiuk merged commit 36cb20a into apache:main Dec 19, 2023
51 checks passed
Copy link

boring-cyborg bot commented Dec 19, 2023

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

@ephraimbuddy ephraimbuddy added this to the Airflow 2.9.0 milestone Jan 10, 2024
@ephraimbuddy ephraimbuddy added the type:new-feature Changelog: New Features label Jan 10, 2024
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.

Add path to airflow.cfg in docker-compose.yml
4 participants