diff options
author | Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com> | 2021-11-02 11:02:08 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-02 13:02:08 -0500 |
commit | a7b06d9c81f3ecb821f1326ead0d61ea34472987 (patch) | |
tree | 7a081dbc9b032162a7eb57fcccd3bb46207337f1 /lib | |
parent | 4ef593e4b014a4ffdb9ff75a2d77867f34cf41a1 (diff) | |
download | ansible-a7b06d9c81f3ecb821f1326ead0d61ea34472987.tar.gz |
[Backport][Docs] Docs 2.12 backportapalooza5 (#76198)
* Update `argcomplete` install via apt command (#76139)
To install `argcomplete` on Ubuntu 21.10 we need to update the install line to use Python3
* Update module documentation about ref links (#76088)
* Update module documentation about ref links
* Docs: Change API endpoint for hub to console.redhat.com in user guide (#76080)
The cloud.redhat.com has changed to console.redhat.com
* Clarify that "requires_ansible" means Ansible Core (#76100)
Clarify that the `requires_ansible` field in meta/runtime.yml refers to the version of Ansible Core (ansible-core), not any package called "ansible" e.g. https://pypi.org/project/ansible/
* Docs: Fix text for contributing to collection link (#76174)
* use filesystem object instead of specific objects (#76054)
since the fragment is imported by different modules that support
different set of filesystem objects
fixes #72375
* Docs: fedora32 is no longer supported (for integration tests) (#76159)
* Update playbooks_tests.rst (#76047)
Co-authored-by: Nedko Hristov <NedkoHristov@users.noreply.github.com>
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>
Co-authored-by: Sean Cavanaugh <sean@cavanaugh.pro>
Co-authored-by: Richard Megginson <richm@stanfordalumni.org>
Co-authored-by: Brian Coca <bcoca@users.noreply.github.com>
Co-authored-by: Matthew Donoughe <mdonoughe@gmail.com>
Co-authored-by: Paul <suchko@users.noreply.github.com>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/ansible/plugins/doc_fragments/files.py | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/lib/ansible/plugins/doc_fragments/files.py b/lib/ansible/plugins/doc_fragments/files.py index 008642d633..c498fe2cea 100644 --- a/lib/ansible/plugins/doc_fragments/files.py +++ b/lib/ansible/plugins/doc_fragments/files.py @@ -16,7 +16,7 @@ class ModuleDocFragment(object): options: mode: description: - - The permissions the resulting file or directory should have. + - The permissions the resulting filesystem object should have. - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like C(0644) or C(01777)) or quote it (like C('644') or C('1777')) so Ansible receives @@ -25,49 +25,49 @@ options: number which will have unexpected results. - As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, C(u+rwx) or C(u=rw,g=r,o=r)). - - If C(mode) is not specified and the destination file B(does not) exist, the default C(umask) on the system will be used - when setting the mode for the newly created file. - - If C(mode) is not specified and the destination file B(does) exist, the mode of the existing file will be used. - - Specifying C(mode) is the best way to ensure files are created with the correct permissions. + - If C(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used + when setting the mode for the newly created filesystem object. + - If C(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used. + - Specifying C(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details. type: raw owner: description: - - Name of the user that should own the file/directory, as would be fed to I(chown). + - Name of the user that should own the filesystem object, as would be fed to I(chown). type: str group: description: - - Name of the group that should own the file/directory, as would be fed to I(chown). + - Name of the group that should own the filesystem object, as would be fed to I(chown). type: str seuser: description: - - The user part of the SELinux file context. + - The user part of the SELinux filesystem object context. - By default it uses the C(system) policy, where applicable. - When set to C(_default), it will use the C(user) portion of the policy if available. type: str serole: description: - - The role part of the SELinux file context. + - The role part of the SELinux filesystem object context. - When set to C(_default), it will use the C(role) portion of the policy if available. type: str setype: description: - - The type part of the SELinux file context. + - The type part of the SELinux filesystem object context. - When set to C(_default), it will use the C(type) portion of the policy if available. type: str selevel: description: - - The level part of the SELinux file context. + - The level part of the SELinux filesystem object context. - This is the MLS/MCS attribute, sometimes known as the C(range). - When set to C(_default), it will use the C(level) portion of the policy if available. type: str unsafe_writes: description: - - Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. - - 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, + - Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object. + - By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objecs, + but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, 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 + - This option allows Ansible to fall back to unsafe methods of updating filesystem objects 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 @@ -75,7 +75,7 @@ options: version_added: '2.2' attributes: description: - - The attributes the resulting file or directory should have. + - The attributes the resulting filesystem object should have. - To get supported flags look at the man page for I(chattr) on the target system. - This string should contain the attributes in the same order as the one displayed by I(lsattr). - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. |