From b0d62f28343fed6a989558f0c26dc1ae83fcbdc0 Mon Sep 17 00:00:00 2001 From: Kaxil Naik Date: Tue, 4 Feb 2020 00:23:04 +0530 Subject: [PATCH] [AIRFLOW-XXXX] Add versions_added field to configs --- airflow/config_templates/config.yml | 144 ++++++++++++++-------------- 1 file changed, 72 insertions(+), 72 deletions(-) diff --git a/airflow/config_templates/config.yml b/airflow/config_templates/config.yml index 8d7f0b8e20857d..201701eb43d30d 100644 --- a/airflow/config_templates/config.yml +++ b/airflow/config_templates/config.yml @@ -91,14 +91,14 @@ description: | Flag to enable/disable Colored logs in Console Colour the logs when the controlling terminal is a TTY. - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "True" - name: colored_log_format description: | Log format for when Colored logs is enabled - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: >- @@ -106,7 +106,7 @@ %%(log_color)s%%(levelname)s%%(reset)s - %%(log_color)s%%(message)s%%(reset)s - name: colored_formatter_class description: ~ - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "airflow.utils.log.colored_log.CustomTTYColoredFormatter" @@ -138,7 +138,7 @@ default: "{{{{ filename }}}}.log" - name: dag_processor_manager_log_location description: ~ - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "{AIRFLOW_HOME}/logs/dag_processor_manager/dag_processor_manager.log" @@ -192,7 +192,7 @@ - name: sql_engine_encoding description: | The encoding for the databases - version_added: ~ + version_added: 1.10.1 type: string example: ~ default: "utf-8" @@ -222,7 +222,7 @@ and the total number of "sleeping" connections the pool will allow is pool_size. 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: ~ + version_added: 1.10.4 type: string example: ~ default: "10" @@ -242,7 +242,7 @@ Typically, this is a simple statement like "SELECT 1". More information here: https://docs.sqlalchemy.org/en/13/core/pooling.html#disconnect-handling-pessimistic - version_added: ~ + version_added: 1.10.6 type: string example: ~ default: "True" @@ -250,7 +250,7 @@ description: | The schema to use for the metadata database. SqlAlchemy supports databases with the concept of multiple schemas. - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "" @@ -324,7 +324,7 @@ - name: dag_file_processor_timeout description: | How long before timing out a DagFileProcessor, which processes a dag file - version_added: ~ + version_added: 1.10.6 type: string example: ~ default: "50" @@ -394,21 +394,21 @@ - name: worker_precheck description: | Worker initialisation check to validate Metadata Database connection - version_added: ~ + version_added: 1.10.1 type: string example: ~ default: "False" - name: dag_discovery_safe_mode description: | When discovering DAGs, ignore any files that don't contain the strings ``DAG`` and ``airflow``. - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "True" - name: default_task_retries description: | The number of retries each task is going to have by default. Can be overridden at dag or task level. - version_added: ~ + version_added: 1.10.6 type: string example: ~ default: "0" @@ -431,7 +431,7 @@ - name: check_slas description: | On each dagrun check against defined SLAs - version_added: ~ + version_added: 1.10.8 type: string example: ~ default: "True" @@ -463,7 +463,7 @@ description: | Used only with DebugExecutor. If set to True DAG will fail with first failed task. Helpful for debugging purposes. - version_added: ~ + version_added: 1.10.8 type: string example: ~ default: "False" @@ -684,14 +684,14 @@ - name: expose_hostname description: | Expose hostname in the web server - version_added: ~ + version_added: 1.10.8 type: string example: ~ default: "True" - name: expose_stacktrace description: | Expose stacktrace in the web server - version_added: ~ + version_added: 1.10.8 type: string example: ~ default: "True" @@ -756,21 +756,21 @@ - name: log_fetch_delay_sec description: | Time interval (in secs) to wait before next log fetching. - version_added: ~ + version_added: 1.10.8 type: int example: ~ default: "2" - name: log_auto_tailing_offset description: | Distance away from page bottom to enable auto tailing. - version_added: ~ + version_added: 1.10.8 type: int example: ~ default: "30" - name: log_animation_speed description: | Animation speed for auto tailing log display. - version_added: ~ + version_added: 1.10.8 type: int example: ~ default: "1000" @@ -813,7 +813,7 @@ - name: enable_proxy_fix description: | Enable werkzeug ``ProxyFix`` middleware for reverse proxy - version_added: ~ + version_added: 1.10.1 type: boolean example: ~ default: "False" @@ -856,28 +856,28 @@ - name: cookie_secure description: | Set secure flag on session cookie - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "False" - name: cookie_samesite description: | Set samesite policy on session cookie - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "" - name: default_wrap description: | Default setting for wrap toggle on DAG code and TI log views. - version_added: ~ + version_added: 1.10.4 type: boolean example: ~ default: "False" - name: x_frame_enabled description: | Allow the UI to be rendered in a frame - version_added: ~ + version_added: 1.10.8 type: boolean example: ~ default: "True" @@ -892,7 +892,7 @@ - name: analytics_id description: | Unique ID of your account in the analytics tool - version_added: ~ + version_added: 1.10.5 type: string example: ~ default: ~ @@ -900,7 +900,7 @@ description: | Update FAB permissions and sync security manager roles on webserver startup - version_added: ~ + version_added: 1.10.7 type: string example: ~ default: "True" @@ -908,14 +908,14 @@ description: | Minutes of non-activity before logged out from UI 0 means never get forcibly logged out - version_added: ~ + version_added: 1.10.8 type: string example: ~ default: "0" - name: session_lifetime_days description: | The UI cookie lifetime in days - version_added: ~ + version_added: 1.10.8 type: string example: ~ default: "30" @@ -983,7 +983,7 @@ options: - name: sentry_dsn description: ~ - version_added: ~ + version_added: 1.10.6 type: string example: ~ default: "" @@ -1080,7 +1080,7 @@ description: | Securing Flower with Basic Authentication Accepts user:password pairs separated by a comma - version_added: ~ + version_added: 1.10.2 type: string example: "user1:password1,user2:password2" default: "" @@ -1095,7 +1095,7 @@ description: | How many processes CeleryExecutor uses to sync task state. 0 means to use max(1, number of cores - 1) processes. - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "0" @@ -1138,7 +1138,7 @@ See: https://docs.celeryproject.org/en/latest/userguide/workers.html#concurrency https://docs.celeryproject.org/en/latest/userguide/concurrency/eventlet.html - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "prefork" @@ -1146,7 +1146,7 @@ description: | The number of seconds to wait before timing out ``send_task_to_executor`` or ``fetch_celery_task_state`` operations. - version_added: ~ + version_added: 1.10.8 type: int example: ~ default: "2" @@ -1233,14 +1233,14 @@ description: | The number of times to try to schedule each DAG file -1 indicates unlimited number - version_added: ~ + version_added: 1.10.6 type: string example: ~ default: "-1" - name: processor_poll_interval description: | The number of seconds to wait between consecutive DAG file processing - version_added: ~ + version_added: 1.10.6 type: string example: ~ default: "1" @@ -1270,7 +1270,7 @@ If the last scheduler heartbeat happened more than scheduler_health_check_threshold ago (in seconds), scheduler is considered unhealthy. This is used by the health check in the "/health" endpoint - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "30" @@ -1345,7 +1345,7 @@ If you want to avoid send all the available metrics to StatsD, you can configure an allow list of prefixes to send only the metrics that start with the elements of the list (e.g: scheduler,executor,dagrun) - version_added: ~ + version_added: 1.10.6 type: string example: ~ default: "" @@ -1367,7 +1367,7 @@ description: | Turn off scheduler use of cron intervals by setting this to False. DAGs submitted manually in the web UI or with trigger_dag will still run. - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "True" @@ -1375,7 +1375,7 @@ description: | Allow externally triggered DagRuns for Execution Dates in the future Only has effect if schedule_interval is set to None in DAG - version_added: ~ + version_added: 1.10.8 type: string example: ~ default: "False" @@ -1453,7 +1453,7 @@ description: | This setting allows the use of LDAP servers that either return a broken schema, or do not return a schema. - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "False" @@ -1601,21 +1601,21 @@ - name: host description: | Elasticsearch host - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "" - name: log_id_template description: | Format of the log_id, which is used to query for a given tasks logs - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "{{dag_id}}-{{task_id}}-{{execution_date}}-{{try_number}}" - name: end_of_log_mark description: | Used to mark the end of a log stream for a task - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "end_of_log" @@ -1624,28 +1624,28 @@ Qualified URL for an elasticsearch frontend (like Kibana) with a template argument for log_id Code will construct log_id using the log_id template from the argument above. NOTE: The code will prefix the https:// automatically, don't include that here. - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "" - name: write_stdout description: | Write the task logs to the stdout of the worker, rather than the default files - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "False" - name: json_format description: | Instead of the default log formatter, write the log lines as JSON - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "False" - name: json_fields description: | Log fields to also attach to the json output, if enabled - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: "asctime, filename, lineno, levelname, message" @@ -1654,13 +1654,13 @@ options: - name: use_ssl description: ~ - version_added: ~ + version_added: 1.10.5 type: string example: ~ default: "False" - name: verify_certs description: ~ - version_added: ~ + version_added: 1.10.5 type: string example: ~ default: "True" @@ -1682,7 +1682,7 @@ default: "" - name: worker_container_image_pull_policy description: ~ - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "IfNotPresent" @@ -1696,7 +1696,7 @@ - name: worker_pods_creation_batch_size description: | Number of Kubernetes Worker Pod creation calls per scheduler loop - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "1" @@ -1737,7 +1737,7 @@ ... airflow.cfg: | ... - version_added: ~ + version_added: 1.10.8 type: string example: "airflow-configmap" default: "" @@ -1746,7 +1746,7 @@ For docker image already contains DAGs, this is set to ``True``, and the worker will search for dags in dags_folder, otherwise use git sync or dags volume claim to mount DAGs - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "False" @@ -1782,7 +1782,7 @@ description: | For DAGs mounted via a hostPath volume (mutually exclusive with volume claim and git-sync) Useful in local environment, discouraged in production - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "" @@ -1790,7 +1790,7 @@ description: | A hostPath volume for the logs Useful in local environment, discouraged in production - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "" @@ -1798,7 +1798,7 @@ description: | A list of configMapsRefs to envFrom. If more than one configMap is specified, provide a comma separated list: configmap_a,configmap_b - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "" @@ -1806,7 +1806,7 @@ description: | A list of secretRefs to envFrom. If more than one secret is specified, provide a comma separated list: secret_a,secret_b - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "" @@ -1833,7 +1833,7 @@ description: | The specific rev or hash the git_sync init container will checkout This becomes GIT_SYNC_REV environment variable in the git_sync init container for worker pods - version_added: ~ + version_added: 1.10.7 type: string example: ~ default: "" @@ -1853,13 +1853,13 @@ default: "" - name: git_sync_root description: ~ - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "/git" - name: git_sync_dest description: ~ - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "repo" @@ -1867,7 +1867,7 @@ description: | Mount point of the volume if git-sync is being used. i.e. {AIRFLOW_HOME}/dags - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "" @@ -1887,7 +1887,7 @@ data: # key needs to be gitSshKey gitSshKey: - version_added: ~ + version_added: 1.10.3 type: string example: "airflow-secrets" default: "" @@ -1910,7 +1910,7 @@ airflow.cfg: | ... - version_added: ~ + version_added: 1.10.3 type: string example: "airflow-configmap" default: "" @@ -1933,7 +1933,7 @@ data: GIT_SYNC_USERNAME: GIT_SYNC_PASSWORD: - version_added: ~ + version_added: 1.10.5 type: string example: ~ default: "" @@ -1958,7 +1958,7 @@ default: "git-sync-clone" - name: git_sync_run_as_user description: ~ - version_added: ~ + version_added: 1.10.5 type: string example: ~ default: "65533" @@ -2001,13 +2001,13 @@ description: | When running with in_cluster=False change the default cluster_context or config_file options to Kubernetes client. Leave blank these to use default behaviour like ``kubectl`` has. - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: ~ - name: config_file description: ~ - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: ~ @@ -2016,7 +2016,7 @@ Affinity configuration as a single line formatted JSON object. See the affinity model for top-level key names (e.g. ``nodeAffinity``, etc.): https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#affinity-v1-core - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "" @@ -2025,7 +2025,7 @@ A list of toleration objects as a single line formatted JSON array See: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.12/#toleration-v1-core - version_added: ~ + version_added: 1.10.2 type: string example: ~ default: "" @@ -2040,7 +2040,7 @@ Note that if no _request_timeout is specified, the kubernetes client will wait indefinitely for kubernetes api responses, which will cause the scheduler to hang. The timeout is specified as [connect timeout, read timeout] - version_added: ~ + version_added: 1.10.4 type: string example: ~ default: >- @@ -2048,7 +2048,7 @@ - name: run_as_user description: | Specifies the uid to run the first process of the worker pods containers as - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: "" @@ -2057,7 +2057,7 @@ Specifies a gid to associate with all containers in the worker pods if using a git_ssh_key_secret_name use an fs_group that allows for the key to be read, e.g. 65533 - version_added: ~ + version_added: 1.10.3 type: string example: ~ default: ""