docs: update docs about pipelining (#51856)
Additional documentation about `keep_remote_files` and `pipelining` configurations. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
parent
76ab88c9f5
commit
4e0e09d2de
2 changed files with 5 additions and 1 deletions
|
@ -86,6 +86,7 @@ ANSIBLE_PIPELINING:
|
||||||
- This can result in a very significant performance improvement when enabled.
|
- This can result in a very significant performance improvement when enabled.
|
||||||
- "However this conflicts with privilege escalation (become). For example, when using 'sudo:' operations you must first
|
- "However this conflicts with privilege escalation (become). For example, when using 'sudo:' operations you must first
|
||||||
disable 'requiretty' in /etc/sudoers on all managed hosts, which is why it is disabled by default."
|
disable 'requiretty' in /etc/sudoers on all managed hosts, which is why it is disabled by default."
|
||||||
|
- This options is disabled if ``ANSIBLE_KEEP_REMOTE_FILES`` is enabled.
|
||||||
env:
|
env:
|
||||||
- name: ANSIBLE_PIPELINING
|
- name: ANSIBLE_PIPELINING
|
||||||
- name: ANSIBLE_SSH_PIPELINING
|
- name: ANSIBLE_SSH_PIPELINING
|
||||||
|
@ -746,7 +747,9 @@ DEFAULT_JINJA2_NATIVE:
|
||||||
DEFAULT_KEEP_REMOTE_FILES:
|
DEFAULT_KEEP_REMOTE_FILES:
|
||||||
name: Keep remote files
|
name: Keep remote files
|
||||||
default: False
|
default: False
|
||||||
description: Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.
|
description:
|
||||||
|
- Enables/disables the cleaning up of the temporary files Ansible used to execute the tasks on the remote.
|
||||||
|
- If this option is enabled it will disable ``ANSIBLE_PIPELINING``.
|
||||||
env: [{name: ANSIBLE_KEEP_REMOTE_FILES}]
|
env: [{name: ANSIBLE_KEEP_REMOTE_FILES}]
|
||||||
ini:
|
ini:
|
||||||
- {key: keep_remote_files, section: defaults}
|
- {key: keep_remote_files, section: defaults}
|
||||||
|
|
|
@ -852,6 +852,7 @@ class ActionBase(with_metaclass(ABCMeta, object)):
|
||||||
|
|
||||||
if self._is_pipelining_enabled(module_style):
|
if self._is_pipelining_enabled(module_style):
|
||||||
in_data = module_data
|
in_data = module_data
|
||||||
|
display.vvv("Pipelining is enabled.")
|
||||||
else:
|
else:
|
||||||
cmd = remote_module_path
|
cmd = remote_module_path
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue