Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Go to file
Don Kjer 568f86eb18 Deprecating ResolveRepositoryName
Passing RepositoryInfo to ResolveAuthConfig, pullRepository, and pushRepository

Moving --registry-mirror configuration to registry config

Created resolve_repository job

Repo names with 'index.docker.io' or 'docker.io' are now synonymous with omitting an index name.

Adding test for RepositoryInfo

Adding tests for opts.StringSetOpts and registry.ValidateMirror

Fixing search term use of repoInfo

Adding integration tests for registry mirror configuration

Normalizing LookupImage image name to match LocalName parsing rules

Normalizing repository LocalName to avoid multiple references to an official image

Removing errorOut use in tests

Removing TODO comment

gofmt changes

golint comments cleanup.  renaming RegistryOptions => registry.Options, and RegistryServiceConfig => registry.ServiceConfig

Splitting out builtins.Registry and registry.NewService calls

Stray whitespace cleanup

Moving integration tests for Mirrors and InsecureRegistries into TestNewIndexInfo unit test

Factoring out ValidateRepositoryName from NewRepositoryInfo

Removing unused IndexServerURL

Allowing json marshaling of ServiceConfig.  Exposing ServiceConfig in /info

Switching to CamelCase for json marshaling

PR cleanup; removing 'Is' prefix from boolean members.  Removing unneeded json tags.

Removing non-cleanup related fix for 'localhost:[port]' in splitReposName

Merge fixes for gh9735

Fixing integration test

Reapplying #9754

Adding comment on config.IndexConfigs use from isSecureIndex

Remove unused error return value from isSecureIndex

Signed-off-by: Don Kjer <don.kjer@gmail.com>

Adding back comment in isSecureIndex

Signed-off-by: Don Kjer <don.kjer@gmail.com>
2015-01-08 20:14:58 +00:00
api Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
builder Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
builtins Don't hard code true for auth job 2014-10-30 19:41:55 -04:00
contrib Explicitly mention that '-P' maps to random ports 2015-01-06 17:01:10 +10:00
daemon Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
docker Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
dockerinit pkg/reexec: move reexec code to a new package 2014-10-30 14:48:30 +02:00
dockerversion Move even more stuff into dockerversion 2014-02-11 17:26:54 -07:00
docs Specify ENV variables are also used for CMD. 2015-01-07 10:07:44 -08:00
engine Remove unused Engine.Logf 2014-12-02 10:47:57 -08:00
events events filtering 2014-11-20 19:46:48 +00:00
graph Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
image Fix misuses of format based logging functions 2014-11-19 23:59:02 +02:00
integration Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
integration-cli Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
links Move per-container forward rules to DOCKER chain 2014-12-21 12:57:32 +10:00
nat add ability to publish range of ports 2015-01-02 23:21:26 +00:00
opts Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
pkg Merge pull request #8748 from duglin/Issue8330 2015-01-06 13:47:42 -08:00
project Merge pull request #9883 from tianon/irc-administration 2015-01-06 10:29:49 -08:00
registry Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
runconfig Merge pull request #9603 from hqhq/hq_add_memory_swap 2015-01-06 10:09:21 -08:00
trust Remove obsolete comments 2014-11-17 23:27:03 +09:00
utils Deprecating ResolveRepositoryName 2015-01-08 20:14:58 +00:00
vendor Update libcontainer to 0f397d4e145fb4053792d42b3424dd2143fb23ad 2014-12-26 21:03:48 -08:00
volumes Have .dockerignore support Dockerfile/.dockerignore 2015-01-06 10:57:48 -08:00
.dockerignore Add .dockerignore support 2014-06-26 22:49:08 +00:00
.drone.yml Add docker-py tests to drone. 2015-01-05 15:00:32 -08:00
.gitignore Add windows/(386,amd64) to cross platforms list 2014-11-14 18:20:54 -08:00
.mailmap Update AUTHORS file 2014-11-16 23:41:25 -08:00
AUTHORS Update AUTHORS file 2014-11-16 23:41:25 -08:00
CHANGELOG.md Bump to version 1.4.1 2014-12-15 15:57:00 -08:00
CONTRIBUTING.md Remove DCO small patch exception 2014-12-17 10:02:36 +10:00
Dockerfile Adjust Dockerfile style to be more consistent 2014-12-24 00:26:19 -07:00
LICENSE Update License year to range 2013-2015 2015-01-04 16:59:34 -08:00
MAINTAINERS add @tianon as maintainer of .dockerignore 2014-06-26 22:49:08 +00:00
Makefile Add docs Cloudfront cache invalidation 2014-12-30 12:58:56 +10:00
NOTICE Fixes 3497 2014-01-13 17:12:53 -08:00
README.md Revises link to point to Fig 2015-01-05 11:03:25 -08:00
VERSION Change version to 1.4.1-dev 2014-12-16 12:26:01 -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.

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.