Skip to content

Fix config templates type #50792

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

Merged
pierrejeambrun merged 1 commit into from
May 27, 2025
Merged

Fix config templates type #50792

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions airflow-core/src/airflow/config_templates/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ core:
schedulers in your cluster, is the maximum number of task instances with the running
state in the metadata database. The value must be larger or equal 1.
version_added: ~
type: string
type: integer
example: ~
default: "32"
max_active_tasks_per_dag:
Expand All @@ -129,7 +129,7 @@ core:
An example scenario when this would be useful is when you want to stop a new dag with an early
start date from stealing all the executor slots in a cluster.
version_added: 2.2.0
type: string
type: integer
example: ~
default: "16"
dags_are_paused_at_creation:
Expand All @@ -145,7 +145,7 @@ core:
if it reaches the limit. This is configurable at the DAG level with ``max_active_runs``,
which is defaulted as ``[core] max_active_runs_per_dag``.
version_added: ~
type: string
type: integer
example: ~
default: "16"
max_consecutive_failed_dag_runs_per_dag:
Expand All @@ -156,7 +156,7 @@ core:
If not specified, then the value is considered as 0,
meaning that the dags are never paused out by default.
version_added: 2.9.0
type: string
type: integer
example: ~
default: "0"
mp_start_method:
Expand Down Expand Up @@ -274,7 +274,7 @@ core:
When a task is killed forcefully, this is the amount of time in seconds that
it has to cleanup after it is sent a SIGTERM, before it is SIGKILLED
version_added: ~
type: string
type: integer
example: ~
default: "60"
dag_run_conf_overrides_params:
Expand Down Expand Up @@ -307,7 +307,7 @@ core:
description: |
The number of retries each task is going to have by default. Can be overridden at dag or task level.
version_added: 1.10.6
type: string
type: integer
example: ~
default: "0"
default_task_retry_delay:
Expand Down Expand Up @@ -354,7 +354,7 @@ core:
description: |
Updating serialized DAG can not be faster than a minimum interval to reduce database write rate.
version_added: 1.10.7
type: string
type: integer
example: ~
default: "30"
compress_serialized_dags:
Expand All @@ -365,15 +365,15 @@ core:

