CCCHH/ansible-infra
CCCHH/ansible-infra
2
2
Fork 2
Code Issues 7 Pull requests 4 Wiki Activity Actions
ansible-infra/roles/docker_compose/README.md
June 652aa32e21
Some checks failed
/ Ansible Lint (push) Failing after 40s
Details
docker_compose(role): document new build and pull arguments
2026-01-25 20:49:39 +01:00

2.1 KiB
Raw Blame History

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

Should work on Debian-based distributions.

Required Arguments

  • docker_compose__compose_file_content: The content to deploy to the Compose file at /ansible_docker_compose/compose.yaml.

Optional Arguments

  • docker_compose__env_file_content: The content to deploy to the .env file at /ansible_docker_compose/.env.
  • docker_compose__configuration_files: A list of configuration files to deploy to the /ansible_docker_compose/configs/ directory.
  • docker_compose__configuration_files.*.name: The name of the configuration file.
  • docker_compose__configuration_files.*.content: The content to deploy to the configuration file.
  • docker_compose__build: Whether or not to build images before starting containers.
    Defaults to always.
  • docker_compose__pull: Whether or not to pull images before starting containers.
    Defaults to always.

Links & Resources