Difference between revisions of "Docker compose"
Jump to navigation
Jump to search
| (13 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | [[wikipedia:Docker_(software)#Tools|Docker Compose]]<ref>https://docs.docker.com/compose/</ref> is a tool available since 2014 for defining and running multi-container Docker applications. | + | [[wikipedia:Docker_(software)#Tools|Docker Compose]]<ref>https://docs.docker.com/compose/</ref> is a tool available since [[2014]] for defining and running multi-container Docker applications. |
| − | Rules are defined in <code>[[ | + | Rules are defined in <code>[[docker-compose.yml]]</code> and executed by running <code>[[docker-compose up]]</code>. |
<code>docker-compose</code> allows to define start order dependencies between containers. | <code>docker-compose</code> allows to define start order dependencies between containers. | ||
| Line 12: | Line 12: | ||
== Basic commands == | == Basic commands == | ||
* <code>docker-compose -h</code> (for list of commands and options) | * <code>docker-compose -h</code> (for list of commands and options) | ||
| − | * <code>docker-compose up</code> | + | * <code>[[docker-compose up]]</code> |
* <code>docker-compose up -d</code> | * <code>docker-compose up -d</code> | ||
:-d daemon | :-d daemon | ||
| Line 21: | Line 21: | ||
Logs: | Logs: | ||
| − | * <code>docker-compose logs</code> View output from containers | + | * <code>[[docker-compose logs]]</code> View output from containers |
* <code>docker-compose logs -f</code> View output from containers | * <code>docker-compose logs -f</code> View output from containers | ||
* <code>[[docker-compose pull]] SERVICE_NAME</code> or <code>docker-compose pull</code>. <ref>https://docs.docker.com/compose/reference/pull/</ref>. See also: <code>[[docker images]]</code> | * <code>[[docker-compose pull]] SERVICE_NAME</code> or <code>docker-compose pull</code>. <ref>https://docs.docker.com/compose/reference/pull/</ref>. See also: <code>[[docker images]]</code> | ||
| Line 38: | Line 38: | ||
*<code>docker-compose logs</code><ref>https://docs.docker.com/compose/reference/logs/</ref>: <code>docker-compose logs SERVICE_NAME</code> (You will find your SERVICE_NAME looking into your docker-compose.yml file) | *<code>docker-compose logs</code><ref>https://docs.docker.com/compose/reference/logs/</ref>: <code>docker-compose logs SERVICE_NAME</code> (You will find your SERVICE_NAME looking into your docker-compose.yml file) | ||
*<code>docker-compose pause</code> | *<code>docker-compose pause</code> | ||
| − | *<code>docker-compose port</code> | + | * <code>[[docker-compose port]]</code> |
*<code>docker-compose ps</code> | *<code>docker-compose ps</code> | ||
*<code>docker-compose pull</code><ref>https://docs.docker.com/compose/reference/pull/</ref>.<code>docker-compose pull SERVICE_NAME</code>. Just pull container images but do not start them. To update your image and start your services: <code>docker-compose pull && docker-compose up -d</code> | *<code>docker-compose pull</code><ref>https://docs.docker.com/compose/reference/pull/</ref>.<code>docker-compose pull SERVICE_NAME</code>. Just pull container images but do not start them. To update your image and start your services: <code>docker-compose pull && docker-compose up -d</code> | ||
| Line 46: | Line 46: | ||
*<code>docker-compose run</code> | *<code>docker-compose run</code> | ||
*<code>docker-compose scale</code> | *<code>docker-compose scale</code> | ||
| − | *<code>[[ | + | *<code>[[docker-compose start]]</code> |
*<code>docker-compose stop</code> | *<code>docker-compose stop</code> | ||
| − | *<code>[[ | + | *<code>[[docker-compose top]]</code> |
*<code>docker-compose unpause</code> | *<code>docker-compose unpause</code> | ||
*<code>docker-compose up</code> | *<code>docker-compose up</code> | ||
| Line 57: | Line 57: | ||
=== Basic === | === Basic === | ||
# Read <code>docker-compose</code> StackOverflow questions: https://stackoverflow.com/questions/tagged/docker-compose?tab=Votes | # Read <code>docker-compose</code> StackOverflow questions: https://stackoverflow.com/questions/tagged/docker-compose?tab=Votes | ||
| − | # Read <code>docker-compose</code> [[Docker compose changelog|changelog]]: https://github.com/docker/compose/blob/master/CHANGELOG.md | + | # Read <code>docker-compose</code> [[Docker compose changelog|changelog]]/release notes: https://github.com/docker/compose/blob/master/CHANGELOG.md |
| − | # [[ | + | # [[Review docker compose file format evolution]] |
=== Advanced === | === Advanced === | ||
| Line 64: | Line 64: | ||
# Read [[DevOps/Ansible/Modules|Ansible module]] documentation about <code>docker_compose</code>: https://docs.ansible.com/ansible/latest/modules/docker_compose_module.html | # Read [[DevOps/Ansible/Modules|Ansible module]] documentation about <code>docker_compose</code>: https://docs.ansible.com/ansible/latest/modules/docker_compose_module.html | ||
# Learn to use extension-fields<ref>https://docs.docker.com/compose/compose-file/#extension-fields </ref> or templating added in 3.4 version. <ref>https://www.oreilly.com/ideas/3-docker-compose-features-for-improving-team-development-workflow</ref> | # Learn to use extension-fields<ref>https://docs.docker.com/compose/compose-file/#extension-fields </ref> or templating added in 3.4 version. <ref>https://www.oreilly.com/ideas/3-docker-compose-features-for-improving-team-development-workflow</ref> | ||
| + | |||
| + | == Related == | ||
| + | * <code>[[--env-file]]</code> https://docs.docker.com/compose/environment-variables/#using-the---env-file--option | ||
| + | * [[labels]] | ||
== See also == | == See also == | ||
| − | * | + | * {{docker-compose}} |
| − | |||
* {{docker}} | * {{docker}} | ||
| − | |||
{{CC license}} | {{CC license}} | ||
| Line 77: | Line 79: | ||
[[Category:Software development]] | [[Category:Software development]] | ||
[[Category:Server administration]] | [[Category:Server administration]] | ||
| + | [[Category:Docker]] | ||
Latest revision as of 09:27, 21 April 2024
Docker Compose[1] is a tool available since 2014 for defining and running multi-container Docker applications.
Rules are defined in docker-compose.yml and executed by running docker-compose up.
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/
Contents
Installation[edit]
brew install docker-compose
Basic commands[edit]
docker-compose -h(for list of commands and options)docker-compose updocker-compose up -d
- -d daemon
- Start your containers with a command line variable:
YOUR_VARIABLE=YOUR_VALUE docker-compose up[2]
docker-compose -p NAME --project-name
Logs:
docker-compose logsView output from containersdocker-compose logs -fView output from containersdocker-compose pull SERVICE_NAMEordocker-compose pull. [3]. See also:docker images
docker-compose builddocker-compose bundledocker-compose configdocker-compose createdocker-compose down
docker-compose down --remove-orphans
docker-compose eventsdocker-compose execdocker-compose helpdocker-compose imagesdocker-compose killdocker-compose logs[4]:docker-compose logs SERVICE_NAME(You will find your SERVICE_NAME looking into your docker-compose.yml file)docker-compose pausedocker-compose portdocker-compose psdocker-compose pull[5].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 -ddocker-compose pushdocker-compose restartdocker-compose rmdocker-compose rundocker-compose scaledocker-compose startdocker-compose stopdocker-compose topdocker-compose unpausedocker-compose up
Docker compose file: docker-compose.yml[edit]
Activities[edit]
Basic[edit]
- Read
docker-composeStackOverflow questions: https://stackoverflow.com/questions/tagged/docker-compose?tab=Votes - Read
docker-composechangelog/release notes: https://github.com/docker/compose/blob/master/CHANGELOG.md - Review docker compose file format evolution
Advanced[edit]
- Read
docker-composesource code: https://github.com/docker/compose - Read Ansible module documentation about
docker_compose: https://docs.ansible.com/ansible/latest/modules/docker_compose_module.html - Learn to use extension-fields[6] or templating added in 3.4 version. [7]
Related[edit]
--env-filehttps://docs.docker.com/compose/environment-variables/#using-the---env-file--option- labels
See also[edit]
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
- ↑ https://docs.docker.com/compose/
- ↑ https://www.oreilly.com/ideas/3-docker-compose-features-for-improving-team-development-workflow
- ↑ https://docs.docker.com/compose/reference/pull/
- ↑ https://docs.docker.com/compose/reference/logs/
- ↑ https://docs.docker.com/compose/reference/pull/
- ↑ https://docs.docker.com/compose/compose-file/#extension-fields
- ↑ https://www.oreilly.com/ideas/3-docker-compose-features-for-improving-team-development-workflow
Advertising:
