The Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Find a file
2013-08-20 19:35:30 -07:00
auth prevent crash when .dockercfg not readable 2013-08-14 10:26:18 +00:00
contrib Merge pull request #1538 from KSid/bash-completion-limit-containers 2013-08-14 16:16:25 -07:00
docker docker -v: show version and build information without making remote connections 2013-08-20 19:32:37 -07:00
docs Merge pull request #1590 from elmendalerenda/patch-3 2013-08-19 10:27:43 -07:00
hack Update release checklist. Still needs work. 2013-08-20 19:34:10 -07:00
library Add GitHub usernames to MAINTAINERS 2013-08-09 21:16:44 -04:00
packaging Revert "docker.upstart: avoid spawning a sh process" 2013-08-12 23:35:23 +00:00
registry registry: removing opaqueRequest 2013-08-16 19:33:59 +02:00
term Add GitHub usernames to MAINTAINERS 2013-08-09 21:16:44 -04:00
testing testing, issue #1542: Add docker dependencies coverage testing into docker-ci 2013-08-14 14:27:46 -07:00
utils hot fix display in parallel pull and go fmt 2013-08-15 11:42:40 +00:00
.gitignore gitignore all test files 2013-08-10 13:48:24 -04:00
.mailmap Update AUTHORS 2013-08-09 20:09:42 -04:00
api.go API, issue 1471: Allow users belonging to the docker group to use the docker client 2013-08-12 23:33:42 +00:00
api_params.go Add warning when net.ipv4.ip_forwarding = 0 2013-08-07 18:28:39 -04:00
api_test.go Add imagename to LogEvent tests 2013-08-14 23:43:43 +00:00
archive.go Fixed typos 2013-08-12 18:53:06 +01:00
archive_test.go Style fixes for fmt + err usage. 2013-07-04 14:33:17 -07:00
AUTHORS Merge pull request #1483 from titanous/update-authors 2013-08-10 21:16:34 -07:00
builder.go fix entrypoint without cmd 2013-08-05 09:07:03 -05:00
buildfile.go Add workdir support for the Buildfile 2013-08-18 20:30:19 +02:00
buildfile_test.go Forbid certain paths within docker build ADD 2013-08-07 16:05:30 +00:00
CHANGELOG.md Update changelog to include hostname commit 2013-08-13 17:36:24 +00:00
changes.go remove TrimLeft as it's go1.1 2013-06-03 17:25:51 +00:00
commands.go Move VERSION to a dedicated file to facilitate automated builds and releases 2013-08-20 19:32:37 -07:00
commands_test.go Add an option to set the working directory. 2013-08-18 19:34:01 +02:00
container.go Add an option to set the working directory. 2013-08-18 19:34:01 +02:00
container_test.go Merge pull request #1496 from xdissent/1351-volumes-from-before-volumes 2013-08-14 15:10:41 -07:00
CONTRIBUTING.md Improved wording of a maintainer's responsibilities 2013-05-28 22:33:48 -06:00
Dockerfile Protect the release.sh script against accidental use. Infer VERSION automatically. 2013-08-20 19:35:30 -07:00
FIXME Merge branch 'master' into simpler-build-upload 2013-06-19 18:48:19 -07:00
graph.go Fix Graph ByParent() to generate list of child images per parent image. 2013-08-11 00:37:16 -07:00
graph_test.go Add test case for Graph ByParent(). 2013-08-11 01:24:21 -07:00
image.go Merge pull request #1267 from sridatta/new-clean-init 2013-08-05 13:23:22 -07:00
LICENSE Docker is now licensed under the Apache 2.0 license 2013-02-18 09:56:20 -08:00
lxc_template.go Merge pull request #1478 from jpetazzo/929-insecure-flag 2013-08-14 13:55:18 -07:00
MAINTAINERS Add GitHub usernames to MAINTAINERS 2013-08-09 21:16:44 -04:00
make.sh Add a check to make sure that make.sh only runs within a container. 2013-08-20 19:35:30 -07:00
mount.go run auplink before unmounting aufs 2013-06-14 21:38:15 +03:00
mount_darwin.go Moved server and client logic into sub-packages docker/server and docker/client, respectively. The UI is not affected. 2013-02-13 17:10:00 -08:00
mount_linux.go go fmt 2013-02-26 17:26:46 -08:00
network.go Handle ip route showing mask-less IP addresses 2013-08-12 23:46:26 +00:00
network_proxy.go Always stop the opposite goroutine in network_proxy.go (closes #1213) 2013-07-17 01:05:11 -07:00
network_proxy_test.go Add support for UDP (closes #33) 2013-07-09 17:42:35 -07:00
network_test.go Make sure the routes IP are taken into consideration + add unit test for network overlap detection 2013-08-01 18:12:39 -07:00
NOTICE Update NOTICE 2013-06-12 15:50:30 -06:00
README.md Update readme with dependencies for building 2013-08-15 17:26:07 +00:00
release.sh Protect the release.sh script against accidental use. Infer VERSION automatically. 2013-08-20 19:35:30 -07:00
runtime.go runtime: correctly detect IPv4 forwarding 2013-08-11 11:52:16 +02:00
runtime_test.go Merge pull request #1290 from dotcloud/parallel_pull 2013-08-05 14:17:29 -07:00
server.go Merge pull request #1396 from calavera/985-ordered-api-images 2013-08-19 09:41:39 -07:00
server_test.go testing, issue #1431: Temporarely disable TestContainerTop from the testsuite 2013-08-16 14:47:39 -07:00
sorter.go Sort images by tag name when the creation date is the same. 2013-08-17 22:11:34 -07:00
sorter_test.go Sort images by tag name when the creation date is the same. 2013-08-17 22:11:34 -07:00
state.go Make sure container is not marked as ghost when it starts 2013-07-09 10:48:33 -07:00
sysinit.go Add an option to set the working directory. 2013-08-18 19:34:01 +02:00
tags.go Reverse priority of tag lookup in TagStore.GetImage 2013-07-12 23:56:36 +01:00
tags_test.go Simplify unit tests code with mkRuntime() 2013-07-11 17:59:25 -07:00
utils.go Add workdir support for the Buildfile 2013-08-18 20:30:19 +02:00
utils_test.go Merge branch 'master' into add_some_tests 2013-08-08 14:44:56 +00:00
Vagrantfile Fix indentation in Vagrantfile 2013-08-06 15:21:26 +02:00
VERSION Upgrade Dockerfile with new dependency 2013-08-20 19:35:30 -07:00
z_final_test.go Fixes #505 - Make sure all output is send on the network before closing 2013-07-24 15:48:51 -07:00

Docker: the Linux container engine

Docker is an open-source engine which automates the deployment of applications as highly portable, self-sufficient containers.

Docker containers are both hardware-agnostic and platform-agnostic. This means that they can run anywhere, from your laptop to the largest EC2 compute instance and everything in between - and they don't require that you use a particular language, framework or packaging system. That makes them great building blocks for deploying and scaling web apps, databases and backend services without depending on a particular stack or provider.

Docker is an open-source implementation of the deployment engine which powers dotCloud, a popular Platform-as-a-Service. It benefits directly from the experience accumulated over several years of large-scale operation and support of hundreds of thousands of applications and databases.

Docker L

Better than VMs

A common method for distributing applications and sandbox their execution is to use virtual machines, or VMs. Typical VM formats are VMWare's vmdk, Oracle Virtualbox's vdi, and Amazon EC2's ami. In theory these formats should allow every developer to automatically package their application into a "machine" for easy distribution and deployment. In practice, that almost never happens, for a few reasons:

  • Size: VMs are very large which makes them impractical to store and transfer.
  • Performance: running VMs consumes significant CPU and memory, which makes them impractical in many scenarios, for example local development of multi-tier applications, and large-scale deployment of cpu and memory-intensive applications on large numbers of machines.
  • Portability: competing VM environments don't play well with each other. Although conversion tools do exist, they are limited and add even more overhead.
  • Hardware-centric: VMs were designed with machine operators in mind, not software developers. As a result, they offer very limited tooling for what developers need most: building, testing and running their software. For example, VMs offer no facilities for application versioning, monitoring, configuration, logging or service discovery.

By contrast, Docker relies on a different sandboxing method known as containerization. Unlike traditional virtualization, containerization takes place at the kernel level. Most modern operating system kernels now support the primitives necessary for containerization, including Linux with openvz, vserver and more recently lxc, Solaris with zones and FreeBSD with Jails.

Docker builds on top of these low-level primitives to offer developers a portable format and runtime environment that solves all 4 problems. Docker containers are small (and their transfer can be optimized with layers), they have basically zero memory and cpu overhead, they are completely portable and are designed from the ground up with an application-centric design.

The best part: because docker operates at the OS level, it can still be run inside a VM!

Plays well with others

Docker does not require that you buy into a particular programming language, framework, packaging system or configuration language.

Is your application a Unix process? Does it use files, tcp connections, environment variables, standard Unix streams and command-line arguments as inputs and outputs? Then docker can run it.

Can your application's build be expressed as a sequence of such commands? Then docker can build it.

Escape dependency hell

A common problem for developers is the difficulty of managing all their application's dependencies in a simple and automated way.

This is usually difficult for several reasons:

  • Cross-platform dependencies. Modern applications often depend on a combination of system libraries and binaries, language-specific packages, framework-specific modules, internal components developed for another project, etc. These dependencies live in different "worlds" and require different tools - these tools typically don't work well with each other, requiring awkward custom integrations.

  • Conflicting dependencies. Different applications may depend on different versions of the same dependency. Packaging tools handle these situations with various degrees of ease - but they all handle them in different and incompatible ways, which again forces the developer to do extra work.

  • Custom dependencies. A developer may need to prepare a custom version of their application's dependency. Some packaging systems can handle custom versions of a dependency, others can't - and all of them handle it differently.

Docker solves dependency hell by giving the developer a simple way to express all their application's dependencies in one place, and streamline the process of assembling them. If this makes you think of XKCD 927, don't worry. Docker doesn't replace your favorite packaging systems. It simply orchestrates their use in a simple and repeatable way. How does it do that? With layers.

Docker defines a build as running a sequence of Unix commands, one after the other, in the same container. Build commands modify the contents of the container (usually by installing new files on the filesystem), the next command modifies it some more, etc. Since each build command inherits the result of the previous commands, the order in which the commands are executed expresses dependencies.

Here's a typical Docker build process:

from ubuntu:12.10
run apt-get update
run DEBIAN_FRONTEND=noninteractive apt-get install -q -y python
run DEBIAN_FRONTEND=noninteractive apt-get install -q -y python-pip
run pip install django
run DEBIAN_FRONTEND=noninteractive apt-get install -q -y curl
run curl -L https://github.com/shykes/helloflask/archive/master.tar.gz | tar -xzv
run cd helloflask-master && pip install -r requirements.txt

Note that Docker doesn't care how dependencies are built - as long as they can be built by running a Unix command in a container.

Install instructions

Quick install on Ubuntu 12.04 and 12.10

curl https://get.docker.io | sudo sh -x

Binary installs

Docker supports the following binary installation methods. Note that some methods are community contributions and not yet officially supported.

Installing from source

  1. Install Dependencies

  2. Checkout the source code

    git clone http://github.com/dotcloud/docker
    
  3. Build the docker binary

    cd docker
    make VERBOSE=1
    sudo cp ./bin/docker /usr/local/bin/docker
    

Usage examples

First run the docker daemon

All the examples assume your machine is running the docker daemon. To run the docker daemon in the background, simply type:

# On a production system you want this running in an init script
sudo docker -d &

Now you can run docker in client mode: all commands will be forwarded to the docker daemon, so the client can run from any account.

# Now you can run docker commands from any account.
docker help

Throwaway shell in a base Ubuntu image

docker pull ubuntu:12.10

# Run an interactive shell, allocate a tty, attach stdin and stdout
# To detach the tty without exiting the shell, use the escape sequence Ctrl-p + Ctrl-q
docker run -i -t ubuntu:12.10 /bin/bash

Starting a long-running worker process

# Start a very useful long-running process
JOB=$(docker run -d ubuntu /bin/sh -c "while true; do echo Hello world; sleep 1; done")

# Collect the output of the job so far
docker logs $JOB

# Kill the job
docker kill $JOB

Running an irc bouncer

BOUNCER_ID=$(docker run -d -p 6667 -u irc shykes/znc zncrun $USER $PASSWORD)
echo "Configure your irc client to connect to port $(docker port $BOUNCER_ID 6667) of this machine"

Running Redis

REDIS_ID=$(docker run -d -p 6379 shykes/redis redis-server)
echo "Configure your redis client to connect to port $(docker port $REDIS_ID 6379) of this machine"

Share your own image!

CONTAINER=$(docker run -d ubuntu:12.10 apt-get install -y curl)
docker commit -m "Installed curl" $CONTAINER $USER/betterbase
docker push $USER/betterbase

A list of publicly available images is available here.

Expose a service on a TCP port

# Expose port 4444 of this container, and tell netcat to listen on it
JOB=$(docker run -d -p 4444 base /bin/nc -l -p 4444)

# Which public port is NATed to my container?
PORT=$(docker port $JOB 4444)

# Connect to the public port via the host's public address
# Please note that because of how routing works connecting to localhost or 127.0.0.1 $PORT will not work.
# Replace *eth0* according to your local interface name.
IP=$(ip -o -4 addr list eth0 | perl -n -e 'if (m{inet\s([\d\.]+)\/\d+\s}xms) { print $1 }')
echo hello world | nc $IP $PORT

# Verify that the network connection worked
echo "Daemon received: $(docker logs $JOB)"

Under the hood

Under the hood, Docker is built on the following components:

  • The cgroup and namespacing capabilities of the Linux kernel;
  • AUFS, a powerful union filesystem with copy-on-write capabilities;
  • The Go programming language;
  • lxc, a set of convenience scripts to simplify the creation of Linux containers.

Contributing to Docker

Want to hack on Docker? Awesome! There are instructions to get you started on the website: http://docs.docker.io/en/latest/contributing/contributing/

They are probably not perfect, please let us know if anything feels wrong or incomplete.

Note

We also keep the documentation in this repository. The website documentation is generated using Sphinx using these sources. Please find it under docs/sources/ and read more about it https://github.com/dotcloud/docker/tree/master/docs/README.md

Please feel free to fix / update the documentation and send us pull requests. More tutorials are also welcome.

Setting up a dev environment

Instructions that have been verified to work on Ubuntu 12.10,

sudo apt-get -y install lxc curl xz-utils golang git

export GOPATH=~/go/
export PATH=$GOPATH/bin:$PATH

mkdir -p $GOPATH/src/github.com/dotcloud
cd $GOPATH/src/github.com/dotcloud
git clone https://github.com/dotcloud/docker.git
cd docker

go get -v github.com/dotcloud/docker/...
go install -v github.com/dotcloud/docker/...

Then run the docker daemon,

sudo $GOPATH/bin/docker -d

Run the go install command (above) to recompile docker.

What is a Standard Container?

Docker defines a unit of software delivery called a Standard Container. The goal of a Standard Container is to encapsulate a software component and all its dependencies in a format that is self-describing and portable, so that any compliant runtime can run it without extra dependencies, regardless of the underlying machine and the contents of the container.

The spec for Standard Containers is currently a work in progress, but it is very straightforward. It mostly defines 1) an image format, 2) a set of standard operations, and 3) an execution environment.

