ansible-infra/roles/docker_compose/README.md
June 3840553f9d
Some checks failed
/ Ansible Lint (push) Successful in 2m9s
/ Ansible Lint (pull_request) Failing after 1m16s
docker_compose(role): add support for deploying optional .env file
This is needed for situations, where one wants to use a vendor-provided
compose file and configure it using environment variables.
Like for example:
https://github.com/zammad/zammad-docker-compose
2025-10-24 22:05:54 +02:00

1.6 KiB

Role docker_compose

A role for deploying a Docker-Compose-based application. It deploys the given Compose file, an optional .env file, as well as configuration files to the specified hosts and makes sure all services are up-to-date and running. The Compose file gets deployed to /ansible_docker_compose/compose.yaml, the .env file to /ansible_docker_compose/.env and the configuration files get deployed into the /ansible_docker_compose/configs/ directory. A use case for the deployment of the additional configuration files is Composes top-level element configs in conjunction with the configs option for services.

Supported Distributions

The following distributions are supported:

  • Debian 11

Required Arguments

For the required arguments look at the argument_specs.yaml.

hosts

The hosts for this role need to be the machines, for which you want to make sure the given Compose file is deployed and all services of it are up-to-date and running.