Docker - the open-source application container engine
Перейти к файлу
Jessie Frazelle 8e107a9321 Merge pull request #11121 from shishir-a412ed/docker_help_issue
Fix: docker -d -h start daemon instead of showing help menu
2015-03-02 15:40:27 -08:00
api Merge pull request #10971 from Microsoft/10662-api_server_factor_out_windows 2015-03-02 12:40:20 -08:00
builder pass --change changes to the import job 2015-02-24 13:01:36 -05:00
builtins Removing -X flag option and autogenerated code to create Dockerversion.go functionality 2015-02-20 05:40:12 +00:00
contrib Merge pull request #10936 from vincentbernat/fix/zsh-completion-update-3 2015-02-23 16:01:59 -08:00
daemon Merge pull request #11106 from MabinGo/fix_log_info 2015-03-02 13:55:43 -08:00
docker Fix: docker -d -h start daemon instead of showing help menu 2015-03-02 17:01:56 -05:00
dockerinit pkg/reexec: move reexec code to a new package 2014-10-30 14:48:30 +02:00
docs Merge pull request #11060 from dmitrygusev/docs-improvements 2015-03-02 06:46:17 -08:00
engine moving random.go from utils 2015-02-26 18:31:18 +00:00
events events filtering 2014-11-20 19:46:48 +00:00
graph pass --change changes to the import job 2015-02-24 13:01:36 -05:00
image when the file that was opened has been read into buffer, the file should be close. 2015-02-27 19:09:17 +08:00
integration instantiate the builder job in commit integration tests 2015-02-24 13:01:35 -05:00
integration-cli Merge pull request #11005 from ahmetalpbalkan/win-cli/RegistryV2-skip 2015-03-02 12:41:21 -08:00
links Env Variables created for each of the ports in addition to env variables for port ranges, regression from #1834 2015-01-15 19:16:31 +00:00
nat nat: enable upper case proto 2015-02-06 14:07:17 +08:00
opts Add validate the input mac address on docker run command 2015-02-27 07:27:12 -08:00
pkg Merge pull request #11002 from ahmetalpbalkan/win-cli/dockerfile-path-fix 2015-02-27 11:57:19 -08:00
project Merge pull request #10957 from tianon/cleanup-autogen 2015-02-24 13:25:46 -08:00
registry Rename package timeout to timeoutconn. 2015-02-25 20:52:37 +01:00
runconfig Add validate the input mac address on docker run command 2015-02-27 07:27:12 -08:00
trust Remove obsolete comments 2014-11-17 23:27:03 +09:00
utils Merge pull request #11017 from brahmaroutu/random_10962 2015-02-26 21:35:42 -05:00
vendor Update libcontainer to 2d3b5af7486f1a4e80a5ed91859d309b4eebf80c 2015-01-26 14:00:44 -08:00
volumes Removing dependencies from pkg into Docker internal code 2015-02-23 18:43:10 +00:00
.dockerignore Add .dockerignore support 2014-06-26 22:49:08 +00:00
.gitignore Add support for an optional ".bashrc" file 2015-03-02 10:33:26 -07:00
.mailmap Update AUTHORS file and .mailmap 2015-01-15 19:56:41 -08:00
AUTHORS Update AUTHORS file and .mailmap 2015-01-15 19:56:41 -08:00
CHANGELOG.md Bump to version v1.5.0 2015-02-10 10:52:36 -08:00
CONTRIBUTING.md CONTRIBUTING.md: punctuation fixes 2015-02-24 08:21:49 -08:00
Dockerfile Add support for an optional ".bashrc" file 2015-03-02 10:33:26 -07:00
LICENSE Update License year to range 2013-2015 2015-01-04 16:59:34 -08:00
MAINTAINERS Re-order maintainers 2015-02-24 17:49:03 +01:00
Makefile Don't require Docker 1.5.0 for docker build -f docs/Dockerfile 2015-02-26 11:41:39 +10:00
NOTICE Update copyright year in NOTICE 2015-02-22 20:43:51 +01:00
README.md Smaller image 2015-02-26 08:48:58 -08:00
VERSION Bump to version v1.5.0 2015-02-10 10:52:36 -08:00
hack Move 'hack' to the less confusing 'project' 2014-11-09 21:50:28 +00: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 they can run anywhere, from your laptop to the largest EC2 compute instance and everything in between - and they don't require you to 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 began as 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

Security Disclosure

Security is very important to us. If you have any issue regarding security, please disclose the information responsibly by sending an email to security@docker.com and not by creating a github issue.

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

Perhaps best of all, because Docker operates at the OS level, it can still be run inside a VM!

Plays well with others

Docker does not require you to 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 the problem of dependency hell by giving the developer a simple way to express all their application's dependencies in one place, while streamlining 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.04
RUN apt-get update && apt-get install -y python python-pip curl
RUN curl -sSL 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, see the Docs.

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:

Contributing to Docker

GoDoc Jenkins Build Status

Want to hack on Docker? Awesome! We have instructions to help you get started. If you'd like to contribute to the documentation, please take a look at this README.md.

These instructions are probably not perfect, please let us know if anything feels wrong or incomplete. Better yet, submit a PR and improve them yourself.

Want to run Docker from a master build? You can download master builds at master.dockerproject.com. They are updated with each commit merged into the master branch.

Don't know how to use that super cool new feature in the master build? Check out the master docs at docs.master.dockerproject.com.

How the project is run

Docker is a very, very active project. If you want to learn more about how it is run, or want to get more involved, the best place to start is the project directory.

We are always open to suggestions on process improvements, and are always looking for more maintainers.

Brought to you courtesy of our legal counsel. For more context, please see the "NOTICE" document in this repo.

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

Licensing

Docker is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Other Docker Related Projects

There are a number of projects under development that are based on Docker's core technology. These projects expand the tooling built around the Docker platform to broaden its application and utility.

If you know of another project underway that should be listed here, please help us keep this list up-to-date by submitting a PR.