A great analogy for this is the shipping container. Just like how Standard Containers are a fundamental unit of software delivery, shipping containers are a fundamental unit of physical delivery.

1. STANDARD OPERATIONS

Just like shipping containers, Standard Containers define a set of STANDARD OPERATIONS. Shipping containers can be lifted, stacked, locked, loaded, unloaded and labelled. Similarly, Standard Containers can be started, stopped, copied, snapshotted, downloaded, uploaded and tagged.

2. CONTENT-AGNOSTIC

Just like shipping containers, Standard Containers are CONTENT-AGNOSTIC: all standard operations have the same effect regardless of the contents. A shipping container will be stacked in exactly the same way whether it contains Vietnamese powder coffee or spare Maserati parts. Similarly, Standard Containers are started or uploaded in the same way whether they contain a postgres database, a php application with its dependencies and application server, or Java build artifacts.

3. INFRASTRUCTURE-AGNOSTIC

Both types of containers are INFRASTRUCTURE-AGNOSTIC: they can be transported to thousands of facilities around the world, and manipulated by a wide variety of equipment. A shipping container can be packed in a factory in Ukraine, transported by truck to the nearest routing center, stacked onto a train, loaded into a German boat by an Australian-built crane, stored in a warehouse at a US facility, etc. Similarly, a standard container can be bundled on my laptop, uploaded to S3, downloaded, run and snapshotted by a build server at Equinix in Virginia, uploaded to 10 staging servers in a home-made Openstack cluster, then sent to 30 production instances across 3 EC2 regions.

