community.docker.docker_swarm_service module – docker swarm service
Note
This module is part of the community.docker collection (version 2.6.0).
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.
To use it in a playbook, specify: community.docker.docker_swarm_service.
Requirements
The below requirements are needed on the host that executes this module.
Docker API >= 1.24
Docker SDK for Python: Please note that the docker-py Python module has been superseded by docker (see here for details). This module does not work with docker-py.
Docker SDK for Python >= 2.0.2
Python >= 2.7
Parameters
Parameter |
Comments |
|---|---|
The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by Docker SDK for Python and the docker daemon. If the value is not specified in the task, the value of environment variable Default: “auto” |
|
List arguments to be passed to the container. Corresponds to the |
|
Use a CA certificate when performing server verification by providing the path to a CA certificate file. If the value is not specified in the task and the environment variable |
|
List of capabilities to add to the container. Requires API version >= 1.41. |
|
List of capabilities to drop from the container. Requires API version >= 1.41. |
|
Path to the client’s TLS certificate file. If the value is not specified in the task and the environment variable |
|
Path to the client’s TLS key file. If the value is not specified in the task and the environment variable |
|
Command to execute when the container starts. A command may be either a string or a list or a list of strings. Corresponds to the |
|
List of dictionaries describing the service configs. Corresponds to the Requires API version >= 1.30. |
|
Config’s ID. |
|
Config’s name as defined at its creation. |
|
Name of the file containing the config. Defaults to the config_name if not specified. |
|
GID of the config file’s group. |
|
File access mode inside the container. Must be an octal number (like |
|
UID of the config file’s owner. |
|
Dictionary of key value pairs. Corresponds to the |
|
Debug mode Choices:
|
|
List of custom DNS servers. Corresponds to the Requires API version >= 1.25. |
|
List of custom DNS options. Corresponds to the Requires API version >= 1.25. |
|
List of custom DNS search domains. Corresponds to the Requires API version >= 1.25. |
|
The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, If the value is not specified in the task, the value of environment variable Default: “unix://var/run/docker.sock” |
|
Service endpoint mode. Corresponds to the Requires API version >= 1.25. Choices:
|
|
List or dictionary of the service environment variables. If passed a list each items need to be in the format of If passed a dictionary values which might be parsed as numbers, booleans or other types by the YAML parser must be quoted (for example Corresponds to the |
|
List of paths to files, present on the target, containing environment variables The order of the list is significant in determining the value assigned to a variable that shows up more than once. If variable also present in env, then env value will override. |
|
Force update even if no changes require it. Corresponds to the Requires API version >= 1.25. Choices:
|
|
List of additional group names and/or IDs that the container process will run as. Corresponds to the Requires API version >= 1.25. |
|
Configure a check that is run to determine whether or not containers for this service are “healthy”. See the docs for the HEALTHCHECK Dockerfile instruction for details on how healthchecks work. interval, timeout and start_period are specified as durations. They accept duration as a string in a format that look like: Requires API version >= 1.25. |
|
Time between running the check. |
|
Consecutive failures needed to report unhealthy. It accept integer value. |
|
Start period for the container to initialize before starting health-retries countdown. |
|
Command to run to check health. Must be either a string or a list. If it is a list, the first item must be one of |
|
Maximum time to allow one check to run. |
|
Container hostname. Corresponds to the Requires API version >= 1.25. |
|
Dict of host-to-IP mappings, where each host name is a key in the dictionary. Each host name will be added to the container’s /etc/hosts file. Corresponds to the Requires API version >= 1.25. |
|
Service image path and tag. Corresponds to the |
|
Use an init inside each service container to forward signals and reap processes. Corresponds to the Requires API version >= 1.37. Choices:
|
|
Dictionary of key value pairs. Corresponds to the |
|
Configures service resource limits. |
|
Service CPU limit. Corresponds to the |
|
Service memory limit in format
Omitting the unit defaults to bytes. Corresponds to the |
|
Logging configuration for the service. |
|
Configure the logging driver for a service. Corresponds to the |
|
Options for service logging driver. Corresponds to the |
|
Service replication mode. Service will be removed and recreated when changed. Corresponds to the Choices:
|
|
List of dictionaries describing the service mounts. Corresponds to the |
|
Volume driver configuration. Can only be used when type is |
|
Name of the volume-driver plugin to use for the volume. |
|
Options as key-value pairs to pass to the driver for this volume. |
|
Volume labels to apply. |
|
Disable copying of data from a container when a volume is created. Can only be used when type is Choices:
|
|
The propagation mode to use. Can only be used when type is Choices:
|
|
Whether the mount should be read-only. Choices:
|
|
Mount source (for example a volume name or a host path). Must be specified if type is not |
|
Container path. |
|
File mode of the tmpfs in octal. Can only be used when type is |
|
Size of the tmpfs mount in format Can only be used when type is |
|
The mount type. Note that Choices:
|
|
Service name. Corresponds to the |
|
List of the service networks names or dictionaries. When passed dictionaries valid sub-options are name, which is required, and aliases and options. Prior to API version 1.29, updating and removing networks is not supported. If changes are made the service will then be removed and recreated. Corresponds to the |
|
Configures service placement preferences and constraints. |
|
List of the service constraints. Corresponds to the |
|
List of the placement preferences as key value pairs. Corresponds to the Requires API version >= 1.27. |
|
Maximum number of tasks per node. Corresponds to the Requires API version >= 1.40 |
|
List of dictionaries describing the service published ports. Corresponds to the Requires API version >= 1.25. |
|
What publish mode to use. Requires API version >= 1.32. Choices:
|
|
What protocol to use. Choices:
|
|
The port to make externally available. |
|
The port inside the container to expose. |
|
Mount the containers root filesystem as read only. Corresponds to the Choices:
|
|
Number of containers instantiated in the service. Valid only if mode is If set to If set to Corresponds to the Default: -1 |
|
Configures service resource reservations. |
|
Service CPU reservation. Corresponds to the |
|
Service memory reservation in format
Omitting the unit defaults to bytes. Corresponds to the |
|
If the current image digest should be resolved from registry and updated if changed. Requires API version >= 1.30. Choices:
|
|
Configures if and how to restart containers when they exit. |
|
Restart condition of the service. Corresponds to the Choices:
|
|
Delay between restarts. Accepts a a string in a format that look like: Corresponds to the |
|
Maximum number of service restarts. Corresponds to the |
|
Restart policy evaluation window. Accepts a string in a format that look like: Corresponds to the |
|
Configures how the service should be rolled back in case of a failing update. |
|
Delay between task rollbacks. Accepts a string in a format that look like: Corresponds to the Requires API version >= 1.28. |
|
Action to take in case of rollback failure. Corresponds to the Requires API version >= 1.28. Choices:
|
|
Fraction of tasks that may fail during a rollback. Corresponds to the Requires API version >= 1.28. |
|
Duration after each task rollback to monitor for failure. Accepts a string in a format that look like: Corresponds to the Requires API version >= 1.28. |
|
Specifies the order of operations during rollbacks. Corresponds to the Requires API version >= 1.29. |
|
The number of containers to rollback at a time. If set to 0, all containers rollback simultaneously. Corresponds to the Requires API version >= 1.28. |
|
List of dictionaries describing the service secrets. Corresponds to the Requires API version >= 1.25. |
|
Name of the file containing the secret. Defaults to the secret_name if not specified. Corresponds to the |
|
GID of the secret file’s group. |
|
File access mode inside the container. Must be an octal number (like |
|
Secret’s ID. |
|
Secret’s name as defined at its creation. |
|
UID of the secret file’s owner. |
|
Provide a valid SSL version number. Default value determined by ssl.py module. If the value is not specified in the task, the value of environment variable |
|
Choices:
|
|
Time to wait before force killing a container. Accepts a duration as a string in a format that look like: Corresponds to the |
|
Override default signal used to stop the container. Corresponds to the |
|
The maximum amount of time in seconds to wait on a response from the API. If the value is not specified in the task, the value of environment variable Default: 60 |
|
Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if validate_certs is set to If the value is not specified in the task, the value of environment variable Choices:
|
|
When verifying the authenticity of the Docker Host server, provide the expected name of the server. If the value is not specified in the task, the value of environment variable The current default value is |
|
Allocate a pseudo-TTY. Corresponds to the Requires API version >= 1.25. Choices:
|
|
Configures how the service should be updated. Useful for configuring rolling updates. |
|
Rolling update delay. Accepts a string in a format that look like: Corresponds to the |
|
Action to take in case of container failure. Corresponds to the Usage of rollback requires API version >= 1.29. Choices:
|
|
Fraction of tasks that may fail during an update before the failure action is invoked. Corresponds to the Requires API version >= 1.25. |
|
Time to monitor updated tasks for failures. Accepts a string in a format that look like: Corresponds to the Requires API version >= 1.25. |
|
Specifies the order of operations when rolling out an updated task. Corresponds to the Requires API version >= 1.29. |
|
Rolling update parallelism. Corresponds to the |
|
For SSH transports, use the Requires Docker SDK for Python 4.4.0 or newer. Choices:
|
|
Sets the username or UID used for the specified command. Before Ansible 2.8, the default value for this option was The default has been removed so that the user defined in the image is used if no user is specified here. Corresponds to the |
|
Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server. If the value is not specified in the task, the value of environment variable Choices:
|
|
Path to the working directory. Corresponds to the |
Notes
Note
Images will only resolve to the latest digest when using Docker API >= 1.30 and Docker SDK for Python >= 3.2.0. When using older versions use
force_update: trueto trigger the swarm to resolve a new image.Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
DOCKER_HOST,DOCKER_TLS_HOSTNAME,DOCKER_API_VERSION,DOCKER_CERT_PATH,DOCKER_SSL_VERSION,DOCKER_TLS,DOCKER_TLS_VERIFYandDOCKER_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
docker[tls]with ansible.builtin.pip.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
$HOME/.docker/config.jsonif theDOCKER_CONFIGenvironment variable is not specified, and use$DOCKER_CONFIG/config.jsonotherwise.This module uses the Docker SDK for Python to communicate with the Docker daemon.
Examples
- name: Set command and arguments
community.docker.docker_swarm_service:
name: myservice
image: alpine
command: sleep
args:
- "3600"
- name: Set a bind mount
community.docker.docker_swarm_service:
name: myservice
image: alpine
mounts:
- source: /tmp/
target: /remote_tmp/
type: bind
- name: Set service labels
community.docker.docker_swarm_service:
name: myservice
image: alpine
labels:
com.example.description: "Accounting webapp"
com.example.department: "Finance"
- name: Set environment variables
community.docker.docker_swarm_service:
name: myservice
image: alpine
env:
ENVVAR1: envvar1
ENVVAR2: envvar2
env_files:
- envs/common.env
- envs/apps/web.env
- name: Set fluentd logging
community.docker.docker_swarm_service:
name: myservice
image: alpine
logging:
driver: fluentd
options:
fluentd-address: "127.0.0.1:24224"
fluentd-async-connect: "true"
tag: myservice
- name: Set restart policies
community.docker.docker_swarm_service:
name: myservice
image: alpine
restart_config:
condition: on-failure
delay: 5s
max_attempts: 3
window: 120s
- name: Set update config
community.docker.docker_swarm_service:
name: myservice
image: alpine
update_config:
parallelism: 2
delay: 10s
order: stop-first
- name: Set rollback config
community.docker.docker_swarm_service:
name: myservice
image: alpine
update_config:
failure_action: rollback
rollback_config:
parallelism: 2
delay: 10s
order: stop-first
- name: Set placement preferences
community.docker.docker_swarm_service:
name: myservice
image: alpine:edge
placement:
preferences:
- spread: node.labels.mylabel
constraints:
- node.role == manager
- engine.labels.operatingsystem == ubuntu 14.04
replicas_max_per_node: 2
- name: Set configs
community.docker.docker_swarm_service:
name: myservice
image: alpine:edge
configs:
- config_name: myconfig_name
filename: "/tmp/config.txt"
- name: Set networks
community.docker.docker_swarm_service:
name: myservice
image: alpine:edge
networks:
- mynetwork
- name: Set networks as a dictionary
community.docker.docker_swarm_service:
name: myservice
image: alpine:edge
networks:
- name: "mynetwork"
aliases:
- "mynetwork_alias"
options:
foo: bar
- name: Set secrets
community.docker.docker_swarm_service:
name: myservice
image: alpine:edge
secrets:
- secret_name: mysecret_name
filename: "/run/secrets/secret.txt"
- name: Start service with healthcheck
community.docker.docker_swarm_service:
name: myservice
image: nginx:1.13
healthcheck:
# Check if nginx server is healthy by curl'ing the server.
# If this fails or timeouts, the healthcheck fails.
test: ["CMD", "curl", "--fail", "http://nginx.host.com"]
interval: 1m30s
timeout: 10s
retries: 3
start_period: 30s
- name: Configure service resources
community.docker.docker_swarm_service:
name: myservice
image: alpine:edge
reservations:
cpus: 0.25
memory: 20M
limits:
cpus: 0.50
memory: 50M
- name: Remove service
community.docker.docker_swarm_service:
name: myservice
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of changed service attributes if a service has been altered, [] otherwise. Returned: always Sample: [“container_labels”, “replicas”] |
|
True if the service has been recreated (removed and created) Returned: always Sample: true |
|
Dictionary of variables representing the current state of the service. Matches the module parameters format. Note that facts are not part of registered vars but accessible directly. Note that before Ansible 2.7.9, the return variable was documented as Returned: always Sample: “{ \”args\”: [ \”3600\” ], \”cap_add\”: null, \”cap_drop\”: [ \”ALL\” ], \”command\”: [ \”sleep\” ], \”configs\”: null, \”constraints\”: [ \”node.role == manager\”, \”engine.labels.operatingsystem == ubuntu 14.04\” ], \”container_labels\”: null, \”dns\”: null, \”dns_options\”: null, \”dns_search\”: null, \”endpoint_mode\”: null, \”env\”: [ \”ENVVAR1=envvar1\”, \”ENVVAR2=envvar2\” ], \”force_update\”: null, \”groups\”: null, \”healthcheck\”: { \”interval\”: 90000000000, \”retries\”: 3, \”start_period\”: 30000000000, \”test\”: [ \”CMD\”, \”curl\”, \”–fail\”, \”http://nginx.host.com\” ], \”timeout\”: 10000000000 }, \”healthcheck_disabled\”: false, \”hostname\”: null, \”hosts\”: null, \”image\”: \”alpine:latest@sha256:b3dbf31b77fd99d9c08f780ce6f5282aba076d70a513a8be859d8d3a4d0c92b8\”, \”labels\”: { \”com.example.department\”: \”Finance\”, \”com.example.description\”: \”Accounting webapp\” }, \”limit_cpu\”: 0.5, \”limit_memory\”: 52428800, \”log_driver\”: \”fluentd\”, \”log_driver_options\”: { \”fluentd-address\”: \”127.0.0.1:24224\”, \”fluentd-async-connect\”: \”true\”, \”tag\”: \”myservice\” }, \”mode\”: \”replicated\”, \”mounts\”: [ { \”readonly\”: false, \”source\”: \”/tmp/\”, \”target\”: \”/remote_tmp/\”, \”type\”: \”bind\”, \”labels\”: null, \”propagation\”: null, \”no_copy\”: null, \”driver_config\”: null, \”tmpfs_size\”: null, \”tmpfs_mode\”: null } ], \”networks\”: null, \”placement_preferences\”: [ { \”spread\”: \”node.labels.mylabel\” } ], \”publish\”: null, \”read_only\”: null, \”replicas\”: 1, \”replicas_max_per_node\”: 1, \”reserve_cpu\”: 0.25, \”reserve_memory\”: 20971520, \”restart_policy\”: \”on-failure\”, \”restart_policy_attempts\”: 3, \”restart_policy_delay\”: 5000000000, \”restart_policy_window\”: 120000000000, \”secrets\”: null, \”stop_grace_period\”: null, \”stop_signal\”: null, \”tty\”: null, \”update_delay\”: 10000000000, \”update_failure_action\”: null, \”update_max_failure_ratio\”: null, \”update_monitor\”: null, \”update_order\”: \”stop-first\”, \”update_parallelism\”: 2, \”user\”: null, \”working_dir\”: null }” |
Authors
Dario Zanzico (@dariko)
Jason Witkowski (@jwitko)
Hannes Ljungberg (@hannseman)
Piotr Wojciechowski (@wojciechowskipiotr)
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication