tyler.durden/compose
1
0
Fork 0
mirror of https://github.com/docker/compose.git synced 2025-07-20 20:24:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix readme formatting

Browse Source
This commit is contained in:
Ben Firshman 2013-12-09 12:03:26 +00:00
parent 84ea31dc92
commit ed1918ef09
1 changed files with 59 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
README.md
View File

@ -4,19 +4,19 @@ Plum
Plum is tool for defining and running apps with Docker. It uses a simple, version-controllable YAML configuration file that looks something like this: Plum is tool for defining and running apps with Docker. It uses a simple, version-controllable YAML configuration file that looks something like this:
```yaml ```yaml
db: db:
image: orchardup/postgresql image: orchardup/postgresql
web: web:
build: web/ build: web/
link: db link: db
``` ```
Installing Installing
---------- ----------
```bash ```bash
$ sudo pip install plum $ sudo pip install plum
``` ```
Defining your app Defining your app
@ -27,24 +27,24 @@ Put a `plum.yml` in your app's directory. Each top-level key defines a "service"
The way to get started is to just give it an image name: The way to get started is to just give it an image name:
```yaml ```yaml
db: db:
image: orchardup/postgresql image: orchardup/postgresql
``` ```
Alternatively, you can give it the location of a directory with a Dockerfile (or a Git URL, as per the `docker build` command), and it'll automatically build the image for you: Alternatively, you can give it the location of a directory with a Dockerfile (or a Git URL, as per the `docker build` command), and it'll automatically build the image for you:
```yaml ```yaml
db: db:
build: /path/to/postgresql/build/directory build: /path/to/postgresql/build/directory
``` ```
You've now given Plum the minimal amount of configuration it needs to run: You've now given Plum the minimal amount of configuration it needs to run:
```bash ```bash
$ plum up $ plum up
Building db... done Building db... done
db is running at 127.0.0.1:45678 db is running at 127.0.0.1:45678
<...output from postgresql server...> <...output from postgresql server...>
``` ```
For each service you've defined, Plum will start a Docker container with the specified image, building or pulling it if necessary. You now have a PostgreSQL server running at `127.0.0.1:45678`. For each service you've defined, Plum will start a Docker container with the specified image, building or pulling it if necessary. You now have a PostgreSQL server running at `127.0.0.1:45678`.
@ -52,13 +52,13 @@ For each service you've defined, Plum will start a Docker container with the spe
By default, `plum up` will run until each container has shut down, and relay their output to the terminal. To run in the background instead, pass the `-d` flag: By default, `plum up` will run until each container has shut down, and relay their output to the terminal. To run in the background instead, pass the `-d` flag:
```bash ```bash
$ plum run -d $ plum run -d
Building db... done Building db... done
db is running at 127.0.0.1:45678 db is running at 127.0.0.1:45678
$ plum ps $ plum ps
SERVICE STATE PORT SERVICE STATE PORT
db up 45678 db up 45678
``` ```
@ -69,15 +69,15 @@ Some services may include your own code. To get that code into the container, AD
`plum.yml`: `plum.yml`:
```yaml ```yaml
web: web:
build: web/ build: web/
``` ```
`web/Dockerfile`: `web/Dockerfile`:
FROM orchardup/rails FROM orchardup/rails
ADD . /code ADD . /code
CMD: bundle exec rackup CMD: bundle exec rackup
### Communicating between containers ### Communicating between containers
@ -85,12 +85,12 @@ Some services may include your own code. To get that code into the container, AD
Your web app will probably need to talk to your database. You can use [Docker links] to enable containers to communicatecommunicate, pass in the right IP address and port via environment variables: Your web app will probably need to talk to your database. You can use [Docker links] to enable containers to communicatecommunicate, pass in the right IP address and port via environment variables:
```yaml ```yaml
db: db:
image: orchardup/postgresql image: orchardup/postgresql
web: web:
build: web/ build: web/
link: db link: db
``` ```
This will pass an environment variable called DB_PORT into the web container, whose value will look like `tcp://172.17.0.4:45678`. Your web app's code can then use that to connect to the database. This will pass an environment variable called DB_PORT into the web container, whose value will look like `tcp://172.17.0.4:45678`. Your web app's code can then use that to connect to the database.
@ -98,10 +98,10 @@ This will pass an environment variable called DB_PORT into the web container, wh
You can pass in multiple links, too: You can pass in multiple links, too:
```yaml ```yaml
link: link:
- db - db
- memcached - memcached
- redis - redis
``` ```
@ -113,21 +113,21 @@ In each case, the resulting environment variable will begin with the uppercased
You can pass extra configuration options to a container, much like with `docker run`: You can pass extra configuration options to a container, much like with `docker run`:
```yaml ```yaml
web: web:
build: web/ build: web/
-- override the default run command -- override the default run command
run: bundle exec thin -p 3000 run: bundle exec thin -p 3000
-- expose ports - can also be an array -- expose ports - can also be an array
ports: 3000 ports: 3000
-- map volumes - can also be an array -- map volumes - can also be an array
volumes: /tmp/cache volumes: /tmp/cache
-- add environment variables - can also be a dictionary -- add environment variables - can also be a dictionary
environment: environment:
- RACK_ENV=development - RACK_ENV=development
``` ```
@ -136,9 +136,11 @@ Running a one-off command
If you want to run a management command, use `plum run` to start a one-off container: If you want to run a management command, use `plum run` to start a one-off container:
$ plum run db createdb myapp_development ```bash
$ plum run web rake db:migrate $ plum run db createdb myapp_development
$ plum run web bash $ plum run web rake db:migrate
$ plum run web bash
```
Running more than one container for a service Running more than one container for a service
@ -146,14 +148,13 @@ Running more than one container for a service
You can set the number of containers to run for each service with `plum scale`: You can set the number of containers to run for each service with `plum scale`:
$ plum up -d ```bash
db is running at 127.0.0.1:45678 $ plum up -d
web is running at 127.0.0.1:45679 db is running at 127.0.0.1:45678
web is running at 127.0.0.1:45679
$ plum scale db=0,web=3
Stopped db (127.0.0.1:45678)
Started web (127.0.0.1:45680)
Started web (127.0.0.1:45681)
$ plum scale db=0,web=3
Stopped db (127.0.0.1:45678)
Started web (127.0.0.1:45680)
Started web (127.0.0.1:45681)
```