Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Go to file
Andy Rothfusz d0f4bc7cca Merge pull request #4223 from SvenDowideit/update-boot2docker-repo
we moved the boot2docker repo
2014-02-18 17:42:59 -08:00
api my attempt to disentagle repository and registry (Issue #1439) 2014-02-18 20:16:08 +10:00
archive archive: Fix the storing of setuid bits, etc 2014-02-18 09:53:30 +01:00
auth Do not ping registry from the cli 2014-02-05 16:49:43 -08:00
contrib Merge pull request #4010 from tianon/iceweasel 2014-02-14 21:38:40 +02:00
docker Merge pull request #4168 from crosbymichael/add-listenbuffer 2014-02-17 16:04:49 -08:00
dockerinit Move even more stuff into dockerversion 2014-02-11 17:26:54 -07:00
dockerversion Move even more stuff into dockerversion 2014-02-11 17:26:54 -07:00
docs we moved the repo 2014-02-19 11:35:58 +10:00
engine Fix engine tests on systems where temp directories are symlinked. 2014-02-15 14:39:51 -08:00
execdriver Cleanup some statements from exec driver work 2014-02-14 17:28:50 -08:00
graphdriver Properly close archives 2014-02-14 13:46:17 +01:00
hack Merge pull request #4205 from tianon/fix-dyntest 2014-02-18 11:50:16 -07:00
integration Merge pull request #4168 from crosbymichael/add-listenbuffer 2014-02-17 16:04:49 -08:00
links Move links to sub pkg 2014-02-14 18:18:16 -08:00
nat New package `nat`: utilities for manipulating the text description of network ports. 2014-02-11 16:51:01 -08:00
networkdriver Merge pull request #4153 from crosbymichael/move-proxy 2014-02-17 14:51:16 -08:00
pkg Merge pull request #4011 from crosbymichael/add-netlink-functions 2014-02-18 19:37:52 -05:00
registry Fix login prompt on push and pull because of error message 2014-02-03 11:38:34 -08:00
runconfig Move the canonical run configuration objects to a sub-package 2014-02-11 20:18:46 -08:00
sysinit Cleanup some statements from exec driver work 2014-02-14 17:28:50 -08:00
utils Merge pull request #4153 from crosbymichael/move-proxy 2014-02-17 14:51:16 -08:00
vendor Add vendored archive/tar that includes xattrs patch 2014-02-17 08:20:21 -07:00
.gitignore tell anyone that might want to ignore their editor choice's backup files that there is a better way - thanks @pnasrat 2013-11-27 13:19:06 +10:00
.mailmap Update .mailmap and AUTHORS 2014-02-04 13:40:56 -07:00
.travis.yml Update Travis to also compile the man page(s) now that they compile properly again 2014-01-20 11:29:24 -07:00
AUTHORS Update .mailmap and AUTHORS 2014-02-04 13:40:56 -07:00
CHANGELOG.md Bump to version 0.8.1 2014-02-18 12:36:05 -08:00
CONTRIBUTING.md Merge pull request #3817 from philips/CONTRIBUTING-is-just-a-dco 2014-02-17 12:28:05 -08:00
Dockerfile Remove stackbrew prefix on ubuntu images now that they're reasonably up-to-date and stable 2014-02-03 11:08:35 -07:00
FIXME Update fixme 2014-02-14 15:17:12 -08:00
LICENSE Docker is now licensed under the Apache 2.0 license 2013-02-18 09:56:20 -08:00
MAINTAINERS Make unclejack the official Vagrantfile maintainer 2014-01-30 11:51:25 -07:00
Makefile Quote volume path to allow spaces 2014-02-17 10:24:50 -08:00
NOTICE Fixes 3497 2014-01-13 17:12:53 -08:00
README.md Update README.md 2014-01-26 00:08:55 -07:00
VERSION Change version to v0.8.1 2014-02-18 16:01:04 -08:00
Vagrantfile improve the Vagrant VMs 2014-02-04 12:26:14 +02:00
buildfile.go Fix remote tar ADD behavior 2014-02-17 17:08:17 -08:00
commands_unit_test.go Move the canonical run configuration objects to a sub-package 2014-02-11 20:18:46 -08:00
config.go Fix bad rebase where bridgeiface was removed 2014-02-05 11:20:59 -08:00
container.go Merge pull request #4159 from crosbymichael/move-volumes 2014-02-17 16:43:20 -08:00
container_unit_test.go Move the canonical run configuration objects to a sub-package 2014-02-11 20:18:46 -08:00
graph.go Properly close archives 2014-02-14 13:46:17 +01:00
image.go Properly close archives 2014-02-14 13:46:17 +01:00
runtime.go Cleanup some statements from exec driver work 2014-02-14 17:28:50 -08:00
server.go update warning about local dns resolvers 2014-02-17 23:29:36 +02:00
server_unit_test.go Merge pull request #2609 from shykes/0.6.5-dm-plugin 2013-11-25 18:58:26 -08:00
sorter.go New package `nat`: utilities for manipulating the text description of network ports. 2014-02-11 16:51:01 -08:00
state.go Use UTC for time 2013-11-21 16:43:36 -08:00
tags.go Search for repo first before image id 2013-11-29 11:06:35 -08:00
tags_unit_test.go Document Darwin test failure in a FIXME 2014-02-15 14:40:07 -08:00
utils.go Drop EofReader 2014-02-14 13:46:21 +01:00
utils_test.go Add vendored archive/tar that includes xattrs patch 2014-02-17 08:20:21 -07:00
version.go Move even more stuff into dockerversion 2014-02-11 17:26:54 -07:00
volumes.go Move volumes out of container.go and into volumes.go 2014-02-14 17:15:40 -08:00

README.md

Docker: the Linux container engine

Docker is an open source project to pack, ship and run any application as a lightweight container

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 sandboxing 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.

Getting started

Docker can be installed on your local machine as well as servers - both bare metal and virtualized. It is available as a binary on most modern Linux systems, or as a VM on Windows, Mac and other systems.

We also offer an interactive tutorial for quickly learning the basics of using Docker.

For up-to-date install instructions and online tutorials, see the Getting Started page.

Usage examples

Docker can be used to run short-lived commands, long-running daemons (app servers, databases etc.), interactive shell sessions, etc.

You can find a list of real-world examples in the documentation.

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 here.

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

Brought to you courtesy of our legal counsel. For more context, please see the Notice document.

Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.
It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see http://www.bis.doc.gov