community.docker.docker_stack – docker stack module
community.docker.docker_stack – docker stack module
Note
This plugin is part of the community.docker collection (version 1.1.0).
To install it use: ansible-galaxy collection install community.docker
.
To use it in a playbook, specify: community.docker.docker_stack
.
Synopsis
- Manage docker stacks using the ‘docker stack’ command on the target node (see examples).
Requirements
The below requirements are needed on the host that executes this module.
- jsondiff
- pyyaml
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
absent_retries integer |
Default: 0 |
If |
absent_retries_interval integer |
Default: 1 |
Interval in seconds between consecutive absent_retries. |
compose list / elements=raw |
Default: [] |
List of compose definitions. Any element may be a string referring to the path of the compose file on the target host or the YAML contents of a compose file nested as dictionary. |
name string / required |
Stack name | |
prune boolean |
|
If true will add the |
resolve_image string |
|
If set will add the |
state string |
|
Service state. |
with_registry_auth boolean |
|
If true will add the |
Notes
Note
- Return values out and err have been deprecated and will be removed in community.docker 2.0.0. Use stdout and stderr instead.
Examples
- name: Deploy stack from a compose file
community.docker.docker_stack:
state: present
name: mystack
compose:
- /opt/docker-compose.yml
- name: Deploy stack from base compose file and override the web service
community.docker.docker_stack:
state: present
name: mystack
compose:
- /opt/docker-compose.yml
- version: '3'
services:
web:
image: nginx:latest
environment:
ENVVAR: envvar
- name: Remove stack
community.docker.docker_stack:
name: mystack
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
stack_spec_diff dictionary |
on change |
dictionary containing the differences between the 'Spec' field of the stack services before and after applying the new stack definition.
Sample: "stack_spec_diff": {'test_stack_test_service': {u'TaskTemplate': {u'ContainerSpec': {delete: [u'Env']}}}} |
Authors
- Dario Zanzico (@dariko)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/docker/docker_stack_module.html