docs: Split up limitations list, add warning
This commit is contained in:
parent
80b56e61f5
commit
8aeb0d6bb5
|
@ -59,32 +59,16 @@ Limitations
|
||||||
|
|
||||||
This is a proof of concept: issues below are exclusively due to code immaturity.
|
This is a proof of concept: issues below are exclusively due to code immaturity.
|
||||||
|
|
||||||
|
High Risk
|
||||||
|
~~~~~~~~~
|
||||||
|
|
||||||
* Connection establishment is single-threaded until more pressing issues are
|
* Connection establishment is single-threaded until more pressing issues are
|
||||||
solved. To evaluate performance, target only one host. Many hosts still work,
|
solved. To evaluate performance, target only one host. Many hosts still work,
|
||||||
the first playbook step will simply run unnecessarily slowly.
|
the first playbook step will simply run unnecessarily slowly.
|
||||||
|
|
||||||
* Only UNIX machines running Python 2.x are supported, Windows will come later.
|
|
||||||
|
|
||||||
* Only the ``sudo`` become method is available, however adding new methods is
|
|
||||||
straightforward, and eventually at least ``su`` will be included.
|
|
||||||
|
|
||||||
* The only supported strategy is ``linear``, which is Ansible's default.
|
|
||||||
|
|
||||||
* The remote interpreter is temporarily hard-wired to ``/usr/bin/python``,
|
|
||||||
matching Ansible's default. The ``ansible_python_interpreter`` variable is
|
|
||||||
ignored.
|
|
||||||
|
|
||||||
* For now only Python command modules work, however almost all modules shipped
|
|
||||||
with Ansible are Python-based.
|
|
||||||
|
|
||||||
* `Asynchronous Actions And Polling
|
* `Asynchronous Actions And Polling
|
||||||
<http://docs.ansible.com/ansible/latest/playbooks_async.html>`_ are not yet
|
<http://docs.ansible.com/ansible/latest/playbooks_async.html>`_ has received
|
||||||
supported.
|
minimal testing.
|
||||||
|
|
||||||
* In some cases ``remote_tmp`` may not be respected.
|
|
||||||
|
|
||||||
* Interaction with modules employing special action plugins is mostly untested,
|
|
||||||
except for the ``synchronize`` and ``template`` modules.
|
|
||||||
|
|
||||||
* Transfer of large (i.e. GB-sized) files using certain Ansible-internal APIs,
|
* Transfer of large (i.e. GB-sized) files using certain Ansible-internal APIs,
|
||||||
such as triggered via the ``copy`` module, will cause corresponding temporary
|
such as triggered via the ``copy`` module, will cause corresponding temporary
|
||||||
|
@ -93,6 +77,32 @@ This is a proof of concept: issues below are exclusively due to code immaturity.
|
||||||
file, the host machine could easily exhaust available RAM. This will be fixed
|
file, the host machine could easily exhaust available RAM. This will be fixed
|
||||||
soon as it's likely to be tickled by common playbook use cases.
|
soon as it's likely to be tickled by common playbook use cases.
|
||||||
|
|
||||||
|
Medium Risk
|
||||||
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
* The remote interpreter is temporarily hard-wired to ``/usr/bin/python``,
|
||||||
|
matching Ansible's default. The ``ansible_python_interpreter`` variable is
|
||||||
|
ignored.
|
||||||
|
|
||||||
|
* In some cases ``remote_tmp`` may not be respected.
|
||||||
|
|
||||||
|
* Interaction with modules employing special action plugins is minimally
|
||||||
|
tested, except for the ``synchronize``, ``template`` and ``copy`` modules.
|
||||||
|
|
||||||
|
* For now only Python command modules work, however almost all modules shipped
|
||||||
|
with Ansible are Python-based.
|
||||||
|
|
||||||
|
|
||||||
|
Low Risk
|
||||||
|
~~~~~~~~
|
||||||
|
|
||||||
|
* Only UNIX machines running Python 2.x are supported, Windows will come later.
|
||||||
|
|
||||||
|
* Only the ``sudo`` become method is available, however adding new methods is
|
||||||
|
straightforward, and eventually at least ``su`` will be included.
|
||||||
|
|
||||||
|
* The only supported strategy is ``linear``, which is Ansible's default.
|
||||||
|
|
||||||
* Ansible defaults to requiring pseudo TTYs for most SSH invocations, in order
|
* Ansible defaults to requiring pseudo TTYs for most SSH invocations, in order
|
||||||
to allow it to handle ``sudo`` with ``requiretty`` enabled, however it
|
to allow it to handle ``sudo`` with ``requiretty`` enabled, however it
|
||||||
disables pseudo TTYs for certain commands where standard input is required or
|
disables pseudo TTYs for certain commands where standard input is required or
|
||||||
|
@ -127,6 +137,10 @@ Behavioural Differences
|
||||||
Configuration
|
Configuration
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
Don't test the prototype in a live environment until this notice is removed.
|
||||||
|
|
||||||
1. Ensure the host machine is using Python 2.x for Ansible by verifying the
|
1. Ensure the host machine is using Python 2.x for Ansible by verifying the
|
||||||
output of ``ansible --version``. Ensure the ``python`` command starts a
|
output of ``ansible --version``. Ensure the ``python`` command starts a
|
||||||
Python 2.x interpreter. If not, substitute ``python`` for the correct
|
Python 2.x interpreter. If not, substitute ``python`` for the correct
|
||||||
|
|
Loading…
Reference in New Issue