From 0e9a79a5893357b156de98c0cb07039b11f15b71 Mon Sep 17 00:00:00 2001 From: Chuck Douglas <37702719+chuckersjp@users.noreply.github.com> Date: Thu, 28 Feb 2019 10:13:26 -0500 Subject: [PATCH] Change the retry_files_enabled to False and modify the comments to reflect that this has been disabled (#52581) * Change the retry_files_enabled to False and modify the comments to reflect that this has been disabled. * Change the default action of retry_files_enabled to False * Update porting guide to reflect change in default state of retry_files_enabled variable * Change log documenting a change in default behaviour of retry_files_enabled * Revert config change to comment out the retry_files_enabled line to let the user decided what is best. Comment above still states how to change. --- ...581-change-default-behaviour-of-retry_files_enabled.yaml | 3 +++ docs/docsite/rst/porting_guides/porting_guide_2.8.rst | 6 ++++++ examples/ansible.cfg | 4 ++-- lib/ansible/config/base.yml | 2 +- 4 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 changelogs/fragments/52581-change-default-behaviour-of-retry_files_enabled.yaml diff --git a/changelogs/fragments/52581-change-default-behaviour-of-retry_files_enabled.yaml b/changelogs/fragments/52581-change-default-behaviour-of-retry_files_enabled.yaml new file mode 100644 index 0000000000..d5c1a22e28 --- /dev/null +++ b/changelogs/fragments/52581-change-default-behaviour-of-retry_files_enabled.yaml @@ -0,0 +1,3 @@ +--- +minor_changes: + - retry_files_enabled now defaults to False instead of True. diff --git a/docs/docsite/rst/porting_guides/porting_guide_2.8.rst b/docs/docsite/rst/porting_guides/porting_guide_2.8.rst index 89c467991e..7d7bac4f2d 100644 --- a/docs/docsite/rst/porting_guides/porting_guide_2.8.rst +++ b/docs/docsite/rst/porting_guides/porting_guide_2.8.rst @@ -141,6 +141,12 @@ options: #. Use ``auto_legacy``. This setting lets Ansible find and use the workaround Python on hosts that have it, while also finding the correct default Python on newer hosts. But remember, the default will change in 4 releases. +Retry File Creation default +--------------------------- + +In Ansible 2.8, ``retry_files_enabled`` now defaults to ``False`` instead of ``True``. The behavior can be +modified to previous version by editing the default ``ansible.cfg`` file and setting the value to ``True``. + Command Line ============ diff --git a/examples/ansible.cfg b/examples/ansible.cfg index 05adf39149..3291156b2c 100644 --- a/examples/ansible.cfg +++ b/examples/ansible.cfg @@ -251,8 +251,8 @@ # retry files -# When a playbook fails by default a .retry file will be created in ~/ -# You can disable this feature by setting retry_files_enabled to False +# When a playbook fails a .retry file can be created that will be placed in ~/ +# You can enable this feature by setting retry_files_enabled to True # and you can change the location of the files by setting retry_files_save_path #retry_files_enabled = False diff --git a/lib/ansible/config/base.yml b/lib/ansible/config/base.yml index 0f8c779527..b8f099fd42 100644 --- a/lib/ansible/config/base.yml +++ b/lib/ansible/config/base.yml @@ -1663,7 +1663,7 @@ PYTHON_MODULE_RLIMIT_NOFILE: version_added: '2.8' RETRY_FILES_ENABLED: name: Retry files - default: True + default: False description: This controls whether a failed Ansible playbook should create a .retry file. env: [{name: ANSIBLE_RETRY_FILES_ENABLED}] ini: