Skip to content

Latest commit

 

History

History
101 lines (73 loc) · 3.42 KB

configurations-ref.rst

File metadata and controls

101 lines (73 loc) · 3.42 KB

Configuration Reference

This page contains the list of all the available Airflow configurations that you can set in airflow.cfg file or using environment variables.

Use the same configuration across all the Airflow components. While each component does not require all, some configurations need to be same otherwise they would not work as expected. A good example for that is secret_key<config:webserver__secret_key> which should be same on the Webserver and Worker to allow Webserver to fetch logs from Worker.

Note

For more information on setting the configuration, see howto/set-config

Sections:

config_ctx

{% for section in configs %}

[{{ section["name"] }}] {{ "=" * (section["name"]|length + 2) }}

{% if section["description"] %} {{ section["description"] }} {% endif %}

{% for option in section["options"] %}

{{ option["name"] }} {{ "-" * option["name"]|length }}

{% if option["version_added"] %} .. versionadded:: {{ option["version_added"] }} {% endif %}

{% if option["description"] %} {{ option["description"] }} {% endif %}

{% if option.get("see_also") %} .. seealso:: {{ option["see_also"] }} {% endif %}

Type

{{ option["type"] }}

Default

{{ "''" if option["default"] == "" else option["default"] }}

{% if option.get("sensitive") %} :Environment Variables: AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }}

AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }}_CMD

AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }}_SECRET

{% else %} :Environment Variable: AIRFLOW__{{ section["name"] | upper }}__{{ option["name"] | upper }} {% endif %} {% if option["example"] %} :Example: {{ option["example"] }} {% endif %}

{% endfor %}

{% if section["name"] in deprecated_options %}

{% for deprecated_option_name, (new_section_name, new_option_name, since_version) in deprecated_options[section["name"]].items() %} .. _config:{{ section["name"] }}__{{ deprecated_option_name }}:

{{ deprecated_option_name }} (Deprecated) {{ "-" * (deprecated_option_name + " (Deprecated)")|length }}

{{ since_version }} The option has been moved to {{ new_section_name }}.{{ new_option_name }} <config:{{ new_section_name }}__{{ new_option_name }}>

{% endfor %} {% endif %}

{% endfor %}