Permalink
Browse files

docs: update docs about pipelining (#51856)

Additional documentation about `keep_remote_files` and
`pipelining` configurations.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
  • Loading branch information...
Akasurde authored and samdoran committed Feb 12, 2019
1 parent 76ab88c commit 4e0e09d2de17ceb33f935c9d2b8091aac6ba1a03
Showing with 5 additions and 1 deletion.
  1. +4 −1 lib/ansible/config/base.yml
  2. +1 −0 lib/ansible/plugins/action/__init__.py
@@ -86,6 +86,7 @@ ANSIBLE_PIPELINING:
- 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
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:
- name: ANSIBLE_PIPELINING
- name: ANSIBLE_SSH_PIPELINING
@@ -746,7 +747,9 @@ DEFAULT_JINJA2_NATIVE:
DEFAULT_KEEP_REMOTE_FILES:
name: Keep remote files
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}]
ini:
- {key: keep_remote_files, section: defaults}
@@ -852,6 +852,7 @@ def _execute_module(self, module_name=None, module_args=None, tmp=None, task_var

if self._is_pipelining_enabled(module_style):
in_data = module_data
display.vvv("Pipelining is enabled.")
else:
cmd = remote_module_path

0 comments on commit 4e0e09d

Please sign in to comment.