ansible-infra/roles/docker_compose

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.

Links & Resources

• https://docs.docker.com/compose/
• https://docs.docker.com/compose/compose-v2/
• https://docs.docker.com/compose/production/
• https://docs.docker.com/compose/startup-order/
• https://docs.docker.com/compose/compose-file/
• https://docs.docker.com/compose/compose-file/03-compose-file/
• https://docs.docker.com/compose/compose-file/08-configs/
• https://docs.docker.com/compose/compose-file/05-services/#configs
• https://docs.docker.com/engine/reference/commandline/compose_up/
• https://docs.docker.com/engine/reference/commandline/compose_ps/
• https://docs.docker.com/engine/reference/commandline/compose_down/