tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Define and run multi-container applications with Docker
4,587 Commits 25 Branches 262 Tags 66 MiB
Go 97%
Dockerfile 2.1%
Makefile 0.5%
HCL 0.3%
Go to file
Laura Brehm 898e1b605d
signals/utils: always handle received signals 
The changes in
dcbf005fe4
fixed the "cancellable context" detection, and made it so that Compose
would conditionally set up signal handling when the context was already
not cancellable/when the plugin was running through the CLI, as we'd
introduced a mechanism into the CLI to signal plugins to exit through a
socket instead of handling signals themselves.

This had some (not noticed at the time) issues when running through the
CLI as, due to sharing a process group id with the parent CLI process,
when a user CTRL-Cs the CLI will notify the plugin via the socket but
the plugin process itself will also be signalled if attached to the TTY.
This impacted some Compose commands that don't set up signal handling -
so not `compose up`, but other commands would immediately quit instead
of getting some "graceful" cancelled output.

We initially attempted to address this "double notification" issue in
the CLI by executing plugins under a new pgid so that they wouldn't be
signalled, but that posed an issue with Buildx reading from the TTY,
(see: https://github.com/moby/moby/issues/47073) so we reverted the
process group id changes and ended at a temporary solution in
https://github.com/docker/cli/pull/4792 where the CLI will only notify
plugins via the socket when they are not already going to be signalled
(when attached to a TTY).

Due to this, plugins should always set up some signal handling, which
this commit implements.

Signed-off-by: Laura Brehm <laurabrehm@hey.com>
 		2024-01-17 17:18:20 +00:00
.github gha: update DOCKER_CLI_VERSION to v24.0.7 2024-01-05 19:32:23 +01:00
cmd signals/utils: always handle received signals 2024-01-17 17:18:20 +00:00
docs make docs 2024-01-08 17:21:26 -06:00
internal watch: remove requirements for tar binary and for sync target to be rw 2024-01-09 15:43:34 +01:00
packaging packaging: Add EULA 2020-09-22 15:04:16 +02:00
pkg fix engine version require to use healthcheck.start_interval 2024-01-17 10:45:01 +01:00
.dockerignore Better sandboxed workflow and enhanced cross compilation 2022-08-12 15:05:58 +02:00
.gitattributes Removed test requiring linux containers 2020-06-11 12:58:58 +02:00
.gitignore use go 1.20 -cover support 2023-03-10 16:54:39 +00:00
.golangci.yml deps: remove deprecated github.com/pkg/errors 2023-09-29 06:28:58 +02:00
BUILDING.md docs: fix grammatical issues (#9997) 2022-11-29 10:52:22 -05:00
CONTRIBUTING.md let contributor know we might close unanswered issues 2023-11-23 11:06:31 +01:00
Dockerfile ci(deps): bump golangci-lint to v1.55.2 2024-01-10 12:56:48 -05:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
MAINTAINERS refresh Maintainers list 2023-01-28 06:37:17 +01:00
Makefile github.com/golang/mock is deprecated 2023-12-13 14:47:39 +01:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
README.md Update README.md to use standard compose.yaml file name 2023-11-30 08:53:44 +01:00
codecov.yml ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
docker-bake.hcl ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
go.mod build(deps): bump github.com/containerd/containerd from 1.7.11 to 1.7.12 (#11347) 2024-01-16 15:13:12 -05:00
go.sum build(deps): bump github.com/containerd/containerd from 1.7.11 to 1.7.12 (#11347) 2024-01-16 15:13:12 -05:00
logo.png move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00

README.md

Table of Contents

Docker Compose v2

GitHub release PkgGoDev Build Status Go Report Card Codecov OpenSSF Scorecard Docker Compose

Docker Compose is a tool for running multi-container applications on Docker defined using the Compose file format. A Compose file is used to define how one or more containers that make up your application are configured. Once you have a Compose file, you can create and start your application with a single command: docker compose up.

Where to get Docker Compose

Windows and macOS

Docker Compose is included in Docker Desktop for Windows and macOS.

Linux

You can download Docker Compose binaries from the release page on this repository.

Rename the relevant binary for your OS to docker-compose and copy it to $HOME/.docker/cli-plugins

Or copy it into one of these folders to install it system-wide:

  • /usr/local/lib/docker/cli-plugins OR /usr/local/libexec/docker/cli-plugins
  • /usr/lib/docker/cli-plugins OR /usr/libexec/docker/cli-plugins

(might require making the downloaded file executable with chmod +x)

Quick Start

Using Docker Compose is a three-step process:

  1. Define your app's environment with a Dockerfile so it can be reproduced anywhere.
  2. Define the services that make up your app in compose.yaml so they can be run together in an isolated environment.
  3. Lastly, run docker compose up and Compose will start and run your entire app.

A Compose file looks like this:

services:
  web:
    build: .
    ports:
      - "5000:5000"
    volumes:
      - .:/code
  redis:
    image: redis

Contributing

Want to help develop Docker Compose? Check out our contributing documentation.

If you find an issue, please report it on the issue tracker.

Legacy

The Python version of Compose is available under the v1 branch.