starred/ansible
1
0
Fork 0
mirror of https://github.com/ansible/ansible.git synced 2026-08-03 08:03:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

use filesystem object instead of specific objects (#76054)

Browse Source 
since the fragment is imported by different modules that support
 different set of filesystem objects

 fixes #72375
This commit is contained in:
Brian Coca
2021-10-29 11:41:12 -04:00
committed by GitHub
parent d17f9a523d
commit 173550f932
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/ansible/plugins/doc_fragments/files.py
+16 -16
View File
@@ -16,7 +16,7 @@ class ModuleDocFragment(object):
options: options:
mode: mode:
description: 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. - 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 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 (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. 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 - 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)). 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 - 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 file. when setting the mode for the newly created filesystem object.
- If C(mode) is not specified and the destination file B(does) exist, the mode of the existing file will be used. - 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 files are created with the correct permissions. - Specifying C(mode) is the best way to ensure filesystem objects are created with the correct permissions.
See CVE-2020-1736 for further details. See CVE-2020-1736 for further details.
type: raw type: raw
owner: owner:
description: 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 type: str
group: group:
description: 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 type: str
seuser: seuser:
description: 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. - 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. - When set to C(_default), it will use the C(user) portion of the policy if available.
type: str type: str
serole: serole:
description: 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. - When set to C(_default), it will use the C(role) portion of the policy if available.
type: str type: str
setype: setype:
description: 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. - When set to C(_default), it will use the C(type) portion of the policy if available.
type: str type: str
selevel: selevel:
description: 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). - 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. - When set to C(_default), it will use the C(level) portion of the policy if available.
type: str type: str
unsafe_writes: unsafe_writes:
description: description:
- Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. - 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 files, - 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 files, 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. 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). (however, it doesn't force Ansible to perform unsafe writes).
- IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. - IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
type: bool type: bool
@@ -75,7 +75,7 @@ options:
version_added: '2.2' version_added: '2.2'
attributes: attributes:
description: 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. - 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). - 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. - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string.