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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 6 commits into from
Dec 19, 2023
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
05bfc1a
Added functionality to automatically ingest custom airflow.cfg file u…
dominikhei Dec 18, 2023
2cc0b2f
Adjusted the docker-compose.yml to use AIRFLOW_CONFIG, removed unused…
dominikhei Dec 19, 2023
26ef9e4
corrected spelling mistake
dominikhei Dec 19, 2023
e51be0a
Adjusted documentation
dominikhei Dec 19, 2023
9a09fb8
Apply suggestions from code review
Taragolis Dec 19, 2023
7cd0f9d
Apply suggestions from code review
Taragolis Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/apache-airflow/howto/docker-compose/docker-compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ x-airflow-common:
AIRFLOW__CORE__DAGS_ARE_PAUSED_AT_CREATION: 'true'
AIRFLOW__CORE__LOAD_EXAMPLES: 'true'
AIRFLOW__API__AUTH_BACKENDS: 'airflow.api.auth.backend.basic_auth,airflow.api.auth.backend.session'
TEST:
Taragolis marked this conversation as resolved.
Show resolved Hide resolved
# yamllint disable rule:line-length
# Use simple http server on scheduler for health checks
# See https://airflow.apache.org/docs/apache-airflow/stable/administration-and-deployment/logging-monitoring/check-health.html#scheduler-health-check-server
Expand All @@ -74,6 +75,10 @@ x-airflow-common:
- ${AIRFLOW_PROJ_DIR:-.}/logs:/opt/airflow/logs
- ${AIRFLOW_PROJ_DIR:-.}/config:/opt/airflow/config
- ${AIRFLOW_PROJ_DIR:-.}/plugins:/opt/airflow/plugins
#The following line can be used to use a custom airflow.cfg, stored in the AIRFLOW_PROJ_DIR
#Uncomment the following line to make use of this
#- ${AIRFLOW_PROJ_DIR:-.}/airflow.cfg:/opt/airflow/airflow.cfg

potiuk marked this conversation as resolved.
Show resolved Hide resolved
Taragolis marked this conversation as resolved.
Show resolved Hide resolved
user: "${AIRFLOW_UID:-50000}:0"
depends_on:
&airflow-common-depends-on
Expand Down
10 changes: 10 additions & 0 deletions docs/apache-airflow/howto/docker-compose/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,16 @@ that conflicts with the version of apache-airflow that you are using.
Run ``docker compose build`` to build the image, or add ``--build`` flag to ``docker compose up`` or
``docker compose run`` commands to build the image automatically as needed.

Special case - Adding a custom config file
==========================================

If you have a custom config file and wish to use it in your Airflow instance, you need to perform the following steps:

1) Remove comment from the ``- ${AIRFLOW_PROJ_DIR:-.}/airflow.cfg:/opt/airflow/airflow.cfg`` line
in the ``docker-compose.yaml`` file.

2) Place your custom ``airflow.cfg`` file in the same folder as the ``docker-compose.yaml`` file.

Networking
==========

Expand Down