770e78fdce | ||
---|---|---|
fig | ||
script | ||
tests | ||
.gitignore | ||
.travis.yml | ||
CHANGES.md | ||
LICENSE | ||
MANIFEST.in | ||
README.md | ||
requirements-dev.txt | ||
requirements.txt | ||
setup.py |
README.md
Fig
Punctual, lightweight development environments using Docker.
Fig is a tool for defining and running isolated application environments. You define the services which comprise your app in a simple, version-controllable YAML configuration file that looks like this:
web:
build: .
links:
- db
ports:
- 8000:8000
db:
image: orchardup/postgresql
Then type fig up
, and Fig will start and run your entire app.
There are commands to:
- start, stop and rebuild services
- view the status of running services
- tail running services' log output
- run a one-off command on a service
Installing
$ sudo pip install fig
Defining your app
Put a fig.yml
in your app's directory. Each top-level key defines a service, such as a web app, database or cache. For each service, Fig will start a Docker container, so at minimum it needs to know what image to use.
The simplest way to get started is to just give it an image name:
db:
image: orchardup/postgresql
You've now given Fig the minimal amount of configuration it needs to run:
$ fig up
Pulling image orchardup/postgresql...
Starting myapp_db_1...
myapp_db_1 is running at 127.0.0.1:45678
<...output from postgresql server...>
For each service you've defined, Fig 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
.
By default, fig 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:
$ fig up -d
Starting myapp_db_1... done
myapp_db_1 is running at 127.0.0.1:45678
$ fig ps
Name State Ports
------------------------------------
myapp_db_1 Up 5432->45678/tcp
Building services
Fig can automatically build images for you if your service specifies a directory with a Dockerfile
in it (or a Git URL, as per the docker build
command).
This example will build an image with app.py
inside it:
app.py
print "Hello world!"
fig.yml
web:
build: .
Dockerfile
FROM ubuntu:12.04
RUN apt-get install python
ADD . /opt
WORKDIR /opt
CMD python app.py
Getting your code in
If you want to work on an application being run by Fig, you probably don't want to have to rebuild your image every time you make a change. To solve this, you can share the directory with the container using a volume so the changes are reflected immediately:
web:
build: .
volumes:
- .:/opt
Communicating between containers
Your web app will probably need to talk to your database. You can use Docker links to enable containers to communicate, pass in the right IP address and port via environment variables:
db:
image: orchardup/postgresql
web:
build: .
links:
- db
This will pass an environment variable called MYAPP_DB_1_PORT
into the web container, whose value will look like tcp://172.17.0.4:45678
. Your web app's code can use that to connect to the database. To see all of the environment variables available, run env
inside a container:
$ fig up -d db
$ fig run web env
Container configuration options
You can pass extra configuration options to a container, much like with docker run
:
web:
build: .
-- override the default command
command: bundle exec thin -p 3000
-- expose ports, optionally specifying both host and container ports (a random host port will be chosen otherwise)
ports:
- 3000
- 8000:8000
-- map volumes
volumes:
- cache/:/tmp/cache
-- add environment variables
environment:
RACK_ENV: development
Running a one-off command
If you want to run a management command, use fig run
to start a one-off container:
$ fig run db createdb myapp_development
$ fig run web rake db:migrate
$ fig run web bash