-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Description
What do you see as an issue?
Currently, the official Airflow Docker image explicitly sets the environment variable AIRFLOW__CORE__LOAD_EXAMPLES to false by default.
Line 2052 in 0d07c70
| AIRFLOW__CORE__LOAD_EXAMPLES="false" \ |
While the Configuration Reference mentions that the default value for load_examples is True, it doesn't mention that this is overridden in the official image. This can be confusing for users who expect example DAGs to be present when they first run the official image but find them missing.
airflow/airflow-core/src/airflow/config_templates/config.yml
Lines 173 to 181 in 0d07c70
| load_examples: | |
| description: | | |
| Whether to load the DAG examples that ship with Airflow. It's good to | |
| get started, but you probably want to set this to ``False`` in a production | |
| environment | |
| version_added: ~ | |
| type: string | |
| example: ~ | |
| default: "True" |
Proposed Change
I suggest adding a note to the load_examples section in the documentation to inform users about this behavior in the official image.
Suggested addition to the docs:
Note: If you are using the Official Airflow Docker Image, this value is set to
Falseby default via the environment variableAIRFLOW__CORE__LOAD_EXAMPLES. To enable example DAGs when using the official image, you must explicitly setAIRFLOW__CORE__LOAD_EXAMPLES=Truein your environment.
Solving the problem
No response
Anything else
No response
Are you willing to submit PR?
- Yes I am willing to submit a PR!
Code of Conduct
- I agree to follow this project's Code of Conduct