community.general.docker_swarm – Manage Swarm cluster¶
This plugin is part of the community.general collection (version 1.3.0).
To install it use:
ansible-galaxy collection install community.general.
To use it in a playbook, specify:
The below requirements are needed on the host that executes this module.
Docker API >= 1.25
Docker SDK for Python: Please note that the docker-py Python module has been superseded by docker (see here for details). For Python 2.6,
docker-pymust be used. Otherwise, it is recommended to install the
dockerPython module. Note that both modules should not be installed at the same time. Also note that when both modules are installed and one of them is uninstalled, the other might no longer function and a reinstall of it is required.
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.
When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing
Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions. In general, it will use
DOCKER_CONFIGenvironment variable is not specified, and use
- name: Init a new swarm with default parameters community.general.docker_swarm: state: present - name: Update swarm configuration community.general.docker_swarm: state: present election_tick: 5 - name: Add nodes community.general.docker_swarm: state: join advertise_addr: 192.168.1.2 join_token: SWMTKN-1--xxxxx remote_addrs: [ '192.168.1.1:2377' ] - name: Leave swarm for a node community.general.docker_swarm: state: absent - name: Remove a swarm manager community.general.docker_swarm: state: absent force: true - name: Remove node from swarm community.general.docker_swarm: state: remove node_id: mynode - name: Inspect swarm community.general.docker_swarm: state: inspect register: swarm_info
Common return values are documented here, the following are the fields unique to this module: