community.docker.docker_stack module – docker stack module
Note
This module is part of the community.docker collection (version 2.7.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.docker
.
You need further requirements to be able to use this module,
see Requirements for details.
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 |
Comments |
---|---|
If Default: |
|
Interval in seconds between consecutive absent_retries. 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. Default: |
|
Stack name |
|
If true will add the Choices:
|
|
If set will add the Choices:
|
|
Service state. Choices:
|
|
If true will add the Choices:
|
Notes
Note
Return values out and err have been deprecated and will be removed in community.docker 3.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 |
Description |
---|---|
dictionary containing the differences between the ‘Spec’ field of the stack services before and after applying the new stack definition. Returned: on change Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication