Make all pipelining agree on ini entries (#76573)

* Make all pipelining agree on ini entries, corrected descriptions
pull/76679/head
Brian Coca 3 years ago committed by GitHub
parent b17557ae8e
commit ace04087e7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -99,13 +99,13 @@ ANSIBLE_PIPELINING:
name: Connection pipelining name: Connection pipelining
default: False default: False
description: description:
- This is a global option, each connection plugin can override either by having more specific options or not supporting pipelining at all.
- Pipelining, if supported by the connection plugin, reduces the number of network operations required to execute a module on the remote server, - Pipelining, if supported by the connection plugin, reduces the number of network operations required to execute a module on the remote server,
by executing many Ansible modules without actual file transfer. by executing many Ansible modules without actual file transfer.
- This can result in a very significant performance improvement when enabled. - It 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 option is disabled if ``ANSIBLE_KEEP_REMOTE_FILES`` is enabled. - This setting will be disabled if ``ANSIBLE_KEEP_REMOTE_FILES`` is enabled.
- This is a global option, each connection plugin can override either by having more specific options or not supporting pipelining at all.
env: env:
- name: ANSIBLE_PIPELINING - name: ANSIBLE_PIPELINING
ini: ini:

@ -216,6 +216,8 @@ DOCUMENTATION = '''
- name: ANSIBLE_PIPELINING - name: ANSIBLE_PIPELINING
- name: ANSIBLE_SSH_PIPELINING - name: ANSIBLE_SSH_PIPELINING
ini: ini:
- section: defaults
key: pipelining
- section: connection - section: connection
key: pipelining key: pipelining
- section: ssh_connection - section: ssh_connection

@ -23,6 +23,8 @@ options:
ini: ini:
- section: defaults - section: defaults
key: pipelining key: pipelining
- section: connection
key: pipelining
type: boolean type: boolean
vars: vars:
- name: ansible_pipelining - name: ansible_pipelining

Loading…
Cancel
Save