diff --git a/docsite/rst/intro_configuration.rst b/docsite/rst/intro_configuration.rst index cf4b9b61223..a9f50f804f8 100644 --- a/docsite/rst/intro_configuration.rst +++ b/docsite/rst/intro_configuration.rst @@ -662,8 +662,8 @@ recommended if you can enable it, eliminating the need for :doc:`playbooks_accel .. _accelerate_settings: -Accelerate Mode Settings ------------------------- +Accelerated Mode Settings +------------------------- Under the [accelerate] header, the following settings are tunable for :doc:`playbooks_acceleration`. Acceleration is a useful performance feature to use if you cannot enable :ref:`pipelining` in your environment, but is probably @@ -676,7 +676,7 @@ accelerate_port .. versionadded:: 1.3 -This is the port to use for accelerate mode:: +This is the port to use for accelerated mode:: accelerate_port = 5099 diff --git a/docsite/rst/playbooks_acceleration.rst b/docsite/rst/playbooks_acceleration.rst index b7f08828a84..40b77246db8 100644 --- a/docsite/rst/playbooks_acceleration.rst +++ b/docsite/rst/playbooks_acceleration.rst @@ -6,24 +6,24 @@ Accelerated Mode You Might Not Need This! ```````````````````````` -Are you running Ansible 1.5 or later? If so, you may not need accelerate mode due to a new feature called "SSH pipelining" and should read the :ref:`pipelining` section of the documentation. +Are you running Ansible 1.5 or later? If so, you may not need accelerated mode due to a new feature called "SSH pipelining" and should read the :ref:`pipelining` section of the documentation. -For users on 1.5 and later, accelerate mode only makes sense if you (A) are managing from an Enterprise Linux 6 or earlier host +For users on 1.5 and later, accelerated mode only makes sense if you (A) are managing from an Enterprise Linux 6 or earlier host and still are on paramiko, or (B) can't enable TTYs with sudo as described in the pipelining docs. If you can use pipelining, Ansible will reduce the amount of files transferred over the wire, -making everything much more efficient, and performance will be on par with accelerate mode in nearly all cases, possibly excluding very large file transfer. Because less moving parts are involved, pipelining is better than accelerate mode for nearly all use cases. +making everything much more efficient, and performance will be on par with accelerated mode in nearly all cases, possibly excluding very large file transfer. Because less moving parts are involved, pipelining is better than accelerated mode for nearly all use cases. -Accelerate mode remains around in support of EL6 +Accelerated moded remains around in support of EL6 control machines and other constrained environments. -Accelerate Mode Details -``````````````````````` +Accelerated Mode Details +```````````````````````` While OpenSSH using the ControlPersist feature is quite fast and scalable, there is a certain small amount of overhead involved in using SSH connections. While many people will not encounter a need, if you are running on a platform that doesn't have ControlPersist support (such as an EL6 control machine), you'll probably be even more interested in tuning options. -Accelerate mode is there to help connections work faster, but still uses SSH for initial secure key exchange. There is no +Accelerated mode is there to help connections work faster, but still uses SSH for initial secure key exchange. There is no additional public key infrastructure to manage, and this does not require things like NTP or even DNS. Accelerated mode can be anywhere from 2-6x faster than SSH with ControlPersist enabled, and 10x faster than paramiko.