Topics
Most of the modules and plugins in community.docker require the Docker SDK for Python. The SDK needs to be installed on the machines where the modules and plugins are executed, and for the Python version(s) with which the modules and plugins are executed. You can use the community.general.python_requirements_info module to make sure that the Docker SDK for Python is installed on the correct machine and for the Python version used by Ansible.
Note that plugins (inventory plugins and connection plugins) are always executed in the context of Ansible itself. If you use a plugin that requires the Docker SDK for Python, you need to install it on the machine running ansible or ansible-playbook and for the same Python interpreter used by Ansible. To see which Python is used, run ansible --version.
ansible
ansible-playbook
ansible --version
You can install the Docker SDK for Python for Python 3.6 or later as follows:
$ pip install docker +$ pip install docker For Python 2.7, you need to use a version between 2.0.0 and 4.4.4 since the Python package for Docker removed support for Python 2.7 on 5.0.0. You can install the specific version of the Docker SDK for Python as follows: -$ pip install 'docker==4.4.4' +$ pip install 'docker==4.4.4' Note that the Docker SDK for Python was called docker-py on PyPi before version 2.0.0. Please avoid installing this really old version, and make sure to not install both docker and docker-py. Installing both will result in a broken installation. If this happens, Ansible will detect it and inform you about it. If that happens, you must uninstall both and reinstall the correct version. If in doubt, always install docker and never docker-py. @@ -400,27 +399,22 @@ by Docker SDK for Python. Docker Compose Docker Compose v2 -There are two modules for working with Docker compose projects: +There are several modules for working with Docker Compose projects: -community.docker.docker_compose_v2The community.docker.docker_compose_v2 module allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm. +community.docker.docker_compose_v2The community.docker.docker_compose_v2 module allows you to use your existing Docker Compose files to orchestrate containers on a single Docker daemon or on Swarm. -community.docker.docker_compose_v2_pullThe community.docker.docker_compose_v2_pull module allows you to pull Docker compose projects. +community.docker.docker_compose_v2_execThe community.docker.docker_compose_v2_exec module allows you to run a command in a container of Docker Compose projects. + +community.docker.docker_compose_v2_pullThe community.docker.docker_compose_v2_pull module allows you to pull Docker Compose projects. + +community.docker.docker_compose_v2_runThe community.docker.docker_compose_v2_run module allows you to run a command in a new container of a Docker Compose project. These modules use the Docker CLI “compose” plugin (docker compose), and thus needs access to the Docker CLI tool. No further requirements next to to the CLI tool and its Docker Compose plugin are needed. - -Docker Compose v1 -The deprecated community.docker.docker_compose module -allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm. -This module uses the out-dated and End of Life version 1.x of Docker Compose. It should mainly be used for legacy systems -which still have to use that version of Docker Compose. The module is deprecated and will be removed from community.docker 4.0.0. -Please use the Docker Compose v2 modules instead. -You need to install the old Python docker-compose on the remote machines to use the Docker Compose v1 module. - Docker Machine diff --git a/pr/1090/environment_variables.html b/pr/1090/environment_variables.html index aefc2364..a640887b 100644 --- a/pr/1090/environment_variables.html +++ b/pr/1090/environment_variables.html @@ -4,7 +4,7 @@ - + Index of all Collection Environment Variables — Community.Docker Collection documentation diff --git a/pr/1090/index.html b/pr/1090/index.html index e041a31e..a1c1a737 100644 --- a/pr/1090/index.html +++ b/pr/1090/index.html @@ -4,7 +4,7 @@ - + Community.Docker — Community.Docker Collection documentation @@ -204,7 +204,7 @@ -Changelog +Changelog Community.Docker Release Notes @@ -220,10 +220,10 @@ -Plugin Index +Plugin Index These are the plugins in the community.docker collection: -Modules +Modules current_container_facts module – Return facts about whether the module runs in a container docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin @@ -269,7 +269,7 @@ -Connection Plugins +Connection Plugins docker connection – Run tasks in docker containers docker_api connection – Run tasks in docker containers @@ -279,7 +279,7 @@
$ pip install docker
For Python 2.7, you need to use a version between 2.0.0 and 4.4.4 since the Python package for Docker removed support for Python 2.7 on 5.0.0. You can install the specific version of the Docker SDK for Python as follows:
$ pip install 'docker==4.4.4' +$ pip install 'docker==4.4.4' Note that the Docker SDK for Python was called docker-py on PyPi before version 2.0.0. Please avoid installing this really old version, and make sure to not install both docker and docker-py. Installing both will result in a broken installation. If this happens, Ansible will detect it and inform you about it. If that happens, you must uninstall both and reinstall the correct version. If in doubt, always install docker and never docker-py. @@ -400,27 +399,22 @@ by Docker SDK for Python. Docker Compose Docker Compose v2 -There are two modules for working with Docker compose projects: +There are several modules for working with Docker Compose projects: -community.docker.docker_compose_v2The community.docker.docker_compose_v2 module allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm. +community.docker.docker_compose_v2The community.docker.docker_compose_v2 module allows you to use your existing Docker Compose files to orchestrate containers on a single Docker daemon or on Swarm. -community.docker.docker_compose_v2_pullThe community.docker.docker_compose_v2_pull module allows you to pull Docker compose projects. +community.docker.docker_compose_v2_execThe community.docker.docker_compose_v2_exec module allows you to run a command in a container of Docker Compose projects. + +community.docker.docker_compose_v2_pullThe community.docker.docker_compose_v2_pull module allows you to pull Docker Compose projects. + +community.docker.docker_compose_v2_runThe community.docker.docker_compose_v2_run module allows you to run a command in a new container of a Docker Compose project. These modules use the Docker CLI “compose” plugin (docker compose), and thus needs access to the Docker CLI tool. No further requirements next to to the CLI tool and its Docker Compose plugin are needed. - -Docker Compose v1 -The deprecated community.docker.docker_compose module -allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm. -This module uses the out-dated and End of Life version 1.x of Docker Compose. It should mainly be used for legacy systems -which still have to use that version of Docker Compose. The module is deprecated and will be removed from community.docker 4.0.0. -Please use the Docker Compose v2 modules instead. -You need to install the old Python docker-compose on the remote machines to use the Docker Compose v1 module. - Docker Machine diff --git a/pr/1090/environment_variables.html b/pr/1090/environment_variables.html index aefc2364..a640887b 100644 --- a/pr/1090/environment_variables.html +++ b/pr/1090/environment_variables.html @@ -4,7 +4,7 @@ - + Index of all Collection Environment Variables — Community.Docker Collection documentation diff --git a/pr/1090/index.html b/pr/1090/index.html index e041a31e..a1c1a737 100644 --- a/pr/1090/index.html +++ b/pr/1090/index.html @@ -4,7 +4,7 @@ - + Community.Docker — Community.Docker Collection documentation @@ -204,7 +204,7 @@
$ pip install 'docker==4.4.4'
Note that the Docker SDK for Python was called docker-py on PyPi before version 2.0.0. Please avoid installing this really old version, and make sure to not install both docker and docker-py. Installing both will result in a broken installation. If this happens, Ansible will detect it and inform you about it. If that happens, you must uninstall both and reinstall the correct version. If in doubt, always install docker and never docker-py.
docker-py
docker
There are two modules for working with Docker compose projects:
There are several modules for working with Docker Compose projects:
-community.docker.docker_compose_v2The community.docker.docker_compose_v2 module allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm. +community.docker.docker_compose_v2The community.docker.docker_compose_v2 module allows you to use your existing Docker Compose files to orchestrate containers on a single Docker daemon or on Swarm. -community.docker.docker_compose_v2_pullThe community.docker.docker_compose_v2_pull module allows you to pull Docker compose projects. +community.docker.docker_compose_v2_execThe community.docker.docker_compose_v2_exec module allows you to run a command in a container of Docker Compose projects. + +community.docker.docker_compose_v2_pullThe community.docker.docker_compose_v2_pull module allows you to pull Docker Compose projects. + +community.docker.docker_compose_v2_runThe community.docker.docker_compose_v2_run module allows you to run a command in a new container of a Docker Compose project.
The community.docker.docker_compose_v2 module allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm.
The community.docker.docker_compose_v2 module allows you to use your existing Docker Compose files to orchestrate containers on a single Docker daemon or on Swarm.
The community.docker.docker_compose_v2_pull module allows you to pull Docker compose projects.
The community.docker.docker_compose_v2_exec module allows you to run a command in a container of Docker Compose projects.
The community.docker.docker_compose_v2_pull module allows you to pull Docker Compose projects.
The community.docker.docker_compose_v2_run module allows you to run a command in a new container of a Docker Compose project.
These modules use the Docker CLI “compose” plugin (docker compose), and thus needs access to the Docker CLI tool. No further requirements next to to the CLI tool and its Docker Compose plugin are needed.
docker compose
The deprecated community.docker.docker_compose module -allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm. -This module uses the out-dated and End of Life version 1.x of Docker Compose. It should mainly be used for legacy systems -which still have to use that version of Docker Compose. The module is deprecated and will be removed from community.docker 4.0.0. -Please use the Docker Compose v2 modules instead.
You need to install the old Python docker-compose on the remote machines to use the Docker Compose v1 module.
These are the plugins in the community.docker collection:
current_container_facts module – Return facts about whether the module runs in a container
docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin
docker connection – Run tasks in docker containers
docker_api connection – Run tasks in docker containers
docker_containers inventory – Ansible dynamic inventory plugin for Docker containers
docker_machine inventory – Docker Machine inventory source