cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docker scenario guide: docker-py -> docker (#44856)

Browse source 
* Don't install docker-py by default, but the more modern docker library.

* Addressing the review comments.
This commit is contained in:
Felix Fontein 2018-08-30 21:38:03 +02:00 committed by Alicia Cozine
parent 00368a432f
commit 376dcb9f84
1 changed files with 19 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/docsite/rst/scenario_guides/guide_docker.rst
View file

@ -42,13 +42,30 @@ There's more planned. See the latest ideas and thinking at the `Ansible proposal
Requirements
------------
Using the docker modules requires having `docker-py <https://docker-py.readthedocs.io/en/stable/>`_
installed on the host running Ansible. You will need to have >= 1.7.0 installed.
Using the docker modules requires having the `Docker SDK for Python <https://docker-py.readthedocs.io/en/stable/>`_
installed on the host running Ansible. You will need to have >= 1.7.0 installed. For Python 2.7 or
Python 3, you can install it as follows:
.. code-block:: bash
$ pip install docker
For Python 2.6, you need a version before 2.0. For these versions, the SDK was called ``docker-py``,
so you need to install it as follows:
.. code-block:: bash
$ pip install 'docker-py>=1.7.0'
Please note that only one of ``docker`` and ``docker-py`` must be installed. Installing both will result in
a broken installation. If this happens, Ansible will detect it and inform you about it::
Cannot have both the docker-py and docker python modules installed together as they use the same
namespace and cause a corrupt installation. Please uninstall both packages, and re-install only
the docker-py or docker python module. It is recommended to install the docker module if no support
for Python 2.6 is required. Please note that simply uninstalling one of the modules can leave the
other module in a broken state.
The docker_service module also requires `docker-compose <https://github.com/docker/compose>`_
.. code-block:: bash