Documentation

docker_service - Manage docker services and containers.

New in version 2.1.

Synopsis

  • Consumes docker compose to start, shutdown and scale services.
  • Works with compose versions 1 and 2.
  • Compose can be read from a docker-compose.yml (or .yaml) file or inline using the definition option.
  • See the examples for more details.
  • Supports check mode.

Requirements (on host that executes module)

  • python >= 2.6
  • docker-compose >= 1.7.0
  • Docker API >= 1.20
  • PyYAML >= 3.11

Options

parameter required default choices comments
api_version
no default provided by docker-py
The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by docker-py.

aliases: docker_api_version
build
no
  • yes
  • no
Use with state present to always build images prior to starting the application.
Same as running docker-compose build with the pull option.
Images will only be rebuilt if Docker detects a change in the Dockerfile or build directory contents.
Use the nocache option to ignore the image cache when performing the build.
If an existing image is replaced, services using the image will be recreated unless recreate is never.
cacert_path
no
Use a CA certificate when performing server verification by providing the path to a CA certificate file.

aliases: tls_ca_cert
cert_path
no
Path to the client's TLS certificate file.

aliases: tls_client_cert
debug
no
  • yes
  • no
Include actions in the return values.
definition
no
Provide docker-compose yaml describing one or more services, networks and volumes.
Mutually exclusive with project_src and files.
dependencies
no True
  • yes
  • no
When state is present specify whether or not to include linked services.
docker_host
no unix://var/run/docker.sock
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, 'tcp://192.0.2.23:2376'. If TLS is used to encrypt the connection, the module will automatically replace 'tcp' in the connection URL with 'https'.

aliases: docker_url
files
no
List of file names relative to project_src. Overrides docker-compose.yml or docker-compose.yaml.
Files are loaded and merged in the order given.
hostname_check
no
  • yes
  • no
Whether or not to check the Docker daemon's hostname against the name provided in the client certificate.
key_path
no
Path to the client's TLS key file.

aliases: tls_client_key
nocache
(added in 2.2)
no
  • yes
  • no
Use with the build option to ignore the cache during the image build process.
project_name
no
Provide a project name. If not provided, the project name is taken from the basename of project_src.
Required when no definition is provided.
project_src
no
Path to a directory containing a docker-compose.yml or docker-compose.yaml file.
Mutually exclusive with definition.
Required when no definition is provided.
pull
(added in 2.2)
no
  • yes
  • no
Use with state present to always pull images prior to starting the application.
Same as running docker-compose pull.
When a new image is pulled, services using the image will be recreated unless recreate is never.
recreate
no smart
  • always
  • never
  • smart
By default containers will be recreated when their configuration differs from the service definition.
Setting to never ignores configuration differences and leaves existing containers unchanged.
Setting to always forces recreation of all existing containers.
remove_images
no
Use with state absent to remove the all images or only local images.
remove_volumes
no
  • yes
  • no
Use with state absent to remove data volumes.
restarted
no
  • yes
  • no
Use with state present to restart all containers.
scale
no
When state is present scale services. Provide a dictionary of key/value pairs where the key is the name of the service and the value is an integer count for the number of containers.
services
no
When state is present run docker-compose up on a subset of services.
ssl_version
no 1.0
Provide a valid SSL version number. Default value determined by docker-py, currently 1.0.
state
no present
  • absent
  • present
Desired state of the project.
Specifying present is the same as running docker-compose up.
Specifying absent is the same as running docker-compose down.
stopped
no
  • yes
  • no
Use with state present to leave the containers in an exited or non-running state.
timeout
no 60
The maximum amount of time in seconds to wait on a response from the API.
tls
no
Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server.
tls_hostname
no localhost
When verifying the authenticity of the Docker Host server, provide the expected name of the server.
tls_verify
no
Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.

Examples

# Examples use the django example at U(https://docs.docker.com/compose/django/). Follow it to create the flask
# directory

- name: Run using a project directory
  hosts: localhost
  connection: local
  gather_facts: no
  tasks:
    - docker_service:
        project_src: flask
        state: absent

    - docker_service:
        project_src: flask
      register: output

    - debug:
        var: output

    - docker_service:
        project_src: flask
        build: no
      register: output

    - debug:
        var: output

    - assert:
        that: "not output.changed "

    - docker_service:
        project_src: flask
        build: no
        stopped: true
      register: output

    - debug:
        var: output

    - assert:
        that:
          - "not web.flask_web_1.state.running"
          - "not db.flask_db_1.state.running"

    - docker_service:
        project_src: flask
        build: no
        restarted: true
      register: output

    - debug:
        var: output

    - assert:
        that:
          - "web.flask_web_1.state.running"
          - "db.flask_db_1.state.running"

- name: Scale the web service to 2
  hosts: localhost
  connection: local
  gather_facts: no
  tasks:
    - docker_service:
        project_src: flask
        scale:
          web: 2
      register: output

    - debug:
        var: output

- name: Run with inline v2 compose
  hosts: localhost
  connection: local
  gather_facts: no
  tasks:
    - docker_service:
        project_src: flask
        state: absent

    - docker_service:
        project_name: flask
        definition:
          version: '2'
          services:
            db:
              image: postgres
            web:
              build: "{{ playbook_dir }}/flask"
              command: "python manage.py runserver 0.0.0.0:8000"
              volumes:
                - "{{ playbook_dir }}/flask:/code"
              ports:
                - "8000:8000"
              depends_on:
                - db
      register: output

    - debug:
        var: output

    - assert:
        that:
          - "web.flask_web_1.state.running"
          - "db.flask_db_1.state.running"

- name: Run with inline v1 compose
  hosts: localhost
  connection: local
  gather_facts: no
  tasks:
    - docker_service:
        project_src: flask
        state: absent

    - docker_service:
        project_name: flask
        definition:
            db:
              image: postgres
            web:
              build: "{{ playbook_dir }}/flask"
              command: "python manage.py runserver 0.0.0.0:8000"
              volumes:
                - "{{ playbook_dir }}/flask:/code"
              ports:
                - "8000:8000"
              links:
                - db
      register: output

    - debug:
        var: output

    - assert:
        that:
          - "web.flask_web_1.state.running"
          - "db.flask_db_1.state.running"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
service
Name of the service.
success complex
contains:
name description returned type sample
container_name
Name of the container. Format is project_service_#.
success complex
actions
Provides the actions to be taken on each service as determined by compose.
when in check mode or I(debug) true complex
contains:
name description returned type sample
service_name
Name of the service.
always complex


Notes

Note

  • 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_VERIFY and 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://docker-py.readthedocs.org/en/stable/machine/ for more details.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.