docker_node – Manage Docker Swarm node¶
New in version 2.8.
Manages the Docker nodes via Swarm Manager.
This module allows to change the node’s role, its availability, and to modify, add or remove node labels.
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.
Docker SDK for Python >= 2.4.0
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: Set node role docker_node: hostname: mynode role: manager - name: Set node availability docker_node: hostname: mynode availability: drain - name: Replace node labels with new labels docker_node: hostname: mynode labels: key: value labels_state: replace - name: Merge node labels and new labels docker_node: hostname: mynode labels: key: value - name: Remove all labels assigned to node docker_node: hostname: mynode labels_state: replace - name: Remove selected labels from the node docker_node: hostname: mynode labels_to_remove: - key1 - key2
Common return values are documented here, the following are the fields unique to this module:
Information about node after 'update' operation
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]