ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-23 13:20:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update docs and example config for requiretty + pipelining change

Browse source
This commit is contained in:
Toshio Kuratomi 2015-12-01 10:24:15 -08:00
commit f873cc0fb5
2 changed files with 20 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docsite/rst/intro_configuration.rst
View file

@ -799,15 +799,22 @@ pipelining
==========
Enabling pipelining reduces the number of SSH operations required to
execute a module on the remote server, by executing many ansible modules without actual file transfer.
This can result in a very significant performance improvement when enabled, however when using "sudo:" operations you must
first disable 'requiretty' in /etc/sudoers on all managed hosts.
execute a module on the remote server, by executing many ansible modules without actual file transfer.
This can result in a very significant performance improvement when enabled.
As of Ansible 2.1.0 this option is enabled by default.
By default, this option is disabled to preserve compatibility with
sudoers configurations that have requiretty (the default on many distros), but is highly
recommended if you can enable it, eliminating the need for :doc:`playbooks_acceleration`::
In previous versions, this option was disabled because of a bad interaction
with some sudo configurations. If sudo was configured to 'requiretty' for
operation then pipelining would not work and ansible would fail to connect
properly. This could be remedied by removing 'requiretty' in /etc/sudoers on
all managed hosts.
pipelining=False
It is recommended to leave this option enabled. If you are stuck with an old
version of ansible your first choice option should be to remove requiretty
from the sudoers configuration and only disable pipelining if you cannot do
that. Enabling this eliminates the need for :doc:`playbooks_acceleration`::
pipelining=True
.. _accelerate_settings: