Define and run multi-container applications with Docker
Go to file
Mazz Mosley d31d24d19f Work around some coupling of links, net & volume_from
This is minimal disruptive change I could make to ensure
the service integration tests worked, now we have some validation
happening.

There is some coupling/entanglement/assumption going on here.

Project when creating a service, using it's class method from_dicts
performs some transformations on links, net & volume_from, which
get passed on to Service when creating. Service itself, then performs
some transformation on those values. This worked fine in the tests before
because those options were merely passed on via make_service_dict.

This is no longer true with our validation in place. You can't pass to
ServiceLoader [(obj, 'string')] for links, the validation expects it to be
a list of strings. Which it would be when passed into Project.from_dicts
method.

I think the tests need some re-factoring but for now, manually deleting
keys out of the kwargs and then putting them back in for Service Creation
allows the tests to continue.

I am not super happy about this approach. Hopefully we can come back and
improve it.

Signed-off-by: Mazz Mosley <mazz@houseofmnowster.com>
2015-09-02 15:43:52 +01:00
bin Rename binary to docker-compose and config file to docker-compose.yml 2015-01-20 21:00:23 +00:00
compose Pass service_name to process_errors 2015-09-02 15:42:38 +01:00
contrib/completion Merge pull request #1928 from albers/completion-timeout 2015-08-27 12:37:55 -04:00
docs Merge pull request #1940 from hermanjunge/patch-1 2015-08-31 10:43:30 +01:00
experimental Fixes 2015-06-22 08:44:41 -07:00
project Add ISSUE-TRIAGE.md doc 2015-08-28 14:10:15 -04:00
script Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 2015-09-01 16:27:44 -04:00
tests Work around some coupling of links, net & volume_from 2015-09-02 15:43:52 +01:00
.dockerignore Normalise ignore files 2015-08-27 13:51:51 +01:00
.gitignore Normalise ignore files 2015-08-27 13:51:51 +01:00
.pre-commit-config.yaml Add pre-commit hooks 2015-08-24 17:04:45 -04:00
CHANGELOG.md Run pre-commit on all files 2015-08-24 17:04:50 -04:00
CHANGES.md Rename CHANGES.md to CHANGELOG.md 2015-08-14 11:27:27 +01:00
CONTRIBUTING.md Link to ZenHub instead of Waffle 2015-09-01 17:23:39 -07:00
Dockerfile Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 2015-09-01 16:27:44 -04:00
LICENSE Docker, Inc. 2014-07-24 10:24:17 -07:00
MAINTAINERS Add Mazz to MAINTAINERS 2015-07-01 15:38:07 +01:00
MANIFEST.in Include schema in manifest 2015-08-11 16:31:56 +01:00
README.md Run pre-commit on all files 2015-08-24 17:04:50 -04:00
ROADMAP.md Update roadmap with state convergence 2015-07-21 15:37:55 +01:00
SWARM.md Update Swarm docs 2015-06-15 15:19:55 -07:00
requirements-build.txt Split requirements-build.txt from requirements-dev.txt to support a leaner tox.ini 2015-09-01 16:27:44 -04:00
requirements-dev.txt Use py.test as the test runner 2015-09-01 16:27:44 -04:00
requirements.txt Run pre-commit on all files 2015-08-24 17:04:50 -04:00
setup.py Use py.test as the test runner 2015-09-01 16:27:44 -04:00
tox.ini Use py.test as the test runner 2015-09-01 16:27:44 -04:00

README.md

Docker Compose

(Previously known as Fig)

Compose is a tool for defining and running multi-container applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.

Compose is great for development environments, staging servers, and CI. We don't recommend that you use it in production yet.

Using Compose is basically a three-step process.

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

A docker-compose.yml looks like this:

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

Compose has commands for managing the whole lifecycle of your application:

  • Start, stop and rebuild services
  • View the status of running services
  • Stream the log output of running services
  • Run a one-off command on a service

Installation and documentation

Contributing

Build Status

Want to help build Compose? Check out our contributing documentation.

Releasing

Releases are built by maintainers, following an outline of the release process.