ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Clarified documentation for the unsafe_writes option (#27471)

Browse source 
* Clarified documentation for the unsafe_writes option per #24449.
This commit is contained in:
Roman D 2018-09-20 19:40:14 +03:00 committed by Alicia Cozine
parent 17ca0a9bd9
commit dd5d191d7a
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
lib/ansible/utils/module_docs_fragments/files.py
View file

@ -57,11 +57,13 @@ options:
default: "s0"
unsafe_writes:
description:
- Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files,
sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files,
they cannot be updated atomically and can only be done in an unsafe manner.
- This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do
not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.
- By default this module uses atomic operations to prevent data
corruption or inconsistent reads from the target files,
but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files,
which cannot be updated atomically from inside the container and can only be written in an unsafe manner.
- This option allows Ansible to fall back to unsafe methods of
updating files when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes).
IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
type: bool
default: 'no'
version_added: "2.2"