This will disable the DAG dependencies view
version_added: 2.3.0
type: string
type: boolean
example: ~
default: "False"
min_serialized_dag_fetch_interval:
description: |
Fetching serialized DAG can not be faster than a minimum interval to reduce database
read rate. This config controls when your DAGs are updated in the Webserver
version_added: 1.10.12
type: string
type: integer
example: ~
default: "10"
max_num_rendered_ti_fields_per_task:
Expand Down Expand Up @@ -437,7 +437,7 @@ core:
deployment where the ``default_pool`` is already created. For existing deployments, users can
change the number of slots using Webserver, API or the CLI
version_added: 2.2.0
type: string
type: integer
example: ~
default: "128"
max_map_length:
Expand Down Expand Up @@ -572,7 +572,7 @@ database:
The SQLAlchemy pool size is the maximum number of database connections
in the pool. 0 indicates no limit.
version_added: 2.3.0
type: string
type: integer
example: ~
default: "5"
sql_alchemy_max_overflow:
Expand All @@ -587,7 +587,7 @@ database:
max_overflow can be set to ``-1`` to indicate no overflow limit;
no limit will be placed on the total number of concurrent connections. Defaults to ``10``.
version_added: 2.3.0
type: string
type: integer
example: ~
default: "10"
sql_alchemy_pool_recycle:
Expand All @@ -597,7 +597,7 @@ database:
not apply to sqlite. If the number of DB connections is ever exceeded,
a lower config value will allow the system to recover faster.
version_added: 2.3.0
type: string
type: integer
example: ~
default: "1800"
sql_alchemy_pool_pre_ping:
Expand All @@ -608,7 +608,7 @@ database:
<https://docs.sqlalchemy.org/en/14/core/pooling.html#disconnect-handling-pessimistic>`__
for more details.
version_added: 2.3.0
type: string
type: boolean
example: ~
default: "True"
sql_alchemy_schema:
Expand Down Expand Up @@ -1029,7 +1029,7 @@ metrics:
description: |
Enables sending metrics to StatsD.
version_added: 2.0.0
type: string
type: boolean
example: ~
default: "False"
statsd_host:
Expand All @@ -1043,14 +1043,14 @@ metrics:
description: |
Enables the statsd host to be resolved into IPv6 address
version_added: 3.0.0
type: string
type: boolean
example: ~
default: "False"
statsd_port:
description: |
Specifies the port on which the StatsD daemon (or server) is listening to
version_added: 2.0.0
type: string
type: integer
example: ~
default: "8125"
statsd_prefix:
Expand Down Expand Up @@ -1078,7 +1078,7 @@ metrics:
description: |
To enable datadog integration to send airflow metrics.
version_added: 2.0.0
type: string
type: boolean
example: ~
default: "False"
statsd_datadog_tags:
Expand Down Expand Up @@ -1126,7 +1126,7 @@ metrics:
description: |
Enables sending metrics to OpenTelemetry.
version_added: 2.6.0
type: string
type: boolean
example: ~
default: "False"
otel_host:
Expand All @@ -1141,7 +1141,7 @@ metrics:
description: |
Specifies the port of the OpenTelemetry Collector that is listening to.
version_added: 2.6.0
type: string
type: integer
example: ~
default: "8889"
otel_prefix:
Expand All @@ -1163,7 +1163,7 @@ metrics:
description: |
If ``True``, all metrics are also emitted to the console. Defaults to ``False``.
version_added: 2.7.0
type: string
type: boolean
example: ~
default: "False"
otel_service:
Expand All @@ -1180,7 +1180,7 @@ metrics:
you need to configure the SSL certificate and key within the OpenTelemetry collector's
``config.yml`` file.
version_added: 2.7.0
type: string
type: boolean
example: ~
default: "False"
traces:
Expand All @@ -1191,7 +1191,7 @@ traces:
description: |
Enables sending traces to OpenTelemetry.
version_added: 2.10.0
type: string
type: boolean
example: ~
default: "False"
otel_host:
Expand All @@ -1206,7 +1206,7 @@ traces:
description: |
Specifies the port of the OpenTelemetry Collector that is listening to.
version_added: 2.10.0
type: string
type: integer
example: ~
default: "8889"
otel_service:
Expand All @@ -1220,7 +1220,7 @@ traces:
description: |
If True, all traces are also emitted to the console. Defaults to False.
version_added: 2.10.0
type: string
type: boolean
example: ~
default: "False"
otel_ssl_active:
Expand All @@ -1230,7 +1230,7 @@ traces:
you need to configure the SSL certificate and key within the OpenTelemetry collector's
config.yml file.
version_added: 2.10.0
type: string
type: boolean
example: ~
default: "False"
secrets:
Expand Down Expand Up @@ -1348,14 +1348,14 @@ api:
description: |
Number of workers to run on the API server
version_added: ~
type: string
type: integer
example: ~
default: "4"
worker_timeout:
description: |
Number of seconds the API server waits before timing out on a worker
version_added: ~
type: string
type: integer
example: ~
default: "120"
access_logfile:
Expand Down Expand Up @@ -1453,14 +1453,14 @@ api:
By default, the webserver shows paused DAGs. Flip this to hide paused
DAGs by default
version_added: ~
type: string
type: boolean
example: ~
default: "False"
page_size:
description: |
Consistent page size across all listing views in the UI
version_added: ~
type: string
type: integer
example: ~
default: "50"
default_wrap:
Expand Down Expand Up @@ -1863,21 +1863,21 @@ smtp:
description: |
Determines whether to use the STARTTLS command when connecting to the SMTP server.
version_added: ~
type: string
type: boolean
example: ~
default: "True"
smtp_ssl:
description: |
Determines whether to use an SSL connection when talking to the SMTP server.
version_added: ~
type: string
type: boolean
example: ~
default: "False"
smtp_port:
description: |
Defines the port number on which Airflow connects to the SMTP server to send email notifications.
version_added: ~
type: string
type: integer
example: ~
default: "25"
smtp_mail_from:
Expand Down Expand Up @@ -1914,7 +1914,7 @@ sentry:
sentry_on:
description: Enable error reporting to Sentry
version_added: 2.0.0
type: string
type: boolean
example: ~
default: "false"
sentry_dsn:
Expand Down Expand Up @@ -2225,7 +2225,7 @@ triggerer:
description: |
How many triggers a single Triggerer will run at once, by default.
version_added: 2.2.0
type: string
type: integer
example: ~
default: "1000"
job_heartbeat_sec:
Expand Down Expand Up @@ -2420,7 +2420,7 @@ dag_processor:
description: |
How long before timing out a DagFileProcessor, which processes a dag file
version_added: ~
type: string
type: integer
example: ~
default: "50"
print_stats_interval:
Expand Down