Docker-compose

Docker Compose is a tool available since October 2014 for defining and running multi-container Docker applications.

Rules are defined in docker-compose.yml and executed by running docker-compose up command.

docker-compose allows to define start order dependencies between containers.

For reference of valid options for docker compose check: https://docs.docker.com/compose/compose-file/

Installation

Available for macOS, Linux and Windows

• macOS: brew install docker-compose
• Linux:
  • pip install docker-compose
  • apt install docker-compose

Basic commands

• docker-compose -h (for list of commands and options)

• docker-compose --log-level

• docker-compose up Builds, (re)creates, starts, and attaches to containers for a service.

docker-compose up SERVICE_NAME

docker-compose up -d

-d daemon

docker-compose -f docker-compose_YOUR_NAME.yml up -d

• Start your containers with a command line variable:

YOUR_VARIABLE=YOUR_VALUE docker-compose up

• docker-compose -p YOUR_PROJECT_NAME or [[docker-compose --project-name YOUR_PROJECT_NAME

Logs

• docker-compose logs View output from containers
  • docker-compose logs -f View output from containers
• docker-compose pull SERVICE_NAME or docker-compose pull
  • docker-compose --verbose pull
• docker-compose version

All commands

docker-compose

• docker-compose build
• docker-compose bundle
• docker-compose config
• docker-compose create (deprecated)
• docker-compose down

docker-compose down --remove-orphans

docker-compose down --volumes

• docker-compose events
• docker-compose exec
• docker-compose help
• docker-compose images
• docker-compose kill
• docker-compose logs: docker-compose logs SERVICE_NAME (You will find your SERVICE_NAME looking into your docker-compose.yml file)
• docker-compose pause
• docker-compose port
• docker-compose ps
• docker-compose pull.docker-compose pull SERVICE_NAME. Just pull container images but do not start them. To update your image and start your services: docker-compose pull && docker-compose up -d
• docker-compose push
• docker-compose restart
• docker-compose rm
• docker-compose run
• docker-compose scale
• docker-compose start
• docker-compose stop
• docker-compose top (Feb 2017)
• docker-compose unpause
• docker-compose up
• docker-compose version

Operations:

• docker-compose: [ start | stop | restart | pull | up | down | ps ]

Activities

Basic

1. Read docker-compose StackOverflow questions: https://stackoverflow.com/questions/tagged/docker-compose?tab=Votes
2. Read docker-compose changelog: https://github.com/docker/compose/blob/master/CHANGELOG.md
3. Review docker compose file format evolution

Advanced

1. Read docker-compose source code: https://github.com/docker/compose
2. Read Ansible module documentation about docker_compose: https://docs.ansible.com/ansible/latest/modules/docker_compose_module.html
3. Learn to use extension-fields or templating added in 3.4 version.

Related terms

• --force-recreate
• /etc/docker/daemon.json
• volumes:
• links:
• environment:
• Nomad
• Mediawiki official docker-compose example

See also

• docker stack and docker swarm commands
• docker-compose, docker-compose.yml: [services | volumes | networks | up | down | restart | logs | create | changelog | version | secrets | config | -v | -h | exec], docker-compose pull, Environment:, Docker-compose.yml examples, .env, release notes, expose:, docker-compose --env-file, services.deploy.resources
• Docker: docker-compose, Docker Desktop, Docker Scout, Docker Swarm, Docker Volumes, Docker images management, docker network, docker inspect, docker volume inspect, Dockerfile, Docker Engine release notes,docker kill, moby, Docker-in-Docker, docker context, buildx, docker tag, docker system prune, Docker Hub, hub-tool, /etc/docker/daemon.json, hostconfig.json, dockerd, logs, Docker logging, Backup, docker service, depends on, --dns, --filter, --mount, docker login, docker build, apt remove docker.io, .dockerignore, docker context ls | docker-machine, .docker/, PWD, $HOME/.docker/config.json, Docker ID, --env-file, docker --help

Text is available under the Creative Commons Attribution-ShareAlike License; additional terms may apply. By using this site, you agree to the Terms of Use and Privacy Policy.

Source: https://en.wikiversity.org/wiki/DevOps/Docker/docker_compose