[airflow] 03/11: Docs: Clarify behavior of delete_worker_pods_on_failure (#14958)

[as...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ash pushed a commit to branch v2-0-test
in repository https://gitbox.apache.org/repos/asf/airflow.git

commit 7c06e2c62e4d1515ae085fce06ae329267a54633
Author: Jed Cunningham <66...@users.noreply.github.com>
AuthorDate: Tue Mar 23 11:21:26 2021 -0600

    Docs: Clarify behavior of delete_worker_pods_on_failure (#14958)
    
    Clarify that the `delete_worker_pods_on_failure` flag only applies to worker failures, not task failures as well.
    
    (cherry picked from commit 7c2ed5394e12aa02ff280431b8d35af80d37b1f0)
---
 airflow/config_templates/config.yml          | 2 ++
 airflow/config_templates/default_airflow.cfg | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/airflow/config_templates/config.yml b/airflow/config_templates/config.yml
index a350a07..c53a6ca 100644
--- a/airflow/config_templates/config.yml
+++ b/airflow/config_templates/config.yml
@@ -1987,6 +1987,8 @@
       description: |
         If False (and delete_worker_pods is True),
         failed worker pods will not be deleted so users can investigate them.
+        This only prevents removal of worker pods where the worker itself failed,
+        not when the task it ran failed.
       version_added: 1.10.11
       type: string
       example: ~
diff --git a/airflow/config_templates/default_airflow.cfg b/airflow/config_templates/default_airflow.cfg
index 72e2e43..8e3ebf0 100644
--- a/airflow/config_templates/default_airflow.cfg
+++ b/airflow/config_templates/default_airflow.cfg
@@ -970,6 +970,8 @@ delete_worker_pods = True
 
 # If False (and delete_worker_pods is True),
 # failed worker pods will not be deleted so users can investigate them.
+# This only prevents removal of worker pods where the worker itself failed,
+# not when the task it ran failed.
 delete_worker_pods_on_failure = False
 
 # Number of Kubernetes Worker Pod creation calls per scheduler loop.