Documentation

PLEASE NOTE: This document applies to latest version and not to the latest stable release v2.21

Documentation for other releases can be found by using the version selector in the top right of any doc page.

docker_compose

Manage Docker Compose projects for multi-container applications.

Attributes

check_mode:
  support: full

Parameters

Parameter	Required	Type	Values	Description
project_src	true	string		Path to the docker-compose project directory.
state		string	absent present restarted started stopped	Desired state of the project.
services		array		List of specific services to manage.
scale		object		Scale mapping for services (e.g., {“web”: 3}).
pull		boolean		Pull images before starting.
build		boolean		Build images before starting.
files		array		List of compose files to use.
project_name		string		Custom project name.
remove_volumes		boolean		Remove volumes when removing project (state=absent).
remove_images		boolean		Remove images when removing project (state=absent).
remove_orphans		boolean		Remove orphans (containers not defined in compose file).
timeout		integer		Timeout in seconds for operations.
force_recreate		boolean		Force recreation of containers.
no_deps		boolean		Do not start linked services.

Example

- name: Start a docker-compose project
  docker_compose:
    project_src: /app
    state: started

- name: Stop a docker-compose project
  docker_compose:
    project_src: /app
    state: stopped

- name: Remove a docker-compose project
  docker_compose:
    project_src: /app
    state: absent

- name: Restart a docker-compose project
  docker_compose:
    project_src: /app
    state: restarted

- name: Start specific services
  docker_compose:
    project_src: /app
    state: started
    services:
      - web
      - db

- name: Pull images before starting
  docker_compose:
    project_src: /app
    state: started
    pull: true

- name: Scale services
  docker_compose:
    project_src: /app
    state: started
    scale:
      web: 3
      worker: 5

- name: Use a specific compose file
  docker_compose:
    project_src: /app
    files:
      - docker-compose.yml
      - docker-compose.prod.yml
    state: started

- name: Build images before starting
  docker_compose:
    project_src: /app
    state: started
    build: true

- name: Start with a custom project name
  docker_compose:
    project_src: /app
    project_name: myproject
    state: started