Define and run multi-container applications with Docker https://docs.docker.com/compose/
Find a file
Nicolas De Loof 19aa3d8604 fix(executor): make Create->Start a hard sequential barrier
run() used to dispatch every node concurrently, with Create-phase and
Start-phase cancellation scoped separately via phaseCancel so a
Start-phase failure couldn't cancel unrelated in-flight Create work.
That stopped short of what the interactive up convergence (lot 2's
next step) actually needs: its attach/printer session takes exclusive
hold of the terminal for the Create phase's own progress display, and
hands it over to continuous container log streaming only once the
Create phase is entirely done project-wide -- a Start-phase node's log
output interleaving with Create's progress bars has nowhere consistent
to go. Phase-scoped cancellation alone still let an unrelated
Start-phase node begin (and start logging) while a sibling elsewhere
in the plan was still being created, or had just failed.

run() now splits plan.Nodes into createNodes/startNodes upfront and
runs them as two fully sequential runPhase() calls: Start-phase nodes
are never even dispatched until every Create-phase node has succeeded,
and a Create-phase failure returns immediately without calling
runPhase on startNodes at all. This matches the old create()-then-
start() sequence's own fail-fast behavior, which the single-plan
migration had implicitly relaxed.

Added a fast-fail validation: a Create-phase node depending on a
Start-phase node would otherwise deadlock forever (the Start phase
isn't dispatched until the Create phase blocked on it returns, so
nothing would ever close that dependency's done channel). Nothing in
the reconciler should produce that edge, but failing fast with a clear
error beats a silent hang if it ever does.

TestExecutePlanCreatePhaseIsABarrierBeforeStartPhase and
TestExecutePlanCreatePhaseFailureNeverDispatchesStartPhase cover both
directions of the barrier; both verified by ablation (reverting to a
single concurrent runPhase call reliably fails each, 5/5 runs).

Verified: go build, go test ./pkg/compose/... (incl. -race), and
golangci-lint all clean; full e2e suite re-run clean against a locally
built binary (same 3 pre-existing, environment-specific failures as
the stack's baseline: TestWatch, TestIPC, TestComposeModel). Local
Copilot CLI review found no correctness/deadlock issues in the barrier
logic itself; its two actionable findings (missing phase-ordering
guard, missing never-dispatched regression test) are both addressed
here.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-10-15 14:52:20 +02:00
.github ci: add a ci-ok job aggregating the gating jobs 2026-10-12 11:55:20 +02:00
cmd fix(stats): bound the sampling and keep going when a container fails 2026-10-15 06:41:29 +02:00
desktop-module build and push Docker Desktop module image on release 2026-04-10 16:12:09 +02:00
docs feat(stats): add --all-projects and --aggregate flags 2026-10-15 06:41:29 +02:00
internal refactor(provider): move the provider plugin execution to internal/provider 2026-10-15 09:10:05 +02:00
pkg fix(executor): make Create->Start a hard sequential barrier 2026-10-15 14:52:20 +02:00
relay test: remove timing assumptions from TestBuildTLS and the relay streaming test 2026-10-12 11:55:20 +02: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 distinguish event (short) status text and details 2025-11-04 10:18:55 +01:00
.go-version Update to go1.26.9 2026-10-12 09:34:17 +02:00
.golangci.yml refactor(up): inject the navigation menu instead of importing cmd/formatter 2026-10-12 10:50:38 +02:00
AGENTS.md docs(ai-policy): adopt the centralized moby/.github AI usage policy 2026-09-29 15:46:11 +02:00
AI_POLICY.md docs(ai-policy): adopt the centralized moby/.github AI usage policy 2026-09-29 15:46:11 +02:00
BUILDING.md Add go as a prerequesite in build instructions 2025-08-06 15:27:09 +02:00
CLAUDE.md docs: adopt AGENTS.md standard, symlink CLAUDE.md to it 2026-07-21 17:43:06 +02:00
codecov.yml ci: merge Go coverage reports before upload (#10666) 2023-06-08 14:58:21 -04:00
CONTRIBUTING.md docs: remove broken CONTRIBUTING.md link 2026-10-08 08:20:34 +02:00
docker-bake.hcl ci: lint, vet and test relay/ as its own module 2026-09-17 09:23:54 +02:00
Dockerfile test: run the unit tests with the race detector 2026-10-12 11:55:20 +02:00
go.mod go.mod: keep go patch version at lowest possible 2026-10-15 09:37:20 +02:00
go.sum build(deps): bump golang.org/x/sync from 0.23.0 to 0.24.0 2026-10-13 10:31:22 +02:00
LICENSE Add LICENSE and NOTICE files 2020-08-17 10:20:49 +02:00
logo.png move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
Makefile build: pin gotestsum and gofumpt instead of resolving @latest 2026-10-12 11:55:20 +02:00
NOTICE move compose-cli code into docker/compose/v2 2021-08-31 19:09:19 +02:00
README.md README: remove Go Report Card badge 2026-07-16 11:39:14 +02:00

Table of Contents

Docker Compose

GitHub release PkgGoDev Build Status 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.

Note

Docker Swarm used to rely on the legacy compose file format but did not adopt the compose specification so is missing some of the recent enhancements in the compose syntax. After acquisition by Mirantis swarm isn't maintained by Docker Inc, and as such some Docker Compose features aren't accessible to swarm users.

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.