a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs and example config for requiretty + pipelining change

pull/4420/head
Toshio Kuratomi 2015-12-01 10:24:15 -08:00
parent 1d8e178732
commit f873cc0fb5
2 changed files with 20 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docsite/rst/intro_configuration.rst
View File

@ -800,14 +800,21 @@ pipelining
Enabling pipelining reduces the number of SSH operations required to 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. 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 This can result in a very significant performance improvement when enabled.
first disable 'requiretty' in /etc/sudoers on all managed hosts. As of Ansible 2.1.0 this option is enabled by default.
By default, this option is disabled to preserve compatibility with In previous versions, this option was disabled because of a bad interaction
sudoers configurations that have requiretty (the default on many distros), but is highly with some sudo configurations. If sudo was configured to 'requiretty' for
recommended if you can enable it, eliminating the need for :doc:`playbooks_acceleration`:: 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: .. _accelerate_settings:

10
examples/ansible.cfg
View File

@ -226,13 +226,13 @@
# Enabling pipelining reduces the number of SSH operations required to # Enabling pipelining reduces the number of SSH operations required to
# execute a module on the remote server. This can result in a significant # execute a module on the remote server. This can result in a significant
# performance improvement when enabled, however when using "sudo:" you must # performance improvement when enabled. It is enabled by default.
# first disable 'requiretty' in /etc/sudoers
# #
# By default, this option is disabled to preserve compatibility with # In previous versions of ansible this was defaulted to off as it was
# sudoers configurations that have requiretty (the default on many distros). # incompatible with sudo's requiretty option. Ansible 2.1 and above contain
# a fix for that problem.
# #
#pipelining = False #pipelining = True
# if True, make ansible use scp if the connection type is ssh # if True, make ansible use scp if the connection type is ssh
# (default is sftp) # (default is sftp)