diff --git a/README.md b/README.md index c3c5d48053..4fc7778456 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,11 @@ Docker is a great building block for automating distributed systems: large-scale * *Heterogeneous payloads*: any combination of binaries, libraries, configuration files, scripts, virtualenvs, jars, gems, tarballs, you name it. No more juggling between domain-specific tools. Docker can deploy and run them all. + * *Any server*: docker can run on any x64 machine with a modern linux kernel - whether it's a laptop, a bare metal server or a VM. This makes it perfect for multi-cloud deployments. + * *Isolation*: docker isolates processes from each other and from the underlying host, using lightweight containers. + * *Repeatability*: because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run. @@ -17,14 +20,21 @@ Notable features ----------------- * Filesystem isolation: each process container runs in a completely separate root filesystem. + * Resource isolation: system resources like cpu and memory can be allocated differently to each process container, using cgroups. + * Network isolation: each process container runs in its own network namespace, with a virtual interface and IP address of its own. + * Copy-on-write: root filesystems are created using copy-on-write, which makes deployment extremeley fast, memory-cheap and disk-cheap. + * Logging: the standard streams (stdout/stderr/stdin) of each process container are collected and logged for real-time or batch retrieval. + * Change management: changes to a container's filesystem can be committed into a new image and re-used to create more containers. No templating or manual configuration required. + * Interactive shell: docker can allocate a pseudo-tty and attach to the standard input of any container, for example to run a throwaway interactive shell. + Under the hood -------------- @@ -32,8 +42,11 @@ Under the hood, Docker is built on the following components: * The [cgroup](http://blog.dotcloud.com/kernel-secrets-from-the-paas-garage-part-24-c) and [namespacing](http://blog.dotcloud.com/under-the-hood-linux-kernels-on-dotcloud-part) capabilities of the Linux kernel; + * [AUFS](http://aufs.sourceforge.net/aufs.html), a powerful union filesystem with copy-on-write capabilities; + * The [Go](http://golang.org) programming language; + * [lxc](http://lxc.sourceforge.net/), a set of convenience scripts to simplify the creation of linux containers. @@ -63,6 +76,7 @@ Installing on Ubuntu 12.04 and 12.10 ```bash cd docker-master + sudo ./docker pull base sudo ./docker run -i -t base /bin/bash ``` @@ -123,6 +137,17 @@ docker ps ``` +Share your own image! +--------------------- + +```bash +docker pull base +CONTAINER=$(docker run -d base apt-get install -y curl) +docker commit -m "Installed curl" $CONTAINER $USER/betterbase +docker push $USER/betterbase +``` + + Expose a service on a TCP port ------------------------------ @@ -147,6 +172,7 @@ Want to hack on Docker? Awesome! There are instructions to get you started on th They are probably not perfect, please let us know if anything feels wrong or incomplete. +### Pull requests are always welcome Note ---- @@ -156,5 +182,140 @@ Please find it under docs/sources/ and read more about it https://github.com/dot Please feel free to fix / update the documentation and send us pull requests. More tutorials are also welcome. +### Discuss your design on the mailing list + +We recommend discussing your plans [on the mailing list](https://groups.google.com/forum/?fromgroups#!forum/docker-club) before starting to code - especially for more ambitious contributions. This gives other contributors a chance to point +you in the right direction, give feedback on your design, and maybe point out if someone else is working on the same thing. + +### Create issues... + +Any significant improvement should be documented as [a github issue](https://github.com/dotcloud/docker/issues) before anybody starts working on it. + +### ...but check for existing issues first! + +Please take a moment to check that an issue doesn't already exist documenting your bug report or improvement proposal. +If it does, it never hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common problems and requests. + + +### Write tests + +Golang has a great testing suite built in: use it! Take a look at existing tests for inspiration. + + + +Setting up a dev environment +---------------------------- + +Instructions that have been verified to work on Ubuntu 12.10, + +```bash +sudo apt-get -y install lxc wget bsdtar curl 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 git@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, + +```bash +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 Standard Containers are a fundamental unit of software delivery, shipping containers (http://bricks.argz.com/ins/7823-1/12) 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 counterpart, 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 on 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. + + + + +Standard Container Specification +-------------------------------- + +(TODO) + +### Image format + + +### Standard operations + +* Copy +* Run +* Stop +* Wait +* Commit +* Attach standard streams +* List filesystem changes +* ... + +### Execution environment + +#### Root filesystem + +#### Environment variables + +#### Process arguments + +#### Networking + +#### Process namespacing + +#### Resource limits + +#### Process monitoring + +#### Logging + +#### Signals + +#### Pseudo-terminal allocation + +#### Security diff --git a/Vagrantfile b/Vagrantfile index db52a1e1b4..51614c5c20 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -31,12 +31,12 @@ def v10(config) # computers to access the VM, whereas host only networking does not. # config.vm.forward_port 80, 8080 + # Ensure puppet is installed on the instance + config.vm.provision :shell, :inline => "apt-get -qq update; apt-get install -y puppet" + # Share an additional folder to the guest VM. The first argument is # an identifier, the second is the path on the guest to mount the # folder, and the third is the path on the host to the actual folder. - if not File.exist? File.expand_path '~/docker' - Dir.mkdir(File.expand_path '~/docker') - end config.vm.share_folder "v-data", "~/docker", "~/docker" # Enable provisioning with Puppet stand alone. Puppet manifests @@ -123,6 +123,16 @@ end aws.ssh_username = "ubuntu" aws.instance_type = "t1.micro" end + config.vm.provider :rackspace do |rs| + config.vm.box = "dummy" + config.vm.box_url = "https://github.com/mitchellh/vagrant-rackspace/raw/master/dummy.box" + config.ssh.private_key_path = ENV["RS_PRIVATE_KEY"] + rs.username = ENV["RS_USERNAME"] + rs.api_key = ENV["RS_API_KEY"] + rs.public_key_path = ENV["RS_PUBLIC_KEY"] + rs.flavor = /512MB/ + rs.image = /Ubuntu/ + end config.vm.provider :virtualbox do |vb| config.vm.box = "quantal64_3.5.0-25" config.vm.box_url = "http://get.docker.io/vbox/ubuntu/12.10/quantal64_3.5.0-25.box" diff --git a/commands.go b/commands.go index 1f2c3650d7..3806323879 100644 --- a/commands.go +++ b/commands.go @@ -9,7 +9,6 @@ import ( "github.com/dotcloud/docker/rcli" "io" "log" - "math/rand" "net/http" "net/url" "runtime" @@ -826,10 +825,22 @@ func (srv *Server) CmdRun(stdin io.ReadCloser, stdout io.Writer, args ...string) fmt.Fprintln(stdout, "Error: Command not specified") return fmt.Errorf("Command not specified") } + // Create new container container, err := srv.runtime.Create(config) if err != nil { - return errors.New("Error creating container: " + err.Error()) + // If container not found, try to pull it + if srv.runtime.graph.IsNotExist(err) { + fmt.Fprintf(stdout, "Image %s not found, trying to pull it from registry.\n", config.Image) + if err = srv.CmdPull(stdin, stdout, config.Image); err != nil { + return err + } + if container, err = srv.runtime.Create(config); err != nil { + return err + } + } else { + return err + } } if config.OpenStdin { cmd_stdin, err := container.StdinPipe() @@ -884,7 +895,6 @@ func (srv *Server) CmdRun(stdin io.ReadCloser, stdout io.Writer, args ...string) } func NewServer() (*Server, error) { - rand.Seed(time.Now().UTC().UnixNano()) if runtime.GOARCH != "amd64" { log.Fatalf("The docker runtime currently only supports amd64 (not %s). This will change in the future. Aborting.", runtime.GOARCH) } diff --git a/container.go b/container.go index 785b351c22..77d16c786b 100644 --- a/container.go +++ b/container.go @@ -258,8 +258,9 @@ func (container *Container) Start() error { var err error if container.Config.Tty { - container.cmd.Env = append(container.Config.Env, - "TERM=xterm", + container.cmd.Env = append( + []string{"TERM=xterm"}, + container.cmd.Env..., ) err = container.startPty() } else { diff --git a/container_test.go b/container_test.go index 3f9b02ab58..fb7cdc2efd 100644 --- a/container_test.go +++ b/container_test.go @@ -7,12 +7,38 @@ import ( "io/ioutil" "math/rand" "os" + "regexp" "sort" "strings" "testing" "time" ) +func TestIdFormat(t *testing.T) { + runtime, err := newTestRuntime() + if err != nil { + t.Fatal(err) + } + defer nuke(runtime) + container1, err := runtime.Create( + &Config{ + Image: GetTestImage(runtime).Id, + Cmd: []string{"/bin/sh", "-c", "echo hello world"}, + Memory: 33554432, + }, + ) + if err != nil { + t.Fatal(err) + } + match, err := regexp.Match("^[0-9a-f]{64}$", []byte(container1.Id)) + if err != nil { + t.Fatal(err) + } + if !match { + t.Fatalf("Invalid container ID: %s", container1.Id) + } +} + func TestCommitRun(t *testing.T) { runtime, err := newTestRuntime() if err != nil { diff --git a/docs/Makefile b/docs/Makefile index f58854dcdb..55e4ad6eb5 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -62,6 +62,11 @@ push: @cd _build/html/ ; \ dotcloud push +github-deploy: docs + rm -fr github-deploy + git clone ssh://git@github.com/dotcloud/docker github-deploy + cd github-deploy && git checkout -f gh-pages && git rm -r * && rsync -avH ../_build/html/ ./ && touch .nojekyll && echo "docker.io" > CNAME && git add * && git commit -m "Updating docs" + $(VERSIONS): @echo "Hello world" diff --git a/docs/sources/documentation/commandline/basecommands.rst b/docs/sources/documentation/commandline/basecommands.rst index 7aa8973657..180ad413a8 100644 --- a/docs/sources/documentation/commandline/basecommands.rst +++ b/docs/sources/documentation/commandline/basecommands.rst @@ -1,4 +1,4 @@ -:title: docker documentation +:title: Base commands :description: Common usage and commands :keywords: Examples, Usage @@ -61,3 +61,7 @@ Expose a service on a TCP port # Verify that the network connection worked echo "Daemon received: $(docker logs $JOB)" + +Continue to the complete `Command Line Interface`_ + +.. _Command Line Interface: ../commandline/cli.html diff --git a/docs/sources/documentation/contributing/devenvironment.rst b/docs/sources/documentation/contributing/devenvironment.rst index cffd9d2a34..e16b317d32 100644 --- a/docs/sources/documentation/contributing/devenvironment.rst +++ b/docs/sources/documentation/contributing/devenvironment.rst @@ -1,4 +1,4 @@ -:title: Contributing to Docker +:title: Setting up a dev environment :description: Guides on how to contribute to docker :keywords: Docker, documentation, developers, contributing, dev environment diff --git a/docs/sources/documentation/examples/hello_world.rst b/docs/sources/documentation/examples/hello_world.rst index b6c07a2b91..910bc1f366 100644 --- a/docs/sources/documentation/examples/hello_world.rst +++ b/docs/sources/documentation/examples/hello_world.rst @@ -1,4 +1,4 @@ -:title: Docker: Hello world example +:title: Hello world example :description: A simple hello world example with Docker :keywords: docker, example, hello world diff --git a/docs/sources/documentation/examples/hello_world_daemon.rst b/docs/sources/documentation/examples/hello_world_daemon.rst index 8abe0e735a..e92a67cde6 100644 --- a/docs/sources/documentation/examples/hello_world_daemon.rst +++ b/docs/sources/documentation/examples/hello_world_daemon.rst @@ -1,4 +1,4 @@ -:title: Docker: Hello world daemon example +:title: Hello world daemon example :description: A simple hello world daemon example with Docker :keywords: docker, example, hello world, daemon diff --git a/docs/sources/documentation/examples/python_web_app.rst b/docs/sources/documentation/examples/python_web_app.rst index 9d988b5160..5b0ac30b63 100644 --- a/docs/sources/documentation/examples/python_web_app.rst +++ b/docs/sources/documentation/examples/python_web_app.rst @@ -1,4 +1,4 @@ -:title: Docker: Python Web app example +:title: Python Web app example :description: Building your own python web app using docker :keywords: docker, example, python, web app @@ -6,7 +6,7 @@ Building a python web app ========================= -The goal of this example is to show you how you can author your own docker images using a parent image, making changes to it, and then saving the results as a new image. We will do that by making a simple hello flask web application image. +The goal of this example is to show you how you can author your own docker images using a parent image, making changes to it, and then saving the results as a new image. We will do that by making a simple hello flask web application image. **Steps:** @@ -64,3 +64,7 @@ See the example in action
+ +Continue to the `base commands`_ + +.. _base commands: ../commandline/basecommands.html diff --git a/docs/sources/documentation/faq.rst b/docs/sources/documentation/faq.rst index 7b2b54de5f..03d584879d 100644 --- a/docs/sources/documentation/faq.rst +++ b/docs/sources/documentation/faq.rst @@ -3,27 +3,45 @@ FAQ Most frequently asked questions. ---------------------------------------------- +-------------------------------- -1. How much does Docker cost? +**1. How much does Docker cost?** Docker is 100% free, it is open source, so you can use it without paying. -2. What open source license are you using? +**2. What open source license are you using?** We are using the Apache License Version 2.0, see it here: https://github.com/dotcloud/docker/blob/master/LICENSE -3. Does Docker run on Mac OS X or Windows? +**3. Does Docker run on Mac OS X or Windows?** -Not at this time, Docker currently only runs on Linux, but you can use VirtualBox to run Docker in a virtual machine on your box, and get the best of both worlds. Check out the getting started guides for help on setting up your machine. +Not at this time, Docker currently only runs on Linux, but you can use VirtualBox to run Docker in a virtual machine on your box, and get the best of both worlds. Check out the MacOSX_ and Windows_ intallation guides. -4. How do containers compare to virtual machines? +**4. How do containers compare to virtual machines?** -Containers are more light weight and can start in less then a second, and are great for lots of different tasks, but they aren't as full featured as virtual machines. +They are complementary. VMs are best used to allocate chunks of hardware resources. Containers operate at the process level, which makes them very lightweight and perfect as a unit of software delivery. -5. Can I help by adding some questions and answers? +**5. Can I help by adding some questions and answers?** -Definitely! You can fork the repo and edit the documentation sources right there. +Definitely! You can fork `the repo`_ and edit the documentation sources. + + +**42. Where can I find more answers?** + +You can find more answers on: + +* `IRC: docker on freenode`_ +* `Github`_ +* `Ask questions on Stackoverflow`_ +* `Join the conversation on Twitter`_ + +.. _Windows: ../documentation/installation/windows.html +.. _MacOSX: ../documentation/installation/macos.html +.. _the repo: http://www.github.com/dotcloud/docker +.. _IRC\: docker on freenode: irc://chat.freenode.net#docker +.. _Github: http://www.github.com/dotcloud/docker +.. _Ask questions on Stackoverflow: http://stackoverflow.com/search?q=docker +.. _Join the conversation on Twitter: http://twitter.com/getdocker Looking for something else to read? Checkout the :ref:`hello_world` example. diff --git a/docs/sources/documentation/installation/macos.rst b/docs/sources/documentation/installation/macos.rst index 1f46b838a5..f7c1b65c1d 100644 --- a/docs/sources/documentation/installation/macos.rst +++ b/docs/sources/documentation/installation/macos.rst @@ -32,7 +32,7 @@ Installation .. code-block:: bash - vagant up + vagrant up Vagrant will: diff --git a/docs/sources/gettingstarted.html b/docs/sources/gettingstarted.html index ba2caf01d0..7d198629cd 100644 --- a/docs/sources/gettingstarted.html +++ b/docs/sources/gettingstarted.html @@ -62,13 +62,15 @@
+
+ Docker is still under heavy development. It should not yet be used in production. Check the repo for recent progress. +

- Installing on Ubuntu 12.04 and 12.10

-

Please note this project is currently under heavy development. It should not be used in production.

+ Installing on Ubuntu
  1. Install dependencies:

    diff --git a/docs/sources/index.html b/docs/sources/index.html index 427fe4de9b..382f935781 100644 --- a/docs/sources/index.html +++ b/docs/sources/index.html @@ -72,11 +72,19 @@
-

Docker - the Linux container runtime

+

Docker

+

The Linux container runtime

-

Docker encapsulates heterogeneous payloads in Standard Containers, and runs them on any server with strong guarantees of isolation and repeatability.

+

+ Docker complements LXC with a high-level API which operates at the process level. + It runs unix processes with strong guarantees of isolation and repeatability across servers. +

+ +

+ Docker is a great building block for automating distributed systems: large-scale web deployments, database clusters, continuous deployment systems, private PaaS, service-oriented architectures, etc. +

@@ -93,7 +101,7 @@
-
+
@@ -119,8 +127,6 @@

Because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run.

- -
@@ -138,7 +144,7 @@
-
+
@@ -152,6 +158,21 @@
+
+
+
+ + David Romulan ‏@destructuring: I haven't had this much fun since AWS +
+
+
+
+ + Ricardo Gladwell ‏@rgladwell: wow @getdocker is either amazing or totally stupid +
+
+ +