4. DESIGNED FOR AUTOMATION

Because they offer the same standard operations regardless of content and infrastructure, Standard Containers, just like their physical counterparts, are extremely well-suited for automation. In fact, you could say automation is their secret weapon.

Many things that once required time-consuming and error-prone human effort can now be programmed. Before shipping containers, a bag of powder coffee was hauled, dragged, dropped, rolled and stacked by 10 different people in 10 different locations by the time it reached its destination. 1 out of 50 disappeared. 1 out of 20 was damaged. The process was slow, inefficient and cost a fortune - and was entirely different depending on the facility and the type of goods.

Similarly, before Standard Containers, by the time a software component ran in production, it had been individually built, configured, bundled, documented, patched, vendored, templated, tweaked and instrumented by 10 different people on 10 different computers. Builds failed, libraries conflicted, mirrors crashed, post-it notes were lost, logs were misplaced, cluster updates were half-broken. The process was slow, inefficient and cost a fortune - and was entirely different depending on the language and infrastructure provider.

5. INDUSTRIAL-GRADE DELIVERY

There are 17 million shipping containers in existence, packed with every physical good imaginable. Every single one of them can be loaded onto the same boats, by the same cranes, in the same facilities, and sent anywhere in the World with incredible efficiency. It is embarrassing to think that a 30 ton shipment of coffee can safely travel half-way across the World in less time than it takes a software team to deliver its code from one datacenter to another sitting 10 miles away.

With Standard Containers we can put an end to that embarrassment, by making INDUSTRIAL-GRADE DELIVERY of software a reality.

Transfers of Docker shall be in accordance with applicable export controls of any country and all other applicable legal requirements. Docker shall not be distributed or downloaded to or in Cuba, Iran, North Korea, Sudan or Syria and shall not be distributed or downloaded to any person on the Denied Persons List administered by the U.S. Department of Commerce.