149 KiB
| title | description | keywords | toc_max | aliases | |
|---|---|---|---|---|---|
| Docker Compose release notes | Release notes for Docker Compose | release notes, compose | 2 |
|
{{< include "compose-eol.md" >}}
For more detailed information, see the release notes in the Compose repo.
2.24.5
{{< release-date date="2024-01-30" >}}
Bug fixes and enhancements
- Fixed "failed to solve: changes out of order" errors when building images on Windows.
2.24.4
{{< release-date date="2024-01-29" >}}
Update
- Dependencies upgrade: bump cli to 25.0.1
- Dependencies upgrade: bump docker to 25.0.1
- Dependencies upgrade: bump compose-go to 2.0.0-rc.3
Bug fixes and enhancements
- Fixed issue when checking external network existence when swarm is enabled.
- Added support for
storage_optattribute.
2.24.3
{{< release-date date="2024-01-24" >}}
This release fixes a build issue with Docker Desktop for Windows introduced in Compose v2.24.0.
Update
- Compose now uses a custom version of
fsutilslibrary.
2.24.2
{{< release-date date="2024-01-22" >}}
Update
- Dependencies upgrade: bump cli to 25.0.0 GA
- Dependencies upgrade: bump compose-go to 2.0.0-rc.2
2.24.1
{{< release-date date="2024-01-18" >}}
Update
- Dependencies upgrade: bump cli to 25.0.0-rc3
- Dependencies upgrade: bump docker to 25.0.0-rc3
- Dependencies upgrade: bump compose-go to 2.0.0-rc.1
- Dependencies upgrade: bump containerd to 1.7.12
Bug fixes and enhancements
- Reworked the display of container status during
up - Fixed the engine version required to use
healthcheck.start_interval - Removed
watchsubcommand from thealphacommand - Fixed a bug when handling received signals
2.24.0
{{< release-date date="2024-01-11" >}}
Update
- Dependencies upgrade: bump cli to 25.0.0-beta.3
- Dependencies upgrade: bump compose-go to 2.0.0-beta.3
- Dependencies upgrade: bump golang to 1.21.6
Bug fixes and enhancements
- Introduced
docker compose attachto attach local standard input, output, and error streams to a service's running container. - Introduced
docker compose statsto display a live stream of container(s) resource usage statistics. - Introduced
docker compose ps --orphansto include/exclude services not declared. - Introduced
docker compose logs --indexto select a replica container. - Introduced
docker compose build --with-dependenciesto also build dependencies. - Added source policies for build.
- Included disabled services for shell completion.
- Restored
Projectin ps JSON output. - Added OCI 1.0 fallback support for AWS ECR.
- Build now does not require environment to be resolved.
- Compose now sends out a cancel event on SIGINT/SIGTERM signal for
compose up. - Fixed log by exposing services ports when
--verbose. - Fixed inlined and environment-defined configs to be mounted under /<id> until an explicit target is set.
- Fixed combination of
--pull always --no-build. - Fixed race condition in log printer.
- Fixed
docker compose upteardown when command context is cancelled.
2.23.3
{{< release-date date="2023-11-22" >}}
Update
- Dependencies upgrade: bump buildx to v0.12.0
2.23.2
{{< release-date date="2023-11-21" >}}
Update
- Dependencies upgrade: bump buildkit 0.12.3
- Dependencies upgrade: bump docker 24.0.7
- Dependencies upgrade: bump cli 24.0.7
- Dependencies upgrade: bump 1.20.2
Bug fixes and enhancements
- Compose now supports
builds.tagswithpushcommand. - Compose Watch now re-builds service images at startup.
- Now
--remove-orphansdoesn't manage disabled services as orphaned. - Compose displays
Buildingoutput log only if there is at least one service to build.
2.23.1
{{< release-date date="2023-11-16" >}}
Update
- Dependencies upgrade: bump compose-go to v1.20.1
Bug fixes and enhancements
- Aligned Compose with OCI artifact best practices.
- Introduced
--resolve-image-digestsso users can seal service images by digest when publishing a Compose application. - Improved Compose Watch configuration logging.
- Compose now rejects a Compose file using
secrets|configs.driverortemplate_driver. - Compose now fails to start if a dependency is missing.
- Fixed SIGTERM support to stop/kill stack.
- Fixed a
--hashregression. - Fixed "Application failed to start after update" when an external network is on a watched service.
- Fixed
--pulldocumentation. - Fixed display by adding newline in cmd/compose/build.go.
- Compose is rendered quiet after filtering applied.
- Stripped project prefix from docker-compose up output.
2.23.0
{{< release-date date="2023-10-18" >}}
Update
- Dependencies upgrade: bump compose-go to v1.20.0
- Dependencies upgrade: bump containerd to 1.7.7
Bug fixes and enhancements
- Added dry-run support for publish command
- Added
COMPOSE_ENV_FILESenv variable to pass a list of env files - Added
sync+restartaction tocompose watch - Aligned
compose psoutput with Docker CLI by default and introduced--no-truncto keep the previous behaviour - Fixed hashes inconsistency between
upandconfigure - Enabled profiles when
downran with explicit service names - Fixed an issue when the pull policy provided was invalid
2.22.0
{{< release-date date="2023-09-21" >}}
Note
The
watchcommand is now generally available (GA). You can directly use it from the root commanddocker compose watch. For more information, see File watch.
Update
- Dependencies upgrade: bump golang to 1.21.1
- Dependencies upgrade: bump compose-go to v1.19.0
- Dependencies upgrade: bump buildkit to v0.12.2
Bug fixes and enhancements
- Added experimental support for the
publishcommand. - The command
watchnow builds and launches the project during startup. - Added
policyoption to the--pullflag. - Fixed various race and deadlock conditions for
upcommand on exit. - Fixed multi-platform issues on build.
- Enabled services that are explicitly requested even when their
profilesaren't activated. - Fixed a
configissue when the declaredenv_fileis missing. - Passed BuildOptions to
upandruncommands.
2.21.0
{{< release-date date="2023-08-30" >}}
Note
The format of
docker compose psanddocker compose ps --format=jsonchanged to better align withdocker psoutput. See compose#10918.
Update
- Dependencies upgrade: bump compose-go to v1.18.3
Bug fixes and enhancements
- Changed
docker compose psanddocker compose ps --format=jsonoutput to align with Docker CLI. - Added support for multi-document YAML files.
- Added support for loading remote Compose files from Git repos with
include(experimental). - Fixed incorrect proxy variables during build.
- Fixed truncated container logs on container exit.
- Fixed "no such service" errors when using
includewith--profile. - Fixed
.envoverrides when usinginclude.
2.20.3
{{< release-date date="2023-08-11" >}}
Update
- Dependencies upgrade: bump golang to 1.21.0
- Dependencies upgrade: bump compose-go to v1.18.1
- Dependencies upgrade: bump buildkit to v0.12.1
Bug fixes and enhancements
- Improved speed and reliability of
watchsync. - Added builder's name on the first build line.
- Improved shell completion for
--project-directoryand--profile. - Fixed build issue with proxy configuration not passing to legacy builder.
- Removed unnecessary warning when an option dependency exists successfully.
2.20.2
{{< release-date date="2023-07-19" >}}
Bug fixes and enhancements
- Added support for the
depends_on.requiredattribute. - Fixed an issue where build tries to push unnamed service images.
- Fixed a bug which meant the target secret path on Windows was not checked.
- Fixed a bug resolving build context path for services using
extends.file.
2.20.1
{{< release-date date="2023-07-18" >}}
Update
- Dependencies upgrade: bump golang to 1.20.6
- Dependencies upgrade: bump buildx to v0.11.2
- Dependencies upgrade: bump buildkit to v0.12
- Dependencies upgrade: bump docker-cli to v24.0.5-dev
2.20.0
{{< release-date date="2023-07-11" >}}
Update
- Dependencies upgrade: bump docker/cli-docs-tools to v0.6.0
- Dependencies upgrade: bump docker to v24.0.4
- Dependencies upgrade: bump buildx to v0.11.1
Bug fixes and enhancements
- Introduced the
waitcommand. - Added support of
--builderandBUILDX_BUILDERto thebuildcommand. - Added support for the
includeandattachattributes from the Compose Specification. - Fixed a DryRun mode issue when initializing CLI client.
- Fixed a bug with random missing network when a service has more than one.
- Fixed the Secrets file permission value to comply with the Compose Specification.
- Fixed an issue about
no-depsflag not being applied. - Fixed some source code comments.
- Fixed a bug when
--indexis not set select. - Fixed a process leak in the wait e2e test.
- Improved some test speeds.
2.19.1
{{< release-date date="2023-06-29" >}}
Update
- Dependencies upgrade: bump compose-go to v1.15.1
Bug fixes and enhancements
- Fixed sporadic "container not connected to network" errors on
compose up. - Fixed "please specify build context" errors on
compose build. - Compose now warns if using a bind mount in a service
watchconfiguration.
2.19.0
{{< release-date date="2023-06-21" >}}
Update
- Dependencies upgrade: bump compose-go to v1.15.0
- Dependencies upgrade: bump buildx to v0.11.0
- Dependencies upgrade: bump docker to v24.0.2
- Dependencies upgrade: bump golang to 1.20.5
Bug fixes and enhancements
- Introduced the ability to select a single service to be stopped by
compose down. - Added
--progressas top-level flag to configure progress UI style. - Introduced
run --cap-addto run maintenance commands using service image. - Fixed a bug during detection of swarm mode.
- Fixed a bug when setting the project name via
COMPOSE_PROJECT_NAMEenvironment variable. - Adjusted the display of the volumes flag with the help of
downcommand. - Fixed a bug in the
upcommand which should not silently ignore missingdepends_onservices. - Aligned forward signal to container behaviour with the
docker runone. - Compose now detects network name conflict.
- Fixed a typo in the warning message about an existing volume.
- Compose now detects new services started after
compose -p x logs -fcommand. - Fixed a bug when
composewas used as project name. - Fixed a bug in the
watchcommand when a directory does not exist. - Removed default timeout of 10 seconds when restarting or stopping services.
- Fixed a bug in
watchwhich applied the "rebuild" strategy by default. - Fixed a race condition, waiting for containers when one exit.
- Added a warning telling users that uid,gid,mode are not implemented for
build.secrets. - Fixed a bug in
watchwhich was watching the whole build context instead of only configured paths. - Compose now sorts containers by creation date to scale down the older ones first.
- Fixed a bug in the docs generation task for Windows environments.
- Updated the docs to reflect Dry Run mode is feature complete.
- Improved the diagnostic message on network label mismatch.
- Fixed a bug which was rendering
Buildingsection when there was no build involved. - Fixed a bug in code coverage metrics.
- Added OTEL initialization.
- Added a GitHub action to trigger Docker Desktop e2e tests with Compose edge versions.
- Added more ignore rules to dependabot.
2.18.1
{{< release-date date="2023-05-17" >}}
Bug fixes and enhancements
- Fixed "Image not found" errors when building images
2.18.0
{{< release-date date="2023-05-16" >}}
Update
- Dependencies upgrade: bump compose-go to v1.13.5
- Dependencies upgrade: bump buildkit to v0.11.6
- Dependencies upgrade: bump docker to v23.0.5
Bug fixes and enhancements
- Added dry run support using
--dry-run - Added the first (alpha) implementation of the
vizsub-command - Introduced
--no-path-resolutionto skip relative path to be resolved - Introduced
COMPOSE_ANSIto define the--ansidefault value - Introduced
COMPOSE_STATUS_STDOUTto get status messages sent to stdout - Fixed the BuildKit progressui integration
- Fixed a bug to stop blocking the events loop collecting logs
- Restored support for
--memory - Fixed a bug which meant containers didn't stop after termination
- Compose now lets users declare the build secret target
- Fixed a bug which caused a container to be recreated when the config has not changed
- Fixed a race condition when
--parallelis used with a large number of dependent services - Compose now checks the local image matches the required platform
- Fixed local image removal when
compose downis ran with--project-name - Compose now detects the active endpoint trying to remove the network and skips with a warning
- Removed unnecessary [] output
- Compose detects that a Windows terminal is not a
console.Fileto avoid a panic --parallelnow has precedence overCOMPOSE_PARALLEL_LIMIT- Compose now reports that the external network is not found when Swarm is disabled
2.17.2
{{< release-date date="2023-03-26" >}}
Update
- Dependencies upgrade: bump compose-go to v1.13.2
Bug fixes and enhancements
- Fixed invalid project name error for directories with uppercase characters or
.in the name. Fixed compose#10405
2.17.1
{{< release-date date="2023-03-24" >}}
Update
- Dependencies upgrade: bump buildkit to v0.11.5
- Dependencies upgrade: bump compose-go to v1.13.1
- Dependencies upgrade: bump golang to 1.20.2
Bug fixes and enhancements
- Fixed panic on
alpha watchcommand. Pull Request compose#10393 - Prevented conflicts for services named
extensions. Fixed compose-go#247 - Compose now validates project names more consistently. Fixed compose-go#363
2.17.0
{{< release-date date="2023-03-23" >}}
Upgrade notes
- Project name validation is more strictly enforced. Project names can only include letters, numbers,
_,-and must be lowercase and start with a letter or number. - Boolean fields in YAML must be either
trueorfalse. Deprecated YAML 1.1 values such as "on" or "no" are not supported. - Duplicate YAML merge keys (
<<) are rejected.
Update
- Dependencies upgrade: bump buildkit to v0.11.4
- Dependencies upgrade: bump buildx to v0.10.4
- Dependencies upgrade: bump containerd to 1.6.18
- Dependencies upgrade: bump compose-go to v1.13.0
Bug fixes and enhancements
- Introduced
--wait-timeoutonupcommand. Fixed compose#10269 - Made
compose service --hashoutput sort by service name. Pull Request compose#10278 - Compose now renders a compact TUI progress report to monitor layers download. Pull Request compose#10281
- Introduced
restartfordepends_on. Fixed compose#10284 - Added support of
NO_COLORenv var. Fixed compose#10340 - Progress writer now uses
dockercli.Errstream. Fixed compose#10366 - Added support for
additional_contextsin thebuildservice configuration. Fixed compose#9461 compose#9961 - Added file delete/rename handling in
watchmode. Pull Request compose#10386 - Introduced an
ignoreattribute inwatchmode. Pull Request compose#10385 - Compose now uses progress writer to show copies status. Pull Request compose#10387
- Updated reference documentation for
-p/--project-nameflag. Fixed docs#16915, compose-spec#311 - Introduced a
replacelabel to track the relationship between old and new containers of a service. Fixed compose#9600 - Fixed a bug that meant dependent services were not restarted after a service was restarted. Fixed compose#10263
- Compose now ignores services without a build section in
watchmode. Fixed compose#10270 - Compose now applies config options for pseudo-subcommands. Fixed compose#10286
- Compose manages only containers with config_hash labels (i.e, created by compose). Fixed compose#10317
- Compose triggers an error if the project name is empty after normalization. Fixed compose#10313
- Compose restarts only needed services by checking
depends_onrelations. Fixed compose#10337 - Fixed a display issue on small terminals. Fixed compose#10322
- Fixed an issue with building the built images IDs collection. Pull Request compose#10372
- Use configured name separator to define oneoff container name. Fixed compose#10354
- Fixed concurrent map read/write issue when recreating containers. Fixed compose#10319
- Compose now supports Dry Run mode for
stopandrmcommands. Pull Request compose#10257 - Compose now supports Dry Run mode for
pullcommand. Pull Request compose#10341 - Compose now supports Dry Run mode for
pushcommand. Pull Request compose#10355 - Compose now supports Dry Run mode for
execcommand. Pull Request compose#10252 - Compose now supports Dry Run mode for
restartcommand. Pull Request compose#10339
2.16.0
{{< release-date date="2023-02-08" >}}
Update
- Dependencies upgrade: bump docker to v23.0.0
- Dependencies upgrade: bump docker-cli to v23.0.0
- Dependencies upgrade: bump buildkit to v0.11.2
- Dependencies upgrade: bump buildx to v0.10.2
- Dependencies upgrade: bump containerd to 1.6.16
- Dependencies upgrade: bump golang to 1.20
Bug fixes and enhancements
- Introduced
--remove-orphansfor thecompose createcommand. Fixed compose#9718 - Shortened the TTY output when the terminal is too small. Fixed compose#9962
- Added
remove-orphansfunctionality to run. Fixed compose#9718 - Introduced the experimental
watchcommand. Pull Request compose#10163 - Compose now allows TTY to be allocated with
-t. Fixed compose#10161 - Introduced the experimental
dry-runcommand. Pull Request compose#10173 - Updated the documentation to explain ways to configure parallelism. Pull Request compose#10198
- Aligned the
logscommand with docker CLI by aliasing-nfor--tail. Fixed compose#10199 - Added support for
docker compose build --push. Pull Request compose#10148 - Added
--scaleto thecompose createcommand. Fixed compose#10208 - Renamed
converttoconfigto align with the Compose V1 UX. Pull Request compose#10214 - Compose now passes the proxy config as build args. Fixed compose#8797
- Fixed parsing issue in
compose upby ignoring containers not created by Compose. Fixed compose#10162 - Fixed the goroutine leak in log formatter initialization. Fixed compose#10157
- Fixed an issue where compose logs don't exit when all running containers have been stopped. Pull Request compose#10181
- Fixed the documentation to reflect
docker compose psbeing aligned withdocker ps. Pull Request compose#10195 - Fixed an issue where the remote Buildx driver was not found. Fixed compose#9893
- Improved logging when recreating a service container. Pull request compose#10236
- Fixed an issue so Compose now only waits for containers concerned by the wait condition. Fixed compose#10200
- Compose now prevents assignment to entry in nil map. Fixed compose#10244
- Added a dedicated GitHub Action workflow for Cucumber tests. Pull Request compose#10165
- Cleaned the TUI lines when switching in compact log mode. Fixed compose#10201
- Added Tilt watcher to detect code changes in watch mode. Pull Request compose#10218
- Compose now supports Dry Run mode for
killcommand. Fixed compose#10210 - Compose now supports Dry Run mode for
pausecommand.Fixed compose#10217 - Compose now supports Dry Run mode for
cpcommand.Fixed compose#10235
2.15.1
{{< release-date date="2023-01-09" >}}
Update
- Dependencies upgrade to fix Golan CVE-2022-27664 and CVE-2022-32149
Bug fixes and enhancements
- Added support for UTS namespace. Fixed compose#8408
- Fixed filtering issue when no filter set. Fixed roadmap#418
- Fixed concurrent map writes issue during build step. Pull Request compose#10151
- Fixed issue when stdin is not a terminal. Fixed compose#9739
2.15.0
{{< release-date date="2023-01-05" >}}
Update
- Dependencies upgrade: bump compose-go to v1.8.1
- Dependencies upgrade: bump cli-docs-tool to 0.5.1
Bug fixes and enhancements
- Added support of the
privilegedattribute in theservice.buildsection. Pull Request compose#10112 - Introduced
--ignore-buildableto ignore buildable images on pull. Fixed compose#8805 - Introduceed
--no-attachto ignore some service outputs. Fixed compose#8546 - Fixed issue with
logswhendriver:noneis set. Fixed compose#9030 - Compose now relies on dockerCLI.streams. Pull Request compose#10082
- Fixed issue with service hash that MUST exclude replicas. Fixed compose#10077
- Compose now checks service names based on project, not running containers. Fixed compose#9951
- Fixed security opts support (seccomp and unconfined). Fixed compose#9505
- Fixed empty file when using compose config in case of smaller source files. Fixed compose#10121
- Fixed issue with
--pullnot applied oncompose up. Fixed compose#10125 - Compose should ignore not only auto-removed containers but also "removal in progress" for orphan containers. Pull Request compose#10136
- Compose limits build concurrency according to
--parallel. Fixed compose#9091
2.14.2
{{< release-date date="2022-12-20" >}}
Update
- Dependencies upgrade: bump containerd to 1.6.14
Bug fixes and enhancements
- Compose now uses DOCKER_DEFAULT_PLATFORM to determine the platform when creating a container. Fixed compose#10041
- Compose now detects when dependency failed to start. Fixed compose#9732
- Fixed WCOW volume mounts. Fixed compose#9577
- List only running containers when using
--all=false. Fixed compose#10085 - Fixed a regression when running pull
--ignore-pull-failures. Fixed compose#10089 - Fixed CPU quota issue. Fixed compose#10073
- Fixed race condition on compose logs. Fixed compose#8880
- Updated projectOptions to be public by renaming it to ProjectOptions. Fixed compose#100102
2.14.1
{{< release-date date="2022-12-15" >}}
Updates
- Dependencies upgrade: bump Go to 1.19.4
- Dependencies upgrade: bump containerd to 1.6.12
Bug fixes and enhancements
- Added
--parallelto limit concurrent engine calls. Pull Request compose#10030 - Distinguished stdout and stderr in
uplogs. Fixed compose#8098 - Aligned
compose psoutput withdocker ps. Fixed compose#6867 - Added
--include-depsto push command. Pull Request compose#10044 - Introduced
--timestampoption oncompose up. Fixed compose#5730 - Compose now applies uid/gid when creating a secret from the environment. Pull Request compose#10084
- Fixed deadlock when waiting for attached-dependencies. Fixed compose#10021
- Fixed race condition when collecting pulled images IDs. Fixed compose#9897
- Compose doesn't stop the
pullcommand for images that can be built. Fixed compose#8724 - Fixed corner case when there's no container to attach to. Fixed compose#8752
- Compose containers' startup must run sequentially for engine to assign distinct ports within a configured range. Fixed compose#8530
- Fixed parsing of
repository:tag. Fixed compose#9208 - Load project from files when explicitly set by user. Fixed compose#9554
2.14.0
{{< release-date date="2022-12-02" >}}
Updates
- Dependencies upgrade: bump compose-go to v1.8.0
- Dependencies upgrade: bump Go to 1.19.3
Bug fixes and enhancements
- Added
oom_score_adjfield to service definition. Pull Request compose#10019 - Added mode field for tmpfs mount permissions. Pull Request compose#10031
- Compose now only stops services started by
upwhen interrupted. Fixed compose#10028 - Compose now loads implicit profiles for targeted services. Fixed compose#10025
- Compose does not require
service.build.platformsto be set ifservice.platformis set. Fixed compose#10017 - Plain output is used during buildx image builds if
--ansi=neveris set. Fixed compose#10020 COMPOSE_IGNORE_ORPHANSenvironment variable now behaves more consistently. Fixed compose#10035- Compose now uses the correct image name separator in
convert. Fixed compose#9904 - Fixed
runfor services usingnetwork_mode: service:NAME. Fixed compose#10036
2.13.0
{{< release-date date="2022-11-23" >}}
Updates
- Dependencies upgrade: bump containerd to 1.6.10
- Dependencies upgrade: bump docker-credential-helpers to v0.7.0
- Update CI dependencies. Pull Request compose#9982
Bug fixes and enhancements
- Added a
no-consistencyoption toconvertcommand. Fixed compose#9963 - Added a
buildoption toruncommand. Fixed compose#10003 - Fixed mapping
restart_policy.conditionto engine supported values. Fixed compose#8756, docs#15936 - Fixed missing support of
deploy.reservation.memory. Fixed compose#9902 - Fixed a bug to prevent usage of
COMPOSE_PROFILESwhen--profilearg is used. Fixed compose#9895 - Fixed a bug to prevent pulling a service's image when depending on a service which will build this image. Fixed compose#9983
- Fixed parsing issue when a container number label is not found. Fixed compose#10004
- Compose now uses the platform value defined by
DOCKER_DEFAULT_PLATFORMwhen noservice.platformdefined. Fixed compose#9889 - Removed usage of the deprecated dependency
gotest.toolsv2. Pull Request compose#9935 - Excluded issues labeled with
kind/featurefrom stale bot process. Fixed compose#9988
2.12.2
{{< release-date date="2022-10-21" >}}
Updates
- Updated Docker Engine API to restore compatibility with Golang 1.18 needed for Linux packaging. Pull Request compose#9940
For the full change log or additional information, check the Compose repository 2.12.2 release page.
2.12.1
{{< release-date date="2022-10-21" >}}
Security
- Updated Docker Engine API to apply fix of CVE-2022-39253. Pull Request compose#9934
For the full change log or additional information, check the Compose repository 2.12.1 release page.
2.12.0
{{< release-date date="2022-10-18" >}}
Updates
-
CI update to the documentation repository path
-
Upgraded to compose-go from 1.5.1 to 1.6.0
-
Updated to go 1.19.2 to address CVE-2022-2879, CVE-2022-2880, CVE-2022-41715
Bug fixes and enhancements
- Added a
quietoption when pushing an image. Fixed compose#9089 - Fixed a misleading error message for
portcommand. Pull Request compose#9909 - Fixed a bug to prevent failure when Compose tries to remove a non-existing container. Fixed by compose#9896
- Switched GitHub issue template form
For the full change log or additional information, check the Compose repository 2.12.0 release page.
2.11.2
{{< release-date date="2022-09-27" >}}
Note
- Updates on environment file syntax & interpolation: see compose#9879
- Setting
DOCKER_HOSTvia.envfiles is not supported in Compose v2
Updates
- Upgraded to compose-go from 1.5.1 to 1.6.0
Bug fixes and enhancements
- Fixed a bug to prevent "invalid template" errors on valid environment variable values. Fixes compose##9806, compose##9746, compose##9704, compose##9294
- Fixed a bug to ensure new images from
docker compose buildare used. Fixes compose#9856 - Fixed cross-architecture builds when
DOCKER_DEFAULT_PLATFORMnot set. Fixes compose#9864 - Fixed intermittent conflict errors when using
depends_on. Fixes compose#9014 - Cleared service
CMDwhen entry point is overridden. Fixes compose#9622 - Configured default builder export when no
build.platformsdefined. Fixes compose#9856 - Fixed a bug to keep the platform defined, in priority, via DOCKER_DEFAULT_PLATFORM or the
service.platformattribut. Fixes compose#9864 - Removed support for
DOCKER_HOSTin.envfiles. Fixes compose#9210 - Fixed a bug to ensure clean service command if entry point is overridden in run command. Fixes compose#9622
- Deps: fixed race condition during graph traversal. Fixes compose#9014
- CI now runs on Windows & macOS including E2E tests via Docker Desktop
- Added more information when
service.platformisn't part ofservice.build.platforms - GitHub Workflows security hardening
For the full change log or additional information, check the Compose repository 2.11.2 release page.
2.11.1
{{< release-date date="2022-09-20" >}}
Bug fixes and enhancements
- Fixed a bug to keep
depends_oncondition when service hasvolumes_from. Fixes compose#9843 - Fixed a bug to keep the platform defined at service level during build if no build platforms. Fixes compose#9729
- Fixed a bug to keep the platform defined via DOCKER_DEFAULT_PLATFORM during build if no build platforms provided. Fixes compose#9853
For the full change log or additional information, check the Compose repository 2.11.1 release page.
2.11.0
{{< release-date date="2022-09-14" >}}
Updates
- Dependencies upgrade: bump Golang to 1.19.1
- Dependencies upgrade: bump github.com/docker/go-units from 0.4.0 to 0.5.0
- Dependencies upgrade: bump github.com/cnabio/cnab-to-oci from 0.3.6 to 0.3.7
- Dependencies upgrade: bump go.opentelemetry.io/otel from 1.9.0 to 1.10.0
- Dependencies upgrade: bump github.com/AlecAivazis/survey/v2 from 2.3.5
- Dependencies upgrade: bump go.opentelemetry.io/otel from 1.4.1 to 1.9.0
- Dependencies upgrade: bump compose-go from 1.5.0 to 1.5.1
Bug fixes and enhancements
- Added platforms build. Fixes compose-spec#267
- Logs now filter to services from current Compose file. Fixes compose#9801
- Added an improved output warning when pulling images. Fixes compose#9820
- Fixed a bug to ensure correct capture of exit code when service has dependencies. Fixes compose#9778
- Fixed
downwith--rmi. Fixes compose#9655 - Fixed docker-compose convert that turns
into$ when using the --no-interpolate option. Fixes compose#9160 - Fixed
build.goaccess custom labels directly cause panic. See compose#9810 - Applied newly loaded envvars to "DockerCli" and "APIClient". Fixes compose#9210
- Only attempt to start specified services on
compose start [services]. Fixes compose#9796 compose#9807 - Label built images for reliable cleanup on
down. Fixes compose#9655
For the full change log or additional information, check the Compose repository 2.11.0 release page.
2.10.2
{{< release-date date="2022-08-26" >}}
Bug fixes and enhancements
- Properly respect
DOCKER_TLS_VERIFYandDOCKER_CERT_PATHenvironment variables. Fixes compose#9789. - Improved
Makefileused in docker/docker-ce-packaging#742.
For the full change log or additional information, check the Compose repository 2.10.2 release page.
2.10.1
{{< release-date date="2022-08-24" >}}
Updates
- Dependencies update: Bumped github.com/moby/buildkit from 0.10.3 to 0.10.4.
Bug fixes and enhancements
- Fixed image pulls being skipped when
pull_policywas not set. Fixes compose#9773. - Restored
.sha256checksum files in release artifacts. Fixes compose#9772. - Removed error message showing exit code when using --exit-code-from. Fixes compose#9782.
- Fixed
compose pullto pull images even when they existed locally iftag=latest. - CI: Fixed checksums checking and brought back individual checksum files.
For the full change log or additional information, check the Compose repository 2.10.1 release page.
2.10.0
{{< release-date date="2022-08-19" >}}
New
- Applied newly loaded environment variables to
DockerCliandAPIClient. Fixes compose#9210. - Added support for windows/arm64 and linux/riscv64.
Updates
- Updated Dockerfile syntax to latest stable and renamed docs Dockerfile.
- Dependencies update: Upgraded BuildKit & docker/distribution.
- Dependencies update: Updated Docker CLI version used in CI to v20.10.17.
- Dependencies update: Bumped github.com/containerd/containerd from 1.6.6 to 1.6.7.
- Dependencies update: Bump github.com/containerd/containerd from 1.6.7 to 1.6.8.
- Dependencies update: Bumped to Go 1.18.5.
- Dependencies update: Bumped github.com/cnabio/cnab-to-oci from 0.3.5 to 0.3.6.
Bug fixes and enhancements
- Reverted environment variables precedence to OS over
.envfile. Fixes compose#9737. - Updated usage strings for consistency.
- Resolved environment variables case-insensitively on Windows. Fixes compose#9431.
- Fixed
compose upso dependency containers aren't stopped when a stop signal is issued. This keeps parity with v1 behavior-wise. - Fixes compose#9696.
- Fixed commands that start/restart/pause/unpause so that, if ran from the Compose file, the Compose model is also applied. Fixes compose#9705 and compose#9705.
- Removed extra whitespaces in help text of some subcommands.
- Fixed
compose createto not override service pull policy when the value from the command line is configured as the default. Fixes compose#9717. - Filtered out "commandConn.Close- warning" message. Fixescompose#8544.
- Fixed up/start/run to not wait for disabled dependency. Fixes compose#9591.
- Applied Compose model on
compose kill, added--remove-orphansoption. Fixes compose#9742. - Fixed
compose pullto avoid pulling the same images multiple times. Fixes compose#8768. - Fixed version of golangci-lint to v1.47.3, issue with v1.48.0 for now.
For the full change log, check the Compose repository 2.10.0 release page.
2.9.0
{{< release-date date="2022-08-7" >}}
Important
Compose v2.9.0 contains changes to the environment variable's precedence that have since been reverted. We recommend using v2.10+ to avoid compatibility issues.
{ .important }
Note
This release reverts the breaking changes introduced in Compose v2.8.0 by
compose-go v1.3.0.
Updates
- Updated
compose-goto v1.4.0 as previous version introduced breaking changes. Fixes compose#9700.
Bug fixes and enhancements
- Overwritten parent commands PreRun code for
compose version. Fixes compose#9698. - Fixed
LinkLocalIPsin V2. Fixes compose#9692. - Linked to
BUILDING.mdfor testing instructions. Fixes compose#9439.
For the full change log or additional information, check the Compose repository 2.9.0 release page.
2.8.0
{{< release-date date="2022-07-29" >}}
Important
This release introduced a breaking change via
compose-go v1.3.0and this PR. In this release, Docker Compose recreates new resources (networks, volumes, secrets, configs, etc.) with new names, using a-(dash) instead an_(underscore) and tries to connect to or use these newly created resources instead of your existing ones!Please use Compose the v2.9.0 release instead.
{ .important }
New
- Introduced
--pullflag to allow the force pull of updated service images. Fixes compose#9451. - Increased code quality by adding
gocriticto the linters.
Bug fixes and enhancements
- Fixed interpolation error message output. Fixes compose-spec/compose-go#292.
- Defined precedence of the environment variables evaluation. Fixes compose#9521, compose#9638, compose#9608, compose#9578. compose#9468, and compose#9683.
- Docs CI: Fixed to use push-to-fork when creating a PR.
- Used environmental variable for golang's version and updates GitHub Actions from v2 to v3.
- Used google/addlicense instead of kunalkushwaha/ltag.
For the full change log or additional information, check the Compose repository 2.8.0 release page.
2.7.0
{{< release-date date="2022-07-20" >}}
New
- Added support for environment secrets during build step. Fixes compose#9606.
Updates
- Dependencies upgrade: bumped go to 1.18.4.
- Dependencies upgrade: bumped compose-go to v1.2.9.
Bug fixes and enhancements
- Networks: prevented issues due to duplicate names. Fixes moby/moby#18864.
- Fixed issue with close networks name on
compose upandcompose downcommands. Fixes compose#9630. - Used appropriate dependency condition for one-shot containers when running
compose up --wait. Fixes compose#9606. - Fixed environment variable expansion.
- Validated depended-on services exist in consistency check. Fixes compose#8910.
- Fixed hash usage in environment values. Fixes compose#9509.
- Docker Build: added fix to respect dependency order for classic builder. Fixes compose#8538.
- Fixed panic caused by empty string argument. Fixes compose-switch#35.
- Fixed start/restart as to not impact one-off containers. Fixes compose#9509.
- Fixed to keep the container reference when
volumes_fromtargets a container and not a service. Fixes compose#8874. - build.go: added fix to initialize
CustomLabelsmap ifnil. - Added new targets to build Compose binary before running e2e tests.
- CI: released workflow to open a PR on docs repo with latest changes.
- e2e: added test for
ps. - e2e: split out pause tests and add more cases.
- e2e: add more start/stop test cases.
For the full change log or additional information, check the Compose repository 2.7.0 release page.
2.6.1
{{< release-date date="2022-06-23" >}}
New
- Added support for setting secrets from environment variable. Fixes compose-spec/compose-spec#251.
Updates
- Upgrade: compose-go v1.2.8.
- Upgrade: buildx v0.8.2.
- Dependencies upgrade: bumped runc to 1.1.2.
- Dependencies upgrade: bumped golang to 1.18.3.
- Dependencies upgrade: bumped compose-go to v1.2.8.
- Dependencies upgrade: bumped github.com/theupdateframework/notary from 0.6.1 to 0.7.0.
- Dependencies upgrade: bumped github.com/cnabio/cnab-to-oci from 0.3.1-beta1 to 0.3.3.
- Dependencies upgrade: bumped github.com/hashicorp/go-version from 1.3.0 to 1.5.0.
- Dependencies upgrade: bumped github.com/stretchr/testify from 1.7.0 to 1.7.2.
- Dependencies upgrade: bumped github.com/docker/buildx from 0.8.1 to 0.8.2.
- Dependencies upgrade: bumped github.com/AlecAivazis/survey/v2 from 2.3.2 to 2.3.5.
- Dependencies upgrade: bumped github.com/containerd/containerd from 1.6.2 to 1.6.6.
Bug fixes and enhancements
- Added links to container create request. Fixes #9513.
- Fixed
compose runto start only direct dependencies. Fixes #9459. - Fixed
compose up'service not found' errors when using--no-depsoption. Fixes #9427. - Fixed
compose downto respectCOMPOSE_REMOVE_ORPHANSenvironment variable. Fixes #9562. - Fixed project-level bind mount volumes. Fixes docker/for-mac#6317.
- Fixed parsing of properties
deploy.limits.cpusanddeploy.limits.pidsto respect floating-point values. Fixes #9542 and #9501. - Fixed
compose psoutput to list all exposed ports. Fixes #9257. - Fixed spelling mistakes in
compose pscode. - Fixed
docker composeto honor--no-ansieven when deprecated option is requested. - Fixed network name and network ID possible ambiguity.
- e2e: added test for
ps. - e2e: unmarshalled json into container summaries.
- e2e: fixed subtests and block parallel unsafe tests.
- e2e: isolated test command env from system env.
- e2e: fixed spurious
psfailures. - e2e: ensured all compose commands standalone compatible.
- e2e: improved test output on failures.
For the full change log or additional information, check the Compose repository 2.6.1 release page.
2.6.0
{{< release-date date="2022-05-30" >}}
New
- Added the tags property to the build section. In this property tags can be defined to be applied to the final image, in addition to the one defined in the image property.
- Added end-to-end tests to ensure there is no regression on environment variables precedence.
- Added ddev's end-to-end test.
Updates
- Dependencies update: bumping compose-go to 1.2.6.
- Dependencies update: bumping compose-go to 1.2.7.
- Dependencies update: bumping golang to 1.18.
Bug fixes and enhancements
- Fixed
compose upto attach only to services declared in project with enabled profiles. Fixes #9286. - Fixed flickering prompt when pulling same image from multiple services. Fixes #9469.
- Fixed compose go to import .env file to OS environment to allow setting variables (such as DOCKER_BUILDKIT) through this file. Fixes #9345.
- Fixed
TestLocalComposeUpthat failed locally. - Fixed local run of make
e2e-compose-standalone.
For the full change log or additional information, check the Compose repository 2.6.0 release page.
2.5.1
{{< release-date date="2022-05-17" >}}
Updates
- Dependencies updates: bumping compose-go to 1.2.5.
Bug fixes and enhancements
- Fixed resolution of project's working directive absolute path when a relative path is declared using '--env-file'. Fixes docker/for-mac#6229.
- Fixed
compose down: now rejects all arguments in order to clarify usage. Fixes #9151. - Fixed
compose down: now exits with status=0 if there is nothing to remove. Fixes #9426. - Fixed extra space printed in logs output lines with --no-log-prefix option. Fixes #9464.
- Clarified what the default work dir is when multiple compose files are passed.
- cp command: copy to all containers of a service as default behavior.
For the full change log or additional information, check the Compose repository 2.5.1 release page.
2.5.0
{{< release-date date="2022-04-29" >}}
Bug fixes and enhancements
- Fixed panic with
compose downcommand when-pflag specified. Fixes #9353. - Passed newly created project as input to start services (
docker compose up). Fixes #9356. - Included services declared under links in docker-compose file as implicit dependencies. Fixes #9301.
- Added changes
docker compose pullcommand to respect defined policy: 1) skip services configured aspull_policy: neverand 2) ignore those with an existing image andpull_policy: missing. Fixes #3660. - Error building project from resources is no longer ignored in order to prevent
downpanic. Fixes #9383. - Enforced project name to be lowercase. Fixes #9378.
- Added support to build-time secrets. Fixes #6358.
- Changed
compose-goto allow (re)building volume string to be used by enginebindAPI when mount can't be used. Fixes #9380. - Provided checksums.txt file and added
--binaryto allow verification in different OS. Fixes #9388. - Added changes so locally pulled image's ID is inspected and persisted to
com.docker.compose.image. Fixes #9357. - Fixed issue regarding IPAM gateway setup. Fixes #9330.
- Added support for ppc64le archictecture for docker compose binary.
- Fixed search/replace typo in
--no-TTYdocumentation.
For the full change log or additional information, check the Compose repository 2.5.0 release page.
2.4.1
{{< release-date date="2022-04-04" >}}
Bug fixes and enhancements
- Passed the
--rm flagvalue as is to the Docker CLI when running a container with this flag. Fixes #9314. - Added ssh config to the build options when building an image from a
docker compose upcommand. Fixes #9338. - Added inspection to container checking if a TTY is required. Running services with
tty:truespecified now show console output. Fixes #9288.
For the full change log or additional information, check the Compose repository 2.4.1 release page.
2.4.0
{{< release-date date="2022-04-1" >}}
Updates
- Dependencies update: Bumped buildx to v0.8.1. to fix possible panic on handling build context scanning errors.
Bug fixes and enhancements
- Passed the interactive flag '-i' from the Compose CLI to the Docker one to run exec command. Fixes #9315.
- Compose commands now take the value of
COMPOSE_PROJECT_NAMEenvironmental variable into consideration. Fixes #9316. - Fixed issue of
compose downcommand that when executed in contexts without any services started or resources to be deleted was returning an error. Error was due to command trying to delete an inexistent default network. Fixes #9333. - Introduced support for
cache_from,cache_to,no_cacheandpullattributes in the build section. These attributes allow forcing a complete rebuild from sources and checking with registry for images used. These changes provide the basis for offering--no-cacheand--pulloptions for compose build (or equivalent) command down the line. - Introduced support of an
--sshflag for thebuildcommand from CLI and Compose file. Fixes #7025. - Fixed typo in
--sshflag description. Related to #7025. - Pinned Kubernetes dependencies to the same version as in buildx.
- Passed the interactive flag from the Compose CLI to the Docker one to run exec command.
- Fixed race condition on start-stop end-to-end tests running in parallel.
- Removed code regarding an obsolete warning.
- Vendor: github.com/containerd/containerd v1.6.2. Includes a fix for CVE-2022-24769 (doesn't affect our codebase).
For the full change log or additional information, check the Compose repository 2.4.0 release page.
2.3.4
{{< release-date date="2022-03-25" >}}
New
- Introduced changes to use RunExec and RunStart from docker/cli to handle all the interactive/tty/* terminal logic.
Removed
- Removed a container with no candidate now produces a warning instead of an error. Fixes #9255.
- Removed the "Deprecated" mentions from -i and -t options to run and exec commands. These options are on by default and in use. Fixes #9229.
- Removed the "Deprecated" mention from the --filter flag, to keep consistency with other commands.
- Removed the need to get the original compose.yaml file to run 'docker compose kill'.
Updates
- Dependencies update: Bumped github.com/spf13/cobra from 1.3.0 to 1.4.0. Cobra library no longer requires Viper and all of its indirect dependencies See cobra's release page.
- Dependencies update: Bumped buildx from v0.7.1 to v0.8.0.
Bug fixes and enhancements
- Recovered behavior for 'compose up -d' of recreating containers of compose file images with refreshed content. Fixes #9259.
- Docker compose --status, --filter and --format flags documentation updates.
docker compose down -vnow does not remove external volumes and networks as per the option's expected and documented behavior. Whenever project is specified it is also now used to enforce down to only remove resources listed in compose.yaml file. Fixes #9172, #9145.- Changed Compose API reference docs automation to pick up diffs code vs. docs.
For the full change log or additional information, check the Compose repository 2.3.4 release page.
Other Releases
(2022-03-8 to 2022-04-14)
For the releases later than 1.29.2 and earlier than 2.3.4, please check the Compose repository release pages.
1.29.2
(2021-05-10)
Miscellaneous
-
Removed the prompt to use
docker-composein theupcommand. -
Bumped
pyto1.10.0inrequirements-indirect.txt.
1.29.1
(2021-04-13)
Bugs
-
Fixed invalid handler warning on Windows builds.
-
Fixed config hash to trigger container re-creation on IPC mode updates.
-
Fixed conversion map for
placement.max_replicas_per_node. -
Removed extra scan suggestion on build.
1.29.0
(2021-04-06)
Features
-
Added profile filter to
docker-compose config. -
Added a
depends_oncondition to wait for successful service completion.
Miscellaneous
-
Added an image scan message on build.
-
Updated warning message for
--no-ansito mention--ansi neveras alternative. -
Bumped docker-py to 5.0.0.
-
Bumped PyYAML to 5.4.1.
-
Bumped python-dotenv to 0.17.0.
1.28.6
(2021-03-23)
Bug fixes
-
Made
--env-filerelative to the current working directory. Environment file paths set with--env-fileare now relative to the current working directory and override the default.envfile located in the project directory. -
Fixed missing service property
storage_optby updating the Compose schema. -
Fixed build
extra_hostslist format. -
Removed additional error message on
exec.
Miscellaneous
- Added
compose.ymlandcompose.yamlto the default filename list.
1.28.5
(2021-02-26)
Bugs
-
Fixed the OpenSSL version mismatch error when shelling out to the SSH client (via bump to docker-py 4.4.4 which contains the fix).
-
Added missing build flags to the native builder:
platform,isolationandextra_hosts. -
Removed info message on native build.
-
Fixed the log fetching bug when service logging driver is set to 'none'.
1.28.4
(2021-02-18)
Bug fixes
- Fixed SSH port parsing by bumping docker-py to 4.4.3.
Miscellaneous
- Bumped Python to 3.7.10.
1.28.3
(2021-02-17)
Bug fixes
-
Fixed SSH hostname parsing when it contains a leading 's'/'h', and removed the quiet option that was hiding the error (via docker-py bump to 4.4.2).
-
Fixed key error for
--no-log-prefixoption. -
Fixed incorrect CLI environment variable name for service profiles:
COMPOSE_PROFILESinstead ofCOMPOSE_PROFILE. -
Fixed the fish completion.
Miscellaneous
-
Bumped cryptography to 3.3.2.
-
Removed the log driver filter.
For a list of PRs and issues fixed in this release, see Compose 1.28.3.
1.28.2
(2021-01-26)
Bug fixes
-
Revert to Python 3.7 bump for Linux static builds
-
Add bash completion for
docker-compose logs|up --no-log-prefix
Miscellaneous
- CI setup update
1.28.0
(2021-01-20)
Features
-
Added support for NVIDIA GPUs through device requests.
-
Added support for service profiles.
-
Changed the SSH connection approach to the Docker CLI by shelling out to the local SSH client. Set the
COMPOSE_PARAMIKO_SSH=1environment variable to enable the old behavior. -
Added a flag to disable log prefix.
-
Added a flag for ANSI output control.
-
Docker Compose now uses the native Docker CLI's
buildcommand when building images. Set theCOMPOSE_DOCKER_CLI_BUILD=0environment variable to disable this feature.
Bug fixes
-
Made
parallel_pull=Trueby default. -
Restored the warning for configs in non-swarm mode.
-
Took
--fileinto account when definingproject_dir. -
Fixed a service attach bug on
compose up.
Miscellaneous
-
Added usage metrics.
-
Synced schema with COMPOSE specification.
-
Improved failure report for missing mandatory environment variables.
-
Bumped
attrsto 20.3.0. -
Bumped
more_itertoolsto 8.6.0. -
Bumped
cryptograhyto 3.2.1. -
Bumped
cffito 1.14.4. -
Bumped
virtualenvto 20.2.2. -
Bumped
bcryptto 3.2.0. -
Bumped GitPython to 3.1.11.
-
Bumped
docker-pyto 4.4.1. -
Bumped Python to 3.9.
-
Linux: bumped Debian base image from stretch to buster (required for Python 3.9).
-
macOS: Bumped OpenSSL 1.1.1g to 1.1.1h, and Python 3.7.7 to 3.9.0.
-
Bumped PyInstaller to 4.1.
-
Relaxed the restriction on base images to latest minor.
-
Updated READMEs.
1.27.4
(2020-09-24)
Bug fixes
-
Removed path checks for bind mounts.
-
Fixed port rendering to output long form syntax for non-v1.
-
Added protocol to the Docker socket address.
1.27.3
(2020-09-16)
Bug fixes
-
Merged
max_replicas_per_nodeondocker-compose config. -
Fixed
depends_onserialization ondocker-compose config. -
Fixed scaling when some containers are not running on
docker-compose up. -
Enabled relative paths for
driver_opts.deviceforlocaldriver. -
Allowed strings for
cpusfields.
1.27.2
(2020-09-10)
Bug fixes
- Fixed bug on
docker-compose runcontainer attach.
1.27.1
(2020-09-10)
Bug fixes
-
Fixed
docker-compose runwhenservice.scaleis specified. -
Allowed the
driverproperty for external networks as a temporary workaround for the Swarm network propagation issue. -
Pinned the new internal schema version to
3.9as the default. -
Preserved the version number configured in the Compose file.
1.27.0
(2020-09-07)
Features
-
Merged 2.x and 3.x Compose formats and aligned with
COMPOSE_SPECschema. -
Implemented service mode for
ipc. -
Passed
COMPOSE_PROJECT_NAMEenvironment variable in container mode. -
Made
runbehave in the same way asup. -
Used
docker buildondocker-compose runwhenCOMPOSE_DOCKER_CLI_BUILDenvironment variable is set. -
Used the docker-py default API version for engine queries (
auto). -
Parsed
network_modeon build.
Bug fixes
-
Ignored build context path validation when building is not required.
-
Fixed float to bytes conversion via docker-py bump to 4.3.1.
-
Fixed the scale bug when the deploy section is set.
-
Fixed
docker-pybump insetup.py. -
Fixed experimental build failure detection.
-
Fixed context propagation to the Docker CLI.
Miscellaneous
-
Bumped
docker-pyto 4.3.1. -
Bumped
toxto 3.19.0. -
Bumped
virtualenvto 20.0.30. -
Added script for Docs synchronization.
1.26.2
(2020-07-02)
Bug fixes
- Enforced
docker-py4.2.2 as minimum version when installing with pip.
1.26.1
(2020-06-30)
Features
- Bumped
docker-pyfrom 4.2.1 to 4.2.2.
Bug fixes
-
Enforced
docker-py4.2.1 as minimum version when installing with pip. -
Fixed context load for non-docker endpoints.
1.26.0
(2020-06-03)
Features
-
Added
docker contextsupport. -
Added missing test dependency
ddttosetup.py. -
Added
--attach-dependenciesto commandupfor attaching to dependencies. -
Allowed compatibility option with
COMPOSE_COMPATIBILITYenvironment variable. -
Bumped
Pytestto 5.3.4 and add refactor compatibility with the new version. -
Bumped
OpenSSLfrom 1.1.1f to 1.1.1g. -
Bumped
certififrom 2019.11.28 to 2020.4.5.1. -
Bumped
docker-pyfrom 4.2.0 to 4.2.1.
Bug fixes
-
Properly escaped values coming from
env_files. -
Synchronized compose-schemas with upstream (docker/cli).
-
Removed
Noneentries on exec command. -
Added
distropackage to get distro information. -
Added
python-dotenvto delegate.envfile processing. -
Stopped adjusting output on terminal width when piped into another command.
-
Showed an error message when
versionattribute is malformed. -
Fixed HTTPS connection when
DOCKER_HOSTis remote.
1.25.5
(2020-04-10)
Features
-
Bumped OpenSSL from 1.1.1d to 1.1.1f.
-
Added Compose version 3.8.
- Limited service scale to the size specified by the field
deploy.placement.max_replicas_per_node.
- Limited service scale to the size specified by the field
1.25.4
(2020-02-03)
Bug fixes
-
Fixed the CI script to enforce the minimal MacOS version to 10.11.
-
Fixed docker-compose exec for keys with no value on environment files.
1.25.3
(2020-01-23)
Bug fixes
-
Fixed the CI script to enforce the compilation with Python3.
-
Updated the binary's sha256 on the release page.
1.25.2
(2020-01-20)
New features
- Docker Compose now allows the compatibility option with
COMPOSE_COMPATIBILITYenvironment variable.
Bug fixes
-
Fixed an issue that caused Docker Compose to crash when the
versionfield was set to an invalid value. Docker Compose now displays an error message when invalid values are used in the version field. -
Fixed an issue that caused Docker Compose to render messages incorrectly when running commands outside a terminal.
1.25.1
(2020-01-06)
Bugfixes
-
Decoded the
APIErrorexplanation to Unicode before using it to create and start a container. -
Docker Compose discards
com.docker.compose.filepathslabels that haveNoneas value. This usually occurs when labels originate from stdin. -
Added OS X binary as a directory to solve slow start up time issues caused by macOS Catalina binary scan.
-
Passed the
HOMEenvironment variable in container mode when running withscript/run/run.sh. -
Docker Compose now reports images that cannot be pulled, however, are required to be built.
1.25.0
(2019-11-18)
New features
-
Set no-colors to true by changing
CLICOLORenv variable to0. -
Added working directory, config files, and env file to service labels.
-
Added ARM build dependencies.
-
Added BuildKit support (use
DOCKER_BUILDKIT=1andCOMPOSE_DOCKER_CLI_BUILD=1). -
Raised Paramiko to version 2.6.0.
-
Added the following tags:
docker-compose:latest,docker-compose:<version>-alpine, anddocker-compose:<version>-debian. -
Raised
docker-pyto version 4.1.0. -
Enhanced support for
requests, up to version 2.22.0. -
Removed empty tag on
build:cache_from. -
Dockerfileenhancement that provides for the generation oflibmuslbinaries for Alpine Linux. -
Pulling only of images that cannot be built.
-
The
scaleattribute now accepts0as a value. -
Added a
--quietoption and a--no-rmoption to thedocker-compose buildcommand. -
Added a
--no-interpolateoption to thedocker-compose configcommand. -
Raised OpenSSL for MacOS build from
1.1.0to1.1.1c. -
Added support for the
docker-compose.ymlfile'scredential_specconfiguration option. -
Resolution of digests without having to pull the image.
-
Upgraded
pyyamlto version4.2b1. -
Lowered the severity to
warningfor instances in whichdownattempts to remove a non-existent image. -
Mandated the use of improved API fields for project events, when possible.
-
Updated
setup.pyfor modernpypi/setuptools, and removedpandocdependencies. -
Removed
Dockerfile.armhf, which is no longer required.
Bug fixes
-
Made container service color deterministic, including the removal of the color red.
-
Fixed non-ASCII character errors (Python 2 only).
-
Changed image sizing to decimal format, to align with Docker CLI.
-
ttysize acquired through Python POSIX support. -
Fixed same file
extendsoptimization. -
Fixed
stdin_open. -
Fixed the issue of
--remove-orphansbeing ignored encountered during use withup --no-startoption. -
Fixed
docker-compose ps --allcommand. -
Fixed the
depends_ondependency recreation behavior. -
Fixed bash completion for the
docker-compose build --memorycommand. -
Fixed the misleading environmental variables warning that occurs when the
docker-compose execcommand is performed. -
Fixed the failure check in the
parallel_execute_watch function. -
Fixed the race condition that occurs following the pulling of an image.
-
Fixed error on duplicate mount points (a configuration error message now displays).
-
Fixed the merge on
networkssection. -
Compose container is always connected to
stdinby default. -
Fixed the presentation of failed services on the
docker-compose startcommand when containers are not available.
1.24.1
(2019-06-24)
This release contains minor improvements and bug fixes.
1.24.0
(2019-03-28)
Features
-
Added support for connecting to the Docker Engine using the
sshprotocol. -
Added an
--allflag todocker-compose psto include stopped one-off containers in the command's output. -
Added bash completion for
ps --all|-a. -
Added support for credential_spec.
-
Added
--paralleltodocker build's options inbashandzshcompletion.
Bug fixes
-
Fixed a bug where some valid credential helpers weren't properly handled by Compose when attempting to pull images from private registries.
-
Fixed an issue where the output of
docker-compose startbefore containers were created was misleading. -
Compose will no longer accept whitespace in variable names sourced from environment files. This matches the Docker CLI behavior.
-
Compose will now report a configuration error if a service attempts to declare duplicate mount points in the volumes section.
-
Fixed an issue with the containerized version of Compose that prevented users from writing to stdin during interactive sessions started by
runorexec. -
One-off containers started by
runno longer adopt the restart policy of the service, and are instead set to never restart. -
Fixed an issue that caused some container events to not appear in the output of the
docker-compose eventscommand. -
Missing images will no longer stop the execution of
docker-compose downcommands. A warning is now displayed instead. -
Force
virtualenvversion for macOS CI. -
Fixed merging of Compose files when network has
Noneconfig. -
Fixed
CTRL+Cissues by enablingbootloader_ignore_signalsinpyinstaller. -
Bumped
docker-pyversion to3.7.2to fix SSH and proxy configuration issues. -
Fixed release script and some typos on release documentation.
1.23.2
(2018-11-28)
Bug fixes
-
Reverted a 1.23.0 change that appended random strings to container names created by
docker-compose up, causing addressability issues.Note: Containers created by
docker-compose runwill continue to use randomly generated names to avoid collisions during parallel runs. -
Fixed an issue where some
dockerfilepaths would fail unexpectedly when attempting to build on Windows. -
Fixed a bug where build context URLs would fail to build on Windows.
-
Fixed a bug that caused
runandexeccommands to fail for some otherwise accepted values of the--hostparameter. -
Fixed an issue where overrides for the
storage_optandisolationkeys in service definitions weren't properly applied. -
Fixed a bug where some invalid Compose files would raise an uncaught exception during validation.
1.23.1
(2018-11-01)
Bug fixes
-
Fixed a bug where working with containers created with a version of Compose earlier than
1.23.0would cause unexpected crashes. -
Fixed an issue where the behavior of the
--project-directoryflag would vary depending on which subcommand was used.
1.23.0
(2018-10-30)
Important note
The default naming scheme for containers created by Compose in this version
has changed from <project>_<service>_<index> to
<project>_<service>_<index>_<slug>, where <slug> is a randomly-generated
hexadecimal string. Please make sure to update scripts relying on the old
naming scheme accordingly before upgrading.
Features
-
Logs for containers restarting after a crash will now appear in the output of the
upandlogscommands. -
Added
--hashoption to thedocker-compose configcommand, allowing users to print a hash string for each service's configuration to facilitate rolling updates. -
Added
--parallelflag to thedocker-compose buildcommand, allowing Compose to build up to 5 images simultaneously. -
Output for the
pullcommand now reports status / progress even when pulling multiple images in parallel. -
For images with multiple names, Compose will now attempt to match the one present in the service configuration in the output of the
imagescommand.
Bug fixes
-
Fixed an issue where parallel
runcommands for the same service would fail due to name collisions. -
Fixed an issue where paths longer than 260 characters on Windows clients would cause
docker-compose buildto fail. -
Fixed a bug where attempting to mount
/var/run/docker.sockwith Docker Desktop for Windows would result in failure. -
The
--project-directoryoption is now used by Compose to determine where to look for the.envfile. -
docker-compose buildno longer fails when attempting to pull an image with credentials provided by the gcloud credential helper. -
Fixed the
--exit-code-fromoption indocker-compose upto always report the actual exit code even when the watched container is not the cause of the exit. -
Fixed an issue that would prevent recreating a service in some cases where a volume would be mapped to the same mountpoint as a volume declared within the Dockerfile for that image.
-
Fixed a bug that caused hash configuration with multiple networks to be inconsistent, causing some services to be unnecessarily restarted.
-
Fixed a bug that would cause failures with variable substitution for services with a name containing one or more dot characters.
-
Fixed a pipe handling issue when using the containerized version of Compose.
-
Fixed a bug causing
external: falseentries in the Compose file to be printed asexternal: truein the output ofdocker-compose config. -
Fixed a bug where issuing a
docker-compose pullcommand on services without a defined image key would cause Compose to crash. -
Volumes and binds are now mounted in the order they are declared in the service definition.
Miscellaneous
- The
zshcompletion script has been updated with new options, and no longer suggests container names where service names are expected.
1.22.0
(2018-07-17)
New features
Compose format version 3.7
-
Introduced version 3.7 of the
docker-compose.ymlspecification. This version requires Docker Engine 18.06.0 or above. -
Added support for
rollback_configin the deploy configuration -
Added support for the
initparameter in service configurations -
Added support for extension fields in service, network, volume, secret, and config configurations
Compose format version 2.4
- Added support for extension fields in service, network, and volume configurations
Bug fixes
-
Fixed a bug that prevented deployment with some Compose files when
DOCKER_DEFAULT_PLATFORMwas set -
Compose will no longer try to create containers or volumes with invalid starting characters
-
Fixed several bugs that prevented Compose commands from working properly with containers created with an older version of Compose
-
Fixed an issue with the output of
docker-compose configwith the--compatibility-modeflag enabled when the source file contains attachable networks -
Fixed a bug that prevented the
gcloudcredential store from working properly when used with the Compose binary on UNIX -
Fixed a bug that caused connection errors when trying to operate over a non-HTTPS TCP connection on Windows
-
Fixed a bug that caused builds to fail on Windows if the Dockerfile was located in a subdirectory of the build context
-
Fixed an issue that prevented proper parsing of UTF-8 BOM encoded Compose files on Windows
-
Fixed an issue with handling of the double-wildcard (
**) pattern in.dockerignorefiles when usingdocker-compose build -
Fixed a bug that caused auth values in legacy
.dockercfgfiles to be ignored -
docker-compose buildwill no longer attempt to create image names starting with an invalid character
1.21.2
(2018-05-03)
Bug fixes
- Fixed a bug where the ip_range attribute in IPAM configs was prevented from passing validation
1.21.1
(2018-04-27)
Bug fixes
-
In 1.21.0, we introduced a change to how project names are sanitized for internal use in resource names. This caused issues when manipulating an existing, deployed application whose name had changed as a result. This release properly detects resources using "legacy" naming conventions.
-
Fixed an issue where specifying an in-context Dockerfile using an absolute path would fail despite being valid.
-
Fixed a bug where IPAM option changes were incorrectly detected, preventing redeployments.
-
Validation of v2 files now properly checks the structure of IPAM configs.
-
Improved support for credentials stores on Windows to include binaries using extensions other than
.exe. The list of valid extensions is determined by the contents of thePATHEXTenvironment variable. -
Fixed a bug where Compose would generate invalid binds containing duplicate elements with some v3.2 files, triggering errors at the Engine level during deployment.
1.21.0
(2018-04-11)
New features
Compose file version 2.4
-
Introduced version 2.4 of the
docker-compose.ymlspecification. This version requires Docker Engine 17.12.0 or above. -
Added support for the
platformparameter in service definitions. If supplied, the parameter is also used when performing build for the service.
Compose file version 2.2 and up
- Added support for the
cpu_rt_periodandcpu_rt_runtimeparameters in service definitions (2.x only).
Compose file version 2.1 and up
-
Added support for the
cpu_periodparameter in service definitions (2.x only). -
Added support for the
isolationparameter in service build configurations. Additionally, theisolationparameter in service definitions is used for builds as well if nobuild.isolationparameter is defined. (2.x only)
All formats
-
Added support for the
--workdirflag indocker-compose exec. -
Added support for the
--compressflag indocker-compose build. -
docker-compose pullis now performed in parallel by default. You can opt out using the--no-parallelflag. The--parallelflag is now deprecated and will be removed in a future version. -
Dashes and underscores in project names are no longer stripped out.
-
docker-compose buildnow supports the use of Dockerfile from outside the build context.
Bug fixes
-
Compose now checks that the volume's configuration matches the remote volume, and errors out if a mismatch is detected.
-
Fixed a bug that caused Compose to raise unexpected errors when attempting to create several one-off containers in parallel.
-
Fixed a bug with argument parsing when using
docker-machine configto generate TLS flags forexecandruncommands. -
Fixed a bug where variable substitution with an empty default value (e.g.
${VAR:-}) would print an incorrect warning. -
Improved resilience when encoding of the Compose file doesn't match the system's. Users are encouraged to use UTF-8 when possible.
-
Fixed a bug where external overlay networks in Swarm would be incorrectly recognized as inexistent by Compose, interrupting otherwise valid operations.
1.20.0
(2018-03-20)
New features
Compose file version 3.6
-
Introduced version 3.6 of the
docker-compose.ymlspecification. This version must be used with Docker Engine 18.02.0 or above. -
Added support for the
tmpfs.sizeproperty in volume mappings
Compose file version 3.2 and up
- The
--build-argoption can now be used without specifying a service indocker-compose build
Compose file version 2.3
-
Added support for
device_cgroup_rulesin service definitions -
Added support for the
tmpfs.sizeproperty in long-form volume mappings -
The
--build-argoption can now be used without specifying a service indocker-compose build
All formats
-
Added a
--log-leveloption to the top-leveldocker-composecommand. Accepted values aredebug,info,warning,error,critical. Default log level isinfo -
docker-compose runnow allows users to unset the container's entrypoint -
Proxy configuration found in the
~/.docker/config.jsonfile now populates environment and build args for containers created by Compose -
Added the
--use-aliasesflag todocker-compose run, indicating that network aliases declared in the service's config should be used for the running container -
Added the
--include-depsflag todocker-compose pull -
docker-compose runnow kills and removes the running container upon receivingSIGHUP -
docker-compose psnow shows the containers' health status if available -
Added the long-form
--detachoption to theexec,runandupcommands
Bug fixes
-
Fixed
.dockerignorehandling, notably with regard to absolute paths and last-line precedence rules -
Fixed an issue where Compose would make costly DNS lookups when connecting to the Engine when using Docker For Mac
-
Fixed a bug introduced in 1.19.0 which caused the default certificate path to not be honored by Compose
-
Fixed a bug where Compose would incorrectly check whether a symlink's destination was accessible when part of a build context
-
Fixed a bug where
.dockerignorefiles containing lines of whitespace caused Compose to error out on Windows -
Fixed a bug where
--tls*and--hostoptions wouldn't be properly honored for interactiverunandexeccommands -
A
seccomp:<filepath>entry in thesecurity_optconfig now correctly sends the contents of the file to the engine -
ANSI output for
upanddownoperations should no longer affect the wrong lines -
Improved support for non-unicode locales
-
Fixed a crash occurring on Windows when the user's home directory name contained non-ASCII characters
-
Fixed a bug occurring during builds caused by files with a negative
mtimevalues in the build context -
Fixed an encoding bug when streaming build progress
1.19.0
(2018-02-07)
Breaking changes
- On UNIX platforms, interactive
runandexeccommands now require thedockerCLI to be installed on the client by default. To revert to the previous behavior, users may set theCOMPOSE_INTERACTIVE_NO_CLIenvironment variable.
New features
Compose file version 3.x
- The output of the
configcommand should now mergedeployoptions from several Compose files in a more accurate manner
Compose file version 2.3
- Added support for the
runtimeoption in service definitions
Compose file version 2.1 and up
- Added support for the
${VAR:?err}and${VAR?err}variable interpolation syntax to indicate mandatory variables
Compose file version 2.x
- Added
prioritykey to service network mappings, allowing the user to define in which order the specified service will connect to each network
All formats
-
Added
--renew-anon-volumes(shorthand-V) to theupcommand, preventing Compose from recovering volume data from previous containers for anonymous volumes -
Added limit for number of simultaneous parallel operations, which should prevent accidental resource exhaustion of the server. Default is 64 and can be configured using the
COMPOSE_PARALLEL_LIMITenvironment variable -
Added
--always-recreate-depsflag to theupcommand to force recreating dependent services along with the dependency owner -
Added
COMPOSE_IGNORE_ORPHANSenvironment variable to forgo orphan container detection and suppress warnings -
Added
COMPOSE_FORCE_WINDOWS_HOSTenvironment variable to force Compose to parse volume definitions as if the Docker host was a Windows system, even if Compose itself is currently running on UNIX -
Bash completion should now be able to better differentiate between running, stopped and paused services
Bug fixes
-
Fixed a bug that would cause the
buildcommand to report a connection error when the build context contained unreadable files or FIFO objects. These file types will now be handled appropriately -
Fixed various issues around interactive
run/execsessions. -
Fixed a bug where setting TLS options with environment and CLI flags simultaneously would result in part of the configuration being ignored
-
Fixed a bug where the DOCKER_TLS_VERIFY environment variable was being ignored by Compose
-
Fixed a bug where the
-dand--timeoutflags inupwere erroneously marked as incompatible -
Fixed a bug where the recreation of a service would break if the image associated with the previous container had been removed
-
Fixed a bug where updating a mount's target would break Compose when trying to recreate the associated service
-
Fixed a bug where
tmpfsvolumes declared using the extended syntax in Compose files using version 3.2 would be erroneously created as anonymous volumes instead -
Fixed a bug where type conversion errors would print a stacktrace instead of exiting gracefully
-
Fixed some errors related to unicode handling
-
Dependent services no longer get recreated along with the dependency owner if their configuration hasn't changed
-
Added better validation of
labelsfields in Compose files. Label values containing scalar types (number, boolean) now get automatically converted to strings
1.18.0
(2017-12-18)
New features
Compose file version 3.5
-
Introduced version 3.5 of the
docker-compose.ymlspecification. This version requires Docker Engine 17.06.0 or above -
Added support for the
shm_sizeparameter in build configurations -
Added support for the
isolationparameter in service definitions -
Added support for custom names for network, secret and config definitions
Compose file version 2.3
-
Added support for
extra_hostsin build configuration -
Added support for the long syntax for volume entries, as previously introduced in the 3.2 format. Using this syntax will create mounts instead of volumes.
Compose file version 2.1 and up
-
Added support for the
oom_kill_disableparameter in service definitions (2.x only) -
Added support for custom names for network definitions (2.x only)
All formats
-
Values interpolated from the environment will now be converted to the proper type when used in non-string fields.
-
Added support for
--labelindocker-compose run -
Added support for
--timeoutindocker-compose down -
Added support for
--memoryindocker-compose build -
Setting
stop_grace_periodin service definitions now also sets the container'sstop_timeout
Bug fixes
-
Fixed an issue where Compose was still handling service hostname according to legacy engine behavior, causing hostnames containing dots to be cut up
-
Fixed a bug where the
X-Y:Zsyntax for ports was considered invalid by Compose -
Fixed an issue with CLI logging causing duplicate messages and inelegant output to occur
-
Fixed an issue that caused
stop_grace_periodto be ignored when using multiple Compose files -
Fixed a bug that caused
docker-compose imagesto crash when using untagged images -
Fixed a bug where the valid
${VAR:-}syntax would cause Compose to error out -
Fixed a bug where
env_fileentries using an UTF-8 BOM were being read incorrectly -
Fixed a bug where missing secret files would generate an empty directory in their place
-
Fixed character encoding issues in the CLI's error handlers
-
Added validation for the
testfield in healthchecks -
Added validation for the
subnetfield in IPAM configurations -
Added validation for
volumesproperties when using the long syntax in service definitions -
The CLI now explicit prevents using
-dand--timeouttogether indocker-compose up
1.17.0
(2017-11-01)
New features
Compose file version 3.4
-
Introduced version 3.4 of the
docker-compose.ymlspecification. This version requires to be used with Docker Engine 17.06.0 or above. -
Added support for
cache_from,networkandtargetoptions in build configurations -
Added support for the
orderparameter in theupdate_configsection -
Added support for setting a custom name in volume definitions using the
nameparameter
Compose file version 2.3
- Added support for
shm_sizeoption in build configuration
Compose file version 2.x
- Added support for extension fields (
x-*). Also available for v3.4 files
All formats
- Added new
--no-startto theupcommand, allowing users to create all resources (networks, volumes, containers) without starting services. Thecreatecommand is deprecated in favor of this new option
Bug fixes
-
Fixed a bug where
extra_hostsvalues would be overridden by extension files instead of merging together -
Fixed a bug where the validation for v3.2 files would prevent using the
consistencyfield in service volume definitions -
Fixed a bug that would cause a crash when configuration fields expecting unique items would contain duplicates
-
Fixed a bug where mount overrides with a different mode would create a duplicate entry instead of overriding the original entry
-
Fixed a bug where build labels declared as a list wouldn't be properly parsed
-
Fixed a bug where the output of
docker-compose configwould be invalid for some versions if the file contained custom-named external volumes -
Improved error handling when issuing a build command on Windows using an unsupported file version
-
Fixed an issue where networks with identical names would sometimes be created when running
upcommands concurrently.
1.16.0
(2017-08-31)
New features
Compose file version 2.3
-
Introduced version 2.3 of the
docker-compose.ymlspecification. This version requires to be used with Docker Engine 17.06.0 or above. -
Added support for the
targetparameter in build configurations -
Added support for the
start_periodparameter in healthcheck configurations
Compose file version 2.x
-
Added support for the
blkio_configparameter in service definitions -
Added support for setting a custom name in volume definitions using the
nameparameter (not available for version 2.0)
All formats
- Added new CLI flag
--no-ansito suppress ANSI control characters in output
Bug fixes
-
Fixed a bug where nested
extendsinstructions weren't resolved properly, causing "file not found" errors -
Fixed several issues with
.dockerignoreparsing -
Fixed issues where logs of TTY-enabled services were being printed incorrectly and causing
MemoryErrorexceptions -
Fixed a bug where printing application logs would sometimes be interrupted by a
UnicodeEncodeErrorexception on Python 3 -
The
$character in the output ofdocker-compose configis now properly escaped -
Fixed a bug where running
docker-compose topwould sometimes fail with an uncaught exception -
Fixed a bug where
docker-compose pullwith the--parallelflag would return a0exit code when failing -
Fixed an issue where keys in
deploy.resourceswere not being validated -
Fixed an issue where the
loggingoptions in the output ofdocker-compose configwould be set tonull, an invalid value -
Fixed the output of the
docker-compose imagescommand when an image would come from a private repository using an explicit port number -
Fixed the output of
docker-compose configwhen a port definition used0as the value for the published port
1.15.0
(2017-07-26)
New features
Compose file version 2.2
- Added support for the
networkparameter in build configurations.
Compose file version 2.1 and up
-
The
pidoption in a service's definition now supports aservice:<name>value. -
Added support for the
storage_optparameter in in service definitions. This option is not available for the v3 format
All formats
-
Added
--quietflag todocker-compose pull, suppressing progress output -
Some improvements to CLI output
Bug fixes
-
Volumes specified through the
--volumeflag ofdocker-compose runnow complement volumes declared in the service's definition instead of replacing them -
Fixed a bug where using multiple Compose files would unset the scale value defined inside the Compose file.
-
Fixed an issue where the
credHelpersentries in theconfig.jsonfile were not being honored by Compose -
Fixed a bug where using multiple Compose files with port declarations would cause failures in Python 3 environments
-
Fixed a bug where some proxy-related options present in the user's environment would prevent Compose from running
-
Fixed an issue where the output of
docker-compose configwould be invalid if the original file usedYorNvalues -
Fixed an issue preventing
upoperations on a previously created stack on Windows Engine.
1.14.0
(2017-06-19)
New features
Compose file version 3.3
- Introduced version 3.3 of the
docker-compose.ymlspecification. This version requires to be used with Docker Engine 17.06.0 or above. Note: thecredential_specandconfigskeys only apply to Swarm services and will be ignored by Compose
Compose file version 2.2
- Added the following parameters in service definitions:
cpu_count,cpu_percent,cpus
Compose file version 2.1
- Added support for build labels. This feature is also available in the 2.2 and 3.3 formats.
All formats
-
Added shorthand
-ufor--userflag indocker-compose exec -
Differences in labels between the Compose file and remote network will now print a warning instead of preventing redeployment.
Bug fixes
-
Fixed a bug where service's dependencies were being rescaled to their default scale when running a
docker-compose runcommand -
Fixed a bug where
docker-compose rmwith the--stopflag was not behaving properly when provided with a list of services to remove -
Fixed a bug where
cache_fromin the build section would be ignored when using more than one Compose file. -
Fixed a bug that prevented binding the same port to different IPs when using more than one Compose file.
-
Fixed a bug where override files would not be picked up by Compose if they had the
.yamlextension -
Fixed a bug on Windows Engine where networks would be incorrectly flagged for recreation
-
Fixed a bug where services declaring ports would cause crashes on some versions of Python 3
-
Fixed a bug where the output of
docker-compose configwould sometimes contain invalid port definitions
1.13.0
(2017-05-02)
Breaking changes
docker-compose upnow resets a service's scaling to its default value. You can use the newly introduced--scaleoption to specify a custom scale value
New features
Compose file version 2.2
-
Introduced version 2.2 of the
docker-compose.ymlspecification. This version requires to be used with Docker Engine 1.13.0 or above -
Added support for
initin service definitions. -
Added support for
scalein service definitions. The configuration's value can be overridden using the--scaleflag indocker-compose up. Thescalecommand is disabled for this file format
Compose file version 2.x
- Added support for
optionsin theipamsection of network definitions
Bug fixes
-
Fixed a bug where paths provided to compose via the
-foption were not being resolved properly -
Fixed a bug where the
ext_ip::target_portnotation in the ports section was incorrectly marked as invalid -
Fixed an issue where the
execcommand would sometimes not return control to the terminal when using the-dflag -
Fixed a bug where secrets were missing from the output of the
configcommand for v3.2 files -
Fixed an issue where
docker-composewould hang if no internet connection was available -
Fixed an issue where paths containing unicode characters passed via the
-fflag were causing Compose to crash -
Fixed an issue where the output of
docker-compose configwould be invalid if the Compose file contained external secrets -
Fixed a bug where using
--exit-code-fromwithupwould fail if Compose was installed in a Python 3 environment -
Fixed a bug where recreating containers using a combination of
tmpfsandvolumeswould result in an invalid config state
1.12.0
(2017-04-04)
New features
Compose file version 3.2
-
Introduced version 3.2 of the
docker-compose.ymlspecification -
Added support for
cache_fromin thebuildsection of services -
Added support for the new expanded ports syntax in service definitions
-
Added support for the new expanded volumes syntax in service definitions
Compose file version 2.1
- Added support for
pids_limitin service definitions
Compose file version 2.0 and up
-
Added
--volumesoption todocker-compose configthat lists named volumes declared for that project -
Added support for
mem_reservationin service definitions (2.x only) -
Added support for
dns_optin service definitions (2.x only)
All formats
-
Added a new
docker-compose imagescommand that lists images used by the current project's containers -
Added a
--stop(shorthand-s) option todocker-compose rmthat stops the running containers before removing them -
Added a
--resolve-image-digestsoption todocker-compose configthat pins the image version for each service to a permanent digest -
Added a
--exit-code-from SERVICEoption todocker-compose up. When used,docker-composewill exit on any container's exit with the code corresponding to the specified service's exit code -
Added a
--paralleloption todocker-compose pullthat enables images for multiple services to be pulled simultaneously -
Added a
--build-argoption todocker-compose build -
Added a
--volume <volume_mapping>(shorthand-v) option todocker-compose runto declare runtime volumes to be mounted -
Added a
--project-directory PATHoption todocker-composethat will affect path resolution for the project -
When using
--abort-on-container-exitindocker-compose up, the exit code for the container that caused the abort will be the exit code of thedocker-compose upcommand -
Users can now configure which path separator character they want to use to separate the
COMPOSE_FILEenvironment value using theCOMPOSE_PATH_SEPARATORenvironment variable -
Added support for port range to a single port in port mappings, such as
8000-8010:80.
Bug fixes
-
docker-compose run --rmnow removes anonymous volumes after execution, matching the behavior ofdocker run --rm. -
Fixed a bug where override files containing port lists would cause a TypeError to be raised
-
Fixed a bug where the
deploykey would be missing from the output ofdocker-compose config -
Fixed a bug where scaling services up or down would sometimes re-use obsolete containers
-
Fixed a bug where the output of
docker-compose configwould be invalid if the project declared anonymous volumes -
Variable interpolation now properly occurs in the
secretssection of the Compose file -
The
secretssection now properly appears in the output ofdocker-compose config -
Fixed a bug where changes to some networks properties would not be detected against previously created networks
-
Fixed a bug where
docker-composewould crash when trying to write into a closed pipe -
Fixed an issue where Compose would not pick up on the value of COMPOSE_TLS_VERSION when used in combination with command-line TLS flags
1.11.2
(2017-02-17)
Bug fixes
-
Fixed a bug that was preventing secrets configuration from being loaded properly
-
Fixed a bug where the
docker-compose configcommand would fail if the config file contained secrets definitions -
Fixed an issue where Compose on some linux distributions would pick up and load an outdated version of the requests library
-
Fixed an issue where socket-type files inside a build folder would cause
docker-composeto crash when trying to build that service -
Fixed an issue where recursive wildcard patterns
**were not being recognized in.dockerignorefiles.
1.11.1
(2017-02-09)
Bug fixes
- Fixed a bug where the 3.1 file format was not being recognized as valid by the Compose parser
1.11.0
(2017-02-08)
New Features
Compose file version 3.1
- Introduced version 3.1 of the
docker-compose.ymlspecification. This version requires Docker Engine 1.13.0 or above. It introduces support for secrets. See the documentation for more information
Compose file version 2.0 and up
- Introduced the
docker-compose topcommand that displays processes running for the different services managed by Compose.
Bug fixes
-
Fixed a bug where extending a service defining a healthcheck dictionary would cause
docker-composeto error out. -
Fixed an issue where the
pidentry in a service definition was being ignored when using multiple Compose files.
1.10.1
(2017-02-01)
Bug fixes
-
Fixed an issue where the presence of older versions of the docker-py package would cause unexpected crashes while running Compose
-
Fixed an issue where healthcheck dependencies would be lost when using multiple compose files for a project
-
Fixed a few issues that made the output of the
configcommand invalid -
Fixed an issue where adding volume labels to v3 Compose files would result in an error
-
Fixed an issue on Windows where build context paths containing unicode characters were being improperly encoded
-
Fixed a bug where Compose would occasionally crash while streaming logs when containers would stop or restart
1.10.0
(2017-01-18)
New Features
Compose file version 3.0
- Introduced version 3.0 of the
docker-compose.ymlspecification. This version requires to be used with Docker Engine 1.13 or above and is specifically designed to work with thedocker stackcommands.
Compose file version 2.1 and up
-
Healthcheck configuration can now be done in the service definition using the
healthcheckparameter -
Containers dependencies can now be set up to wait on positive healthchecks when declared using
depends_on. See the documentation for the updated syntax. Note: This feature will not be ported to version 3 Compose files. -
Added support for the
sysctlsparameter in service definitions -
Added support for the
userns_modeparameter in service definitions -
Compose now adds identifying labels to networks and volumes it creates
Compose file version 2.0 and up
- Added support for the
stop_grace_periodoption in service definitions.
Bug fixes
-
Colored output now works properly on Windows.
-
Fixed a bug where docker-compose run would fail to set up link aliases in interactive mode on Windows.
-
Networks created by Compose are now always made attachable (Compose files v2.1 and up).
-
Fixed a bug where falsy values of
COMPOSE_CONVERT_WINDOWS_PATHS(0,false, empty value) were being interpreted as true. -
Fixed a bug where forward slashes in some .dockerignore patterns weren't being parsed correctly on Windows
1.9.0
(2016-11-16)
Breaking changes
- When using Compose with Docker Toolbox/Machine on Windows, volume paths are
no longer converted from
C:\Usersto/c/Users-style by default. To re-enable this conversion so that your volumes keep working, set the environment variableCOMPOSE_CONVERT_WINDOWS_PATHS=1. Users of Docker for Windows are not affected and do not need to set the variable.
New Features
-
Interactive mode for
docker-compose runanddocker-compose execis now supported on Windows platforms. Thedockerbinary is required to be present on the system for this feature to work. -
Introduced version 2.1 of the
docker-compose.ymlspecification. This version requires to be used with Docker Engine 1.12 or above.- Added support for setting volume labels and network labels in
docker-compose.yml. - Added support for the
isolationparameter in service definitions. - Added support for link-local IPs in the service networks definitions.
- Added support for shell-style inline defaults in variable interpolation.
The supported forms are
${FOO-default}(fall back if FOO is unset) and${FOO:-default}(fall back if FOO is unset or empty).
- Added support for setting volume labels and network labels in
-
Added support for the
group_addandoom_score_adjparameters in service definitions. -
Added support for the
internalandenable_ipv6parameters in network definitions. -
Compose now defaults to using the
npipeprotocol on Windows. -
Overriding a
loggingconfiguration will now properly merge theoptionsmappings if thedrivervalues do not conflict.
Bug fixes
-
Fixed several bugs related to
npipeprotocol support on Windows. -
Fixed an issue with Windows paths being incorrectly converted when using Docker on Windows Server.
-
Fixed a bug where an empty
restartvalue would sometimes result in an exception being raised. -
Fixed an issue where service logs containing unicode characters would sometimes cause an error to occur.
-
Fixed a bug where unicode values in environment variables would sometimes raise a unicode exception when retrieved.
-
Fixed an issue where Compose would incorrectly detect a configuration mismatch for overlay networks.
1.8.1
(2016-09-22)
Bug fixes
-
Fixed a bug where users using a credentials store were not able to access their private images.
-
Fixed a bug where users using identity tokens to authenticate were not able to access their private images.
-
Fixed a bug where an
HttpHeadersentry in the docker configuration file would cause Compose to crash when trying to build an image. -
Fixed a few bugs related to the handling of Windows paths in volume binding declarations.
-
Fixed a bug where Compose would sometimes crash while trying to read a streaming response from the engine.
-
Fixed an issue where Compose would crash when encountering an API error while streaming container logs.
-
Fixed an issue where Compose would erroneously try to output logs from drivers not handled by the Engine's API.
-
Fixed a bug where options from the
docker-machine configcommand would not be properly interpreted by Compose. -
Fixed a bug where the connection to the Docker Engine would sometimes fail when running a large number of services simultaneously.
-
Fixed an issue where Compose would sometimes print a misleading suggestion message when running the
bundlecommand. -
Fixed a bug where connection errors would not be handled properly by Compose during the project initialization phase.
-
Fixed a bug where a misleading error would appear when encountering a connection timeout.
1.8.0
(2016-06-14)
Breaking Changes
-
As announced in 1.7.0,
docker-compose rmnow removes containers created bydocker-compose runby default. -
Setting
entrypointon a service now empties out any default command that was set on the image (i.e. anyCMDinstruction in the Dockerfile used to build it). This makes it consistent with the--entrypointflag todocker run.
New Features
-
Added
docker-compose bundle, a command that builds a bundle file to be consumed by the new Docker Stack commands in Docker 1.12. -
Added
docker-compose push, a command that pushes service images to a registry. -
Compose now supports specifying a custom TLS version for interaction with the Docker Engine using the
COMPOSE_TLS_VERSIONenvironment variable.
Bug fixes
-
Fixed a bug where Compose would erroneously try to read
.envat the project's root when it is a directory. -
docker-compose run -e VARnow passesVARthrough from the shell to the container, as withdocker run -e VAR. -
Improved config merging when multiple compose files are involved for several service sub-keys.
-
Fixed a bug where volume mappings containing Windows drives would sometimes be parsed incorrectly.
-
Fixed a bug in Windows environment where volume mappings of the host's root directory would be parsed incorrectly.
-
Fixed a bug where
docker-compose configwould output an invalid Compose file if external networks were specified. -
Fixed an issue where unset buildargs would be assigned a string containing
'None'instead of the expected empty value. -
Fixed a bug where yes/no prompts on Windows would not show before receiving input.
-
Fixed a bug where trying to
docker-compose execon Windows without the-doption would exit with a stacktrace. This will still fail for the time being, but should do so gracefully. -
Fixed a bug where errors during
docker-compose upwould show an unrelated stacktrace at the end of the process. -
docker-compose createanddocker-compose startshow more descriptive error messages when something goes wrong.
1.7.1
(2016-05-04)
Bug fixes
-
Fixed a bug where the output of
docker-compose configfor v1 files would be an invalid configuration file. -
Fixed a bug where
docker-compose configwould not check the validity of links. -
Fixed an issue where
docker-compose helpwould not output a list of available commands and generic options as expected. -
Fixed an issue where filtering by service when using
docker-compose logswould not apply for newly created services. -
Fixed a bug where unchanged services would sometimes be recreated in in the up phase when using Compose with Python 3.
-
Fixed an issue where API errors encountered during the up phase would not be recognized as a failure state by Compose.
-
Fixed a bug where Compose would raise a NameError because of an undefined exception name on non-Windows platforms.
-
Fixed a bug where the wrong version of
docker-pywould sometimes be installed alongside Compose. -
Fixed a bug where the host value output by
docker-machine config defaultwould not be recognized as valid options by thedocker-composecommand line. -
Fixed an issue where Compose would sometimes exit unexpectedly while reading events broadcasted by a Swarm cluster.
-
Corrected a statement in the docs about the location of the
.envfile, which is indeed read from the current directory, instead of in the same location as the Compose file.
1.7.0
(2016-04-13)
Breaking Changes
-
docker-compose logsno longer follows log output by default. It now matches the behavior ofdocker logsand exits after the current logs are printed. Use-fto get the old default behavior. -
Booleans are no longer allows as values for mappings in the Compose file (for keys
environment,labelsandextra_hosts). Previously this was a warning. Boolean values should be quoted so they become string values.
New Features
-
Compose now looks for a
.envfile in the directory where it's run and reads any environment variables defined inside, if they're not already set in the shell environment. This lets you easily set defaults for variables used in the Compose file, or for any of theCOMPOSE_*orDOCKER_*variables. -
Added a
--remove-orphansflag to bothdocker-compose upanddocker-compose downto remove containers for services that were removed from the Compose file. -
Added a
--allflag todocker-compose rmto include containers created bydocker-compose run. This will become the default behavior in the next version of Compose. -
Added support for all the same TLS configuration flags used by the
dockerclient:--tls,--tlscert,--tlskey, etc. -
Compose files now support the
tmpfsandshm_sizeoptions. -
Added the
--workdirflag todocker-compose run -
docker-compose logsnow shows logs for new containers that are created after it starts. -
The
COMPOSE_FILEenvironment variable can now contain multiple files, separated by the host system's standard path separator (:on Mac/Linux,;on Windows). -
You can now specify a static IP address when connecting a service to a network with the
ipv4_addressandipv6_addressoptions. -
Added
--follow,--timestamp, and--tailflags to thedocker-compose logscommand. -
docker-compose up, anddocker-compose startwill now start containers in parallel where possible. -
docker-compose stopnow stops containers in reverse dependency order instead of all at once. -
Added the
--buildflag todocker-compose upto force it to build a new image. It now shows a warning if an image is automatically built when the flag is not used. -
Added the
docker-compose execcommand for executing a process in a running container.
Bug fixes
-
docker-compose downnow removes containers created bydocker-compose run. -
A more appropriate error is shown when a timeout is hit during
upwhen using a tty. -
Fixed a bug in
docker-compose downwhere it would abort if some resources had already been removed. -
Fixed a bug where changes to network aliases would not trigger a service to be recreated.
-
Fix a bug where a log message was printed about creating a new volume when it already existed.
-
Fixed a bug where interrupting
upwould not always shut down containers. -
Fixed a bug where
log_optandlog_driverwere not properly carried over when extending services in the v1 Compose file format. -
Fixed a bug where empty values for build args would cause file validation to fail.
1.6.2
(2016-02-23)
- Fixed a bug where connecting to a TLS-enabled Docker Engine would fail with a certificate verification error.
1.6.1
(2016-02-23)
Bug fixes
-
Fixed a bug where recreating a container multiple times would cause the new container to be started without the previous volumes.
-
Fixed a bug where Compose would set the value of unset environment variables to an empty string, instead of a key without a value.
-
Provide a better error message when Compose requires a more recent version of the Docker API.
-
Add a missing config field
network.aliaseswhich allows setting a network scoped alias for a service. -
Fixed a bug where
runwould not start services listed independs_on. -
Fixed a bug where
networksandnetwork_modewhere not merged when using extends or multiple Compose files. -
Fixed a bug with service aliases where the short container id alias was only contained 10 characters, instead of the 12 characters used in previous versions.
-
Added a missing log message when creating a new named volume.
-
Fixed a bug where
build.argswas not merged when usingextendsor multiple Compose files. -
Fixed some bugs with config validation when null values or incorrect types were used instead of a mapping.
-
Fixed a bug where a
buildsection without acontextwould show a stack trace instead of a helpful validation message. -
Improved compatibility with swarm by only setting a container affinity to the previous instance of a services' container when the service uses an anonymous container volume. Previously the affinity was always set on all containers.
-
Fixed the validation of some
driver_optswould cause an error if a number was used instead of a string. -
Some improvements to the
run.shscript used by the Compose container install option. -
Fixed a bug with
up --abort-on-container-exitwhere Compose would exit, but would not stop other containers. -
Corrected the warning message that is printed when a boolean value is used as a value in a mapping.
1.6.0
(2016-01-15)
Major Features
-
Compose 1.6 introduces a new format for
docker-compose.ymlwhich lets you define networks and volumes in the Compose file as well as services. It also makes a few changes to the structure of some configuration options.You don't have to use it - your existing Compose files will run on Compose 1.6 exactly as they do today.
Check the upgrade guide for full details.
-
Support for networking has exited experimental status and is the recommended way to enable communication between containers.
If you use the new file format, your app will use networking. If you aren't ready yet, just leave your Compose file as it is and it'll continue to work just the same.
By default, you don't have to configure any networks. In fact, using networking with Compose involves even less configuration than using links. Consult the networking guide for how to use it.
The experimental flags
--x-networkingand--x-network-driver, introduced in Compose 1.5, have been removed. -
You can now pass arguments to a build if you're using the new file format:
build: context: . args: buildno: 1 -
You can now specify both a
buildand animagekey if you're using the new file format.docker-compose buildwill build the image and tag it with the name you've specified, whiledocker-compose pullwill attempt to pull it. -
There's a new
eventscommand for monitoring container events from the application, much likedocker events. This is a good primitive for building tools on top of Compose for performing actions when particular things happen, such as containers starting and stopping. -
There's a new
depends_onoption for specifying dependencies between services. This enforces the order of startup, and ensures that when you rundocker-compose up SERVICEon a service with dependencies, those are started as well.
New Features
-
Added a new command
configwhich validates and prints the Compose configuration after interpolating variables, resolving relative paths, and merging multiple files andextends. -
Added a new command
createfor creating containers without starting them. -
Added a new command
downto stop and remove all the resources created byupin a single command. -
Added support for the
cpu_quotaconfiguration option. -
Added support for the
stop_signalconfiguration option. -
Commands
start,restart,pause, andunpausenow exit with an error status code if no containers were modified. -
Added a new
--abort-on-container-exitflag toupwhich causesupto stop all container and exit once the first container exits. -
Removed support for
FIG_FILE,FIG_PROJECT_NAME, and no longer readsfig.ymlas a default Compose file location. -
Removed the
migrate-to-labelscommand. -
Removed the
--allow-insecure-sslflag.
Bug fixes
-
Fixed a validation bug that prevented the use of a range of ports in the
exposefield. -
Fixed a validation bug that prevented the use of arrays in the
entrypointfield if they contained duplicate entries. -
Fixed a bug that caused
ulimitsto be ignored when used withextends. -
Fixed a bug that prevented ipv6 addresses in
extra_hosts. -
Fixed a bug that caused
extendsto be ignored when included from multiple Compose files. -
Fixed an incorrect warning when a container volume was defined in the Compose file.
-
Fixed a bug that prevented the force shutdown behavior of
upandlogs. -
Fixed a bug that caused
Noneto be printed as the network driver name when the default network driver was used. -
Fixed a bug where using the string form of
dnsordns_searchwould cause an error. -
Fixed a bug where a container would be reported as "Up" when it was in the restarting state.
-
Fixed a confusing error message when DOCKER_CERT_PATH was not set properly.
-
Fixed a bug where attaching to a container would fail if it was using a non-standard logging driver (or none at all).
1.5.2
(2015-12-03)
-
Fixed a bug which broke the use of
environmentandenv_filewithextends, and caused environment keys without values to have aNonevalue, instead of a value from the host environment. -
Fixed a regression in 1.5.1 that caused a warning about volumes to be raised incorrectly when containers were recreated.
-
Fixed a bug which prevented building a
Dockerfilethat usedADD <url> -
Fixed a bug with
docker-compose restartwhich prevented it from starting stopped containers. -
Fixed handling of SIGTERM and SIGINT to properly stop containers
-
Add support for using a url as the value of
build -
Improved the validation of the
exposeoption
1.5.1
(2015-11-12)
-
Add the
--force-rmoption tobuild. -
Add the
ulimitoption for services in the Compose file. -
Fixed a bug where
upwould error with "service needs to be built" if a service changed from usingimageto usingbuild. -
Fixed a bug that would cause incorrect output of parallel operations on some terminals.
-
Fixed a bug that prevented a container from being recreated when the mode of a
volumes_fromwas changed. -
Fixed a regression in 1.5.0 where non-utf-8 unicode characters would cause
uporlogsto crash. -
Fixed a regression in 1.5.0 where Compose would use a success exit status code when a command fails due to an HTTP timeout communicating with the docker daemon.
-
Fixed a regression in 1.5.0 where
namewas being accepted as a valid service option which would override the actual name of the service. -
When using
--x-networkingCompose no longer sets the hostname to the container name. -
When using
--x-networkingCompose will only create the default network if at least one container is using the network. -
When printings logs during
uporlogs, flush the output buffer after each line to prevent buffering issues from hiding logs. -
Recreate a container if one of its dependencies is being created. Previously a container was only recreated if it's dependencies already existed, but were being recreated as well.
-
Add a warning when a
volumein the Compose file is being ignored and masked by a container volume from a previous container. -
Improve the output of
pullwhen run without a tty. -
When using multiple Compose files, validate each before attempting to merge them together. Previously invalid files would result in not helpful errors.
-
Allow dashes in keys in the
environmentservice option. -
Improve validation error messages by including the filename as part of the error message.
1.5.0
(2015-11-03)
Breaking changes
With the introduction of variable substitution support in the Compose file, any
Compose file that uses an environment variable ($VAR or ${VAR}) in the command:
or entrypoint: field will break.
Previously these values were interpolated inside the container, with a value from the container environment. In Compose 1.5.0, the values will be interpolated on the host, with a value from the host environment.
To migrate a Compose file to 1.5.0, escape the variables with an extra $
(ex: $$VAR or $${VAR}). See
https://github.com/docker/compose/blob/8cc8e61/docs/compose-file.md#variable-substitution
Major features
-
Compose is now available for Windows.
-
Environment variables can be used in the Compose file. See https://github.com/docker/compose/blob/8cc8e61/docs/compose-file.md#variable-substitution
-
Multiple compose files can be specified, allowing you to override settings in the default Compose file. See https://github.com/docker/compose/blob/8cc8e61/docs/reference/docker-compose.md for more details.
-
Compose now produces better error messages when a file contains invalid configuration.
-
upnow waits for all services to exit before shutting down, rather than shutting down as soon as one container exits. -
Experimental support for the new docker networking system can be enabled with the
--x-networkingflag. Read more here: https://github.com/docker/docker/blob/8fee1c20/docs/userguide/dockernetworks.md
New features
-
You can now optionally pass a mode to
volumes_from. For example,volumes_from: ["servicename:ro"]. -
Since Docker now lets you create volumes with names, you can refer to those volumes by name in
docker-compose.yml. For example,volumes: ["mydatavolume:/data"]will mount the volume namedmydatavolumeat the path/datainside the container.If the first component of an entry in
volumesstarts with a.,/or~, it is treated as a path and expansion of relative paths is performed as necessary. Otherwise, it is treated as a volume name and passed straight through to Docker.Read more on named volumes and volume drivers here: https://github.com/docker/docker/blob/244d9c33/docs/userguide/dockervolumes.md
-
docker-compose build --pullinstructs Compose to pull the base image for each Dockerfile before building. -
docker-compose pull --ignore-pull-failuresinstructs Compose to continue if it fails to pull a single service's image, rather than aborting. -
You can now specify an IPC namespace in
docker-compose.ymlwith theipcoption. -
Containers created by
docker-compose runcan now be named with the--nameflag. -
If you install Compose with pip or use it as a library, it now works with Python 3.
-
imagenow supports image digests (in addition to ids and tags). For example,image: "busybox@sha256:38a203e1986cf79639cfb9b2e1d6e773de84002feea2d4eb006b52004ee8502d" -
portsnow supports ranges of ports. For example,ports: - "3000-3005" - "9000-9001:8000-8001" -
docker-compose runnow supports a-p|--publishparameter, much likedocker run -p, for publishing specific ports to the host. -
docker-compose pauseanddocker-compose unpausehave been implemented, analogous todocker pauseanddocker unpause. -
When using
extendsto copy configuration from another service in the same Compose file, you can omit thefileoption. -
Compose can be installed and run as a Docker image. This is an experimental feature.
Bug fixes
-
All values for the
log_driveroption which are supported by the Docker daemon are now supported by Compose. -
docker-compose buildcan now be run successfully against a Swarm cluster.
1.4.2
(2015-09-22)
- Fixed a regression in the 1.4.1 release that would cause
docker-compose upwithout the-doption to exit immediately.
1.4.1
(2015-09-10)
Bug fixes
- Some configuration changes (notably changes to
links,volumes_from, andnet) were not properly triggering a container recreate as part ofdocker-compose up. docker-compose up <service>was showing logs for all services instead of just the specified services.- Containers with custom container names were showing up in logs as
service_numberinstead of their custom container name. - When scaling a service sometimes containers would be recreated even when the configuration had not changed.
1.4.0
(2015-08-04)
-
By default,
docker-compose upnow only recreates containers for services whose configuration has changed since they were created. This should result in a dramatic speed-up for many applications.The experimental
--x-smart-recreateflag which introduced this feature in Compose 1.3.0 has been removed, and a--force-recreateflag has been added for when you want to recreate everything. -
Several of Compose's commands -
scale,stop,killandrm- now perform actions on multiple containers in parallel, rather than in sequence, which will run much faster on larger applications. -
You can now specify a custom name for a service's container with
container_name. Because Docker container names must be unique, this means you can't scale the service beyond one container. -
You no longer have to specify a
fileoption when usingextends- it will default to the current file. -
Service names can now contain dots, dashes and underscores.
-
Compose can now read YAML configuration from standard input, rather than from a file, by specifying
-as the filename. This makes it easier to generate configuration dynamically:$ echo 'redis: {"image": "redis"}' | docker-compose --file - up -
There's a new
docker-compose versioncommand which prints extended information about Compose's bundled dependencies. -
docker-compose.ymlnow supportslog_optas well aslog_driver, allowing you to pass extra configuration to a service's logging driver. -
docker-compose.ymlnow supportsmemswap_limit, similar todocker run --memory-swap. -
When mounting volumes with the
volumesoption, you can now pass in any mode supported by the daemon, not just:roor:rw. For example, SELinux users can pass:zor:Z. -
You can now specify a custom volume driver with the
volume_driveroption indocker-compose.yml, much likedocker run --volume-driver. -
A bug has been fixed where Compose would fail to pull images from private registries serving plain (unsecured) HTTP. The
--allow-insecure-sslflag, which was previously used to work around this issue, has been deprecated and now has no effect. -
A bug has been fixed where
docker-compose buildwould fail if the build depended on a private Hub image or an image from a private registry. -
A bug has been fixed where Compose would crash if there were containers which the Docker daemon had not finished removing.
-
Two bugs have been fixed where Compose would sometimes fail with a "Duplicate bind mount" error, or fail to attach volumes to a container, if there was a volume path specified in
docker-compose.ymlwith a trailing slash.
Thanks @mnowster, @dnephin, @ekristen, @funkyfuture, @jeffk and @lukemarsden!
1.3.3
(2015-07-15)
Regression fixes
- When stopping containers gracefully, Compose was setting the timeout to 0, effectively forcing a SIGKILL every time.
- Compose would sometimes crash depending on the formatting of container data returned from the Docker API.
1.3.2
(2015-07-14)
Bug fixes
- When there were one-off containers created by running
docker-compose runon an older version of Compose,docker-compose runwould fail with a name collision. Compose now shows an error if you have leftover containers of this type lying around, and tells you how to remove them. - Compose was not reading Docker authentication config files created in the new location,
~/docker/config.json, and authentication against private registries would therefore fail. - When a container had a pseudo-TTY attached, its output in
docker-compose upwould be truncated. docker-compose up --x-smart-recreatewould sometimes fail when an image tag was updated.docker-compose upwould sometimes create two containers with the same numeric suffix.docker-compose rmanddocker-compose pswould sometimes list services that aren't part of the current project (though no containers were erroneously removed).- Some
docker-composecommands would not show an error if invalid service names were passed in.
Thanks @dano, @josephpage, @kevinsimper, @lieryan, @phemmer, @soulrebel and @sschepens!
1.3.1
(2015-06-21)
Bug fixes
docker-compose buildwould always attempt to pull the base image before building.docker-compose help migrate-to-labelsfailed with an error.- If no network mode was specified, Compose would set it to "bridge", rather than allowing the Docker daemon to use its configured default network mode.
1.3.0
(2015-06-18)
Important notes
-
This release contains breaking changes, and you will need to either remove or migrate your existing containers before running your app - see the upgrading section of the install docs for details.
-
Compose now requires Docker 1.6.0 or later.
Improvements
-
Compose now uses container labels, rather than names, to keep track of containers. This makes Compose both faster and easier to integrate with your own tools.
-
Compose no longer uses "intermediate containers" when recreating containers for a service. This makes
docker-compose upless complex and more resilient to failure.
New features
-
docker-compose uphas an experimental new behavior: it will only recreate containers for services whose configuration has changed indocker-compose.yml. This will eventually become the default, but for now you can take it for a spin:$ docker-compose up --x-smart-recreate -
When invoked in a subdirectory of a project,
docker-composewill now climb up through parent directories until it finds adocker-compose.yml.
Several new configuration keys have been added to docker-compose.yml:
dockerfile, likedocker build --file, lets you specify an alternate Dockerfile to use withbuild.labels, likedocker run --labels, lets you add custom metadata to containers.extra_hosts, likedocker run --add-host, lets you add entries to a container's/etc/hostsfile.pid: host, likedocker run --pid=host, lets you reuse the same PID namespace as the host machine.cpuset, likedocker run --cpuset-cpus, lets you specify which CPUs to allow execution in.read_only, likedocker run --read-only, lets you mount a container's filesystem as read-only.security_opt, likedocker run --security-opt, lets you specify security options.log_driver, likedocker run --log-driver, lets you specify a log driver.
Bug fixes
- The output of
docker-compose runwas sometimes truncated, especially when running under Jenkins. - A service's volumes would sometimes not update after volume configuration was changed in
docker-compose.yml. - Authenticating against third-party registries would sometimes fail.
docker-compose run --rmwould fail to remove the container if the service had arestartpolicy in place.docker-compose scalewould refuse to scale a service beyond 1 container if it exposed a specific port number on the host.- Compose would refuse to create multiple volume entries with the same host path.
Thanks @ahromis, @albers, @aleksandr-vin, @antoineco, @ccverak, @chernjie, @dnephin, @edmorley, @fordhurley, @josephpage, @KyleJamesWalker, @lsowen, @mchasal, @noironetworks, @sdake, @sdurrheimer, @sherter, @stephenlawrence, @thaJeztah, @thieman, @turtlemonvh, @twhiteman, @vdemeester, @xuxinkun and @zwily!
1.2.0
(2015-04-16)
-
docker-compose.ymlnow supports anextendsoption, which enables a service to inherit configuration from another service in another configuration file. This is really good for sharing common configuration between apps, or for configuring the same app for different environments. Here's the documentation. -
When using Compose with a Swarm cluster, containers that depend on one another will be co-scheduled on the same node. This means that most Compose apps will now work out of the box, as long as they don't use
build. -
Repeated invocations of
docker-compose upwhen using Compose with a Swarm cluster now work reliably. -
Directories passed to
build, filenames passed toenv_fileand volume host paths passed tovolumesare now treated as relative to the directory of the configuration file, not the directory thatdocker-composeis being run in. In the majority of cases, those are the same, but if you use the-f|--fileargument to specify a configuration file in another directory, this is a breaking change. -
A service can now share another service's network namespace with
net: container:<service>. -
volumes_fromandnet: container:<service>entries are taken into account when resolving dependencies, sodocker-compose up <service>will correctly start all dependencies of<service>. -
docker-compose runnow accepts a--userargument to specify a user to run the command as, just likedocker run. -
The
up,stopandrestartcommands now accept a--timeout(or-t) argument to specify how long to wait when attempting to gracefully stop containers, just likedocker stop. -
docker-compose rmnow accepts-fas a shorthand for--force, just likedocker rm.
Thanks, @abesto, @albers, @alunduil, @dnephin, @funkyfuture, @gilclark, @IanVS, @KingsleyKelly, @knutwalker, @thaJeztah and @vmalloc!
1.1.0
(2015-02-25)
Fig has been renamed to Docker Compose, or just Compose for short. This has several implications for you:
- The command you type is now
docker-compose, notfig. - You should rename your fig.yml to docker-compose.yml.
- If you’re installing via PyPI, the package is now
docker-compose, so install it withpip install docker-compose.
Besides that, there’s a lot of new stuff in this release:
-
We’ve made a few small changes to ensure that Compose will work with Swarm, Docker’s new clustering tool (https://github.com/docker/swarm). Eventually you'll be able to point Compose at a Swarm cluster instead of a standalone Docker host and it’ll run your containers on the cluster with no extra work from you. As Swarm is still developing, integration is rough and lots of Compose features don't work yet.
-
docker-compose runnow has a--service-portsflag for exposing ports on the given service. This is useful for running your webapp with an interactive debugger, for example. -
You can now link to containers outside your app with the
external_linksoption in docker-compose.yml. -
You can now prevent
docker-compose upfrom automatically building images with the--no-buildoption. This will make fewer API calls and run faster. -
If you don’t specify a tag when using the
imagekey, Compose will default to thelatesttag, rather than pulling all tags. -
docker-compose killnow supports the-sflag, allowing you to specify the exact signal you want to send to a service’s containers. -
docker-compose.yml now has an
env_filekey, analogous todocker run --env-file, letting you specify multiple environment variables in a separate file. This is great if you have a lot of them, or if you want to keep sensitive information out of version control. -
docker-compose.yml now supports the
dns_search,cap_add,cap_drop,cpu_sharesandrestartoptions, analogous todocker run’s--dns-search,--cap-add,--cap-drop,--cpu-sharesand--restartoptions. -
Compose now ships with Bash tab completion - see the installation and usage docs at https://github.com/docker/compose/blob/1.1.0/docs/completion.md
-
A number of bugs have been fixed - see the milestone for details: https://github.com/docker/compose/issues?q=milestone%3A1.1.0+
Thanks @dnephin, @squebe, @jbalonso, @raulcd, @benlangfield, @albers, @ggtools, @bersace, @dtenenba, @petercv, @drewkett, @TFenby, @paulRbr, @Aigeruth and @salehe!
1.0.1
(2014-11-04)
- Added an
--allow-insecure-ssloption to allowfig up,fig runandfig pullto pull from insecure registries. - Fixed
fig runnot showing output in Jenkins. - Fixed a bug where Fig couldn't build Dockerfiles with ADD statements pointing at URLs.
1.0.0
(2014-10-16)
The highlights:
-
Fig has joined Docker. Fig will continue to be maintained, but we'll also be incorporating the best bits of Fig into Docker itself.
This means the GitHub repository has moved to https://github.com/docker/fig and our IRC channel is now #docker-fig on Freenode.
-
Fig can be used with the official Docker OS X installer. Boot2Docker will mount the home directory from your host machine so volumes work as expected.
-
Fig supports Docker 1.3.
-
It is now possible to connect to the Docker daemon using TLS by using the
DOCKER_CERT_PATHandDOCKER_TLS_VERIFYenvironment variables. -
There is a new
fig portcommand which outputs the host port binding of a service, in a similar way todocker port. -
There is a new
fig pullcommand which pulls the latest images for a service. -
There is a new
fig restartcommand which restarts a service's containers. -
Fig creates multiple containers in service by appending a number to the service name. For example,
db_1,db_2. As a convenience, Fig will now give the first container an alias of the service name. For example,db.This link alias is also a valid hostname and added to
/etc/hostsso you can connect to linked services using their hostname. For example, instead of resolving the environment variablesDB_PORT_5432_TCP_ADDRandDB_PORT_5432_TCP_PORT, you could just use the hostnamedband port5432directly. -
Volume definitions now support
romode, expanding~and expanding environment variables. -
.dockerignoreis supported when building. -
The project name can be set with the
FIG_PROJECT_NAMEenvironment variable. -
The
--envand--entrypointoptions have been added tofig run. -
The Fig binary for Linux is now linked against an older version of glibc so it works on CentOS 6 and Debian Wheezy.
Other things:
fig psnow works on Jenkins and makes fewer API calls to the Docker daemon.--verbosedisplays more useful debugging output.- When starting a service where
volumes_frompoints to a service without any containers running, that service will now be started. - Lots of docs improvements. Notably, environment variables are documented and official repositories are used throughout.
Thanks @dnephin, @d11wtq, @marksteve, @rubbish, @jbalonso, @timfreund, @alunduil, @mieciu, @shuron, @moss, @suzaku and @chmouel! Whew.
0.5.2
(2014-07-28)
- Added a
--no-cacheoption tofig build, which bypasses the cache just likedocker build --no-cache. - Fixed the
dns:fig.yml option, which was causing fig to error out. - Fixed a bug where fig couldn't start under Python 2.6.
- Fixed a log-streaming bug that occasionally caused fig to exit.
Thanks @dnephin and @marksteve!
0.5.1
(2014-07-11)
- If a service has a command defined,
fig run [service]with no further arguments will run it. - The project name now defaults to the directory containing fig.yml, not the current working directory (if they're different)
volumes_fromnow works properly with containers as well as services- Fixed a race condition when recreating containers in
fig up
Thanks @ryanbrainard and @d11wtq!
0.5.0
(2014-07-11)
-
Fig now starts links when you run
fig runorfig up.For example, if you have a
webservice which depends on adbservice,fig run web ...will start thedbservice. -
Environment variables can now be resolved from the environment that Fig is running in. Just specify it as a blank variable in your
fig.ymland, if set, it'll be resolved:environment: RACK_ENV: development SESSION_SECRET: -
volumes_fromis now supported infig.yml. All of the volumes from the specified services and containers will be mounted:volumes_from: - service_name - container_name -
A host address can now be specified in
ports:ports: - "0.0.0.0:8000:8000" - "127.0.0.1:8001:8001" -
The
netandworkdiroptions are now supported infig.yml. -
The
hostnameoption now works in the same way as the Docker CLI, splitting out into adomainnameoption. -
TTY behavior is far more robust, and resizes are supported correctly.
-
Load YAML files safely.
Thanks to @d11wtq, @ryanbrainard, @rail44, @j0hnsmith, @binarin, @Elemecca, @mozz100 and @marksteve for their help with this release!
0.4.2
(2014-06-18)
- Fix various encoding errors when using
fig run,fig upandfig build.
0.4.1
(2014-05-08)
- Add support for Docker 0.11.0. (Thanks @marksteve!)
- Make project name configurable. (Thanks @jefmathiot!)
- Return correct exit code from
fig run.
0.4.0
(2014-04-29)
- Support Docker 0.9 and 0.10
- Display progress bars correctly when pulling images (no more ski slopes)
fig upnow stops all services when any container exits- Added support for the
privilegedconfig option in fig.yml (thanks @kvz!) - Shortened and aligned log prefixes in
fig upoutput - Only containers started with
fig runlink back to their own service - Handle UTF-8 correctly when streaming
fig build/run/upoutput (thanks @mauvm and @shanejonas!) - Error message improvements
0.3.2
(2014-03-05)
- Added an
--rmoption tofig run. (Thanks @marksteve!) - Added an
exposeoption tofig.yml.
0.3.1
(2014-03-04)
- Added contribution instructions. (Thanks @kvz!)
- Fixed
fig rmthrowing an error. - Fixed a bug in
fig pson Docker 0.8.1 when there is a container with no command.
0.3.0
(2014-03-03)
- We now ship binaries for OS X and Linux. No more having to install with Pip!
- Add
-fflag to specify alternatefig.ymlfiles - Add support for custom link names
- Fix a bug where recreating would sometimes hang
- Update docker-py to support Docker 0.8.0.
- Various documentation improvements
- Various error message improvements
Thanks @marksteve, @Gazler and @teozkr!
0.2.2
(2014-02-17)
- Resolve dependencies using Cormen/Tarjan topological sort
- Fix
fig upnot printing log output - Stop containers in reverse order to starting
- Fix scale command not binding ports
Thanks to @barnybug and @dustinlacewell for their work on this release.
0.2.1
(2014-02-04)
- General improvements to error reporting (#77, #79)
0.2.0
(2014-01-31)
- Link services to themselves so run commands can access the running service. (#67)
- Much better documentation.
- Make service dependency resolution more reliable. (#48)
- Load Fig configurations with a
.yamlextension. (#58)
Big thanks to @cameronmaske, @mrchrisadams and @damianmoore for their help with this release.
0.1.4
(2014-01-27)
- Add a link alias without the project name. This makes the environment variables a little shorter:
REDIS_1_PORT_6379_TCP_ADDR. (#54)
0.1.3
(2014-01-23)
- Fix ports sometimes being configured incorrectly. (#46)
- Fix log output sometimes not displaying. (#47)
0.1.2
(2014-01-22)
- Add
-Toption tofig runto disable pseudo-TTY. (#34) - Fix
fig uprequiring the ubuntu image to be pulled to recreate containers. (#33) Thanks @cameronmaske! - Improve reliability, fix arrow keys and fix a race condition in
fig run. (#34, #39, #40)
0.1.1
(2014-01-17)
- Fix bug where ports were not exposed correctly (#29). Thanks @dustinlacewell!
0.1.0
(2014-01-16)
- Containers are recreated on each
fig up, ensuring config is up-to-date withfig.yml(#2) - Add
fig scalecommand (#9) - Use
DOCKER_HOSTenvironment variable to find Docker daemon, for consistency with the official Docker client (was previouslyDOCKER_URL) (#19) - Truncate long commands in
fig ps(#18) - Fill out CLI help banners for commands (#15, #16)
- Show a friendlier error when
fig.ymlis missing (#4) - Fix bug with
fig buildlogging (#3) - Fix bug where builds would time out if a step took a long time without generating output (#6)
- Fix bug where streaming container output over the Unix socket raised an error (#7)
Big thanks to @tomstuart, @EnTeQuAk, @schickling, @aronasorman and @GeoffreyPlitt.
0.0.2
(2014-01-02)
- Improve documentation
- Try to connect to Docker on
tcp://localdocker:4243and a UNIX socket in addition tolocalhost. - Improve
fig upbehavior - Add confirmation prompt to
fig rm - Add
fig buildcommand
0.0.1
(2013-12-20)
Initial release.