From 716ff00c8b586385a85bb9f73fee92d752a52a14 Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Fri, 29 Mar 2013 14:56:48 -0700 Subject: [PATCH 1/4] packaging; issue #30: Original files to make the Ubuntu PPA on launch date Upstream-commit: e99541e63729343e908b7c2ab6c901504f1311a3 Component: engine --- components/engine/deb/Makefile | 1 - components/engine/deb/README.md | 1 - components/engine/deb/debian/changelog | 5 - components/engine/deb/etc/docker-dev.upstart | 10 - .../ubuntu/Makefile} | 2 +- components/engine/packaging/ubuntu/README.md | 339 ++++++++++++++++++ .../engine/packaging/ubuntu/debian/changelog | 5 + .../{deb => packaging/ubuntu}/debian/compat | 0 .../{deb => packaging/ubuntu}/debian/control | 15 +- .../ubuntu}/debian/copyright | 2 +- .../{deb => packaging/ubuntu}/debian/docs | 0 .../{deb => packaging/ubuntu}/debian/rules | 0 .../ubuntu}/debian/source/format | 0 .../ubuntu}/etc/docker.upstart | 0 14 files changed, 353 insertions(+), 27 deletions(-) delete mode 120000 components/engine/deb/Makefile delete mode 120000 components/engine/deb/README.md delete mode 100644 components/engine/deb/debian/changelog delete mode 100644 components/engine/deb/etc/docker-dev.upstart rename components/engine/{deb/Makefile.deb => packaging/ubuntu/Makefile} (98%) create mode 100644 components/engine/packaging/ubuntu/README.md create mode 100644 components/engine/packaging/ubuntu/debian/changelog rename components/engine/{deb => packaging/ubuntu}/debian/compat (100%) rename components/engine/{deb => packaging/ubuntu}/debian/control (64%) rename components/engine/{deb => packaging/ubuntu}/debian/copyright (99%) rename components/engine/{deb => packaging/ubuntu}/debian/docs (100%) rename components/engine/{deb => packaging/ubuntu}/debian/rules (100%) rename components/engine/{deb => packaging/ubuntu}/debian/source/format (100%) rename components/engine/{deb => packaging/ubuntu}/etc/docker.upstart (100%) diff --git a/components/engine/deb/Makefile b/components/engine/deb/Makefile deleted file mode 120000 index d0b0e8e008..0000000000 --- a/components/engine/deb/Makefile +++ /dev/null @@ -1 +0,0 @@ -../Makefile \ No newline at end of file diff --git a/components/engine/deb/README.md b/components/engine/deb/README.md deleted file mode 120000 index 32d46ee883..0000000000 --- a/components/engine/deb/README.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/components/engine/deb/debian/changelog b/components/engine/deb/debian/changelog deleted file mode 100644 index 76cc04bee2..0000000000 --- a/components/engine/deb/debian/changelog +++ /dev/null @@ -1,5 +0,0 @@ -dotcloud-docker (1) precise; urgency=low - - * Initial release - - -- dotCloud Mon, 14 Mar 2013 04:43:21 -0700 diff --git a/components/engine/deb/etc/docker-dev.upstart b/components/engine/deb/etc/docker-dev.upstart deleted file mode 100644 index 6cfe9d2616..0000000000 --- a/components/engine/deb/etc/docker-dev.upstart +++ /dev/null @@ -1,10 +0,0 @@ -description "Run docker" - -start on runlevel [2345] -stop on starting rc RUNLEVEL=[016] -respawn - -script - test -f /etc/default/locale && . /etc/default/locale || true - LANG=$LANG LC_ALL=$LANG /usr/bin/docker -d -end script diff --git a/components/engine/deb/Makefile.deb b/components/engine/packaging/ubuntu/Makefile similarity index 98% rename from components/engine/deb/Makefile.deb rename to components/engine/packaging/ubuntu/Makefile index c954b0f5b5..beec903fc9 100644 --- a/components/engine/deb/Makefile.deb +++ b/components/engine/packaging/ubuntu/Makefile @@ -1,4 +1,4 @@ -PKG_NAME=dotcloud-docker +PKG_NAME=lxc-docker PKG_ARCH=amd64 PKG_VERSION=1 ROOT_PATH:=$(PWD) diff --git a/components/engine/packaging/ubuntu/README.md b/components/engine/packaging/ubuntu/README.md new file mode 100644 index 0000000000..c955a1dcf2 --- /dev/null +++ b/components/engine/packaging/ubuntu/README.md @@ -0,0 +1,339 @@ +Docker: the Linux container runtime +=================================== + +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. + + + +* *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. + + +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 +-------------- + +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. + + +Install instructions +================== + +Installing on Ubuntu 12.04 and 12.10 +------------------------------------ + +1. Install dependencies: + + ```bash + sudo apt-get install lxc wget bsdtar curl + sudo apt-get install linux-image-extra-`uname -r` + ``` + + The `linux-image-extra` package is needed on standard Ubuntu EC2 AMIs in order to install the aufs kernel module. + +2. Install the latest docker binary: + + ```bash + wget http://get.docker.io/builds/$(uname -s)/$(uname -m)/docker-master.tgz + tar -xf docker-master.tgz + ``` + +3. Run your first container! + + ```bash + cd docker-master + sudo ./docker run -i -t base /bin/bash + ``` + + Consider adding docker to your `PATH` for simplicity. + +Installing on other Linux distributions +--------------------------------------- + +Right now, the officially supported distributions are: + +* Ubuntu 12.04 (precise LTS) +* Ubuntu 12.10 (quantal) + +Docker probably works on other distributions featuring a recent kernel, the AUFS patch, and up-to-date lxc. However this has not been tested. + +Installing with Vagrant +----------------------- + +Currently, Docker can be installed with Vagrant both on your localhost +with VirtualBox as well as on Amazon EC2. Vagrant 1.1 is required for +EC2, but deploying is as simple as: + +```bash +$ export AWS_ACCESS_KEY_ID=xxx \ + AWS_SECRET_ACCESS_KEY=xxx \ + AWS_KEYPAIR_NAME=xxx \ + AWS_SSH_PRIVKEY=xxx +$ vagrant plugin install vagrant-aws +$ vagrant up --provider=aws +``` + +The environment variables are: + +* `AWS_ACCESS_KEY_ID` - The API key used to make requests to AWS +* `AWS_SECRET_ACCESS_KEY` - The secret key to make AWS API requests +* `AWS_KEYPAIR_NAME` - The name of the keypair used for this EC2 instance +* `AWS_SSH_PRIVKEY` - The path to the private key for the named keypair + +For VirtualBox, you can simply ignore setting any of the environment +variables and omit the `provider` flag. VirtualBox is still supported with +Vagrant <= 1.1: + +```bash +$ vagrant up +``` + + + +Usage examples +============== + +Running an interactive shell +---------------------------- + +```bash +# Download a base image +docker pull base + +# Run an interactive shell in the base image, +# allocate a tty, attach stdin and stdout +docker run -i -t base /bin/bash +``` + + +Starting a long-running worker process +-------------------------------------- + +```bash +# Run docker in daemon mode +(docker -d || echo "Docker daemon already running") & + +# Start a very useful long-running process +JOB=$(docker run -d base /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 +``` + + +Listing all running containers +------------------------------ + +```bash +docker ps +``` + + +Expose a service on a TCP port +------------------------------ + +```bash +# 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 +echo hello world | nc $(hostname) $PORT + +# Verify that the network connection worked +echo "Daemon received: $(docker logs $JOB)" +``` + +Contributing to Docker +====================== + +Want to hack on Docker? Awesome! Here are instructions to get you started. They are probably not perfect, please let us know if anything feels wrong or incomplete. + +Contribution guidelines +----------------------- + +### Pull requests are always welcome + +We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it. + +If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve. + +We're trying very hard to keep Docker lean and focused. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. +However, there might be a way to implement that feature *on top of* docker. + +### 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/components/engine/packaging/ubuntu/debian/changelog b/components/engine/packaging/ubuntu/debian/changelog new file mode 100644 index 0000000000..d8932885e6 --- /dev/null +++ b/components/engine/packaging/ubuntu/debian/changelog @@ -0,0 +1,5 @@ +lxc-docker (1) precise; urgency=low + + * Initial release + + -- dotCloud Mon, 25 Mar 2013 05:51:12 -0700 diff --git a/components/engine/deb/debian/compat b/components/engine/packaging/ubuntu/debian/compat similarity index 100% rename from components/engine/deb/debian/compat rename to components/engine/packaging/ubuntu/debian/compat diff --git a/components/engine/deb/debian/control b/components/engine/packaging/ubuntu/debian/control similarity index 64% rename from components/engine/deb/debian/control rename to components/engine/packaging/ubuntu/debian/control index 5245d7e238..1ad913854d 100644 --- a/components/engine/deb/debian/control +++ b/components/engine/packaging/ubuntu/debian/control @@ -1,16 +1,15 @@ -Source: dotcloud-docker +Source: lxc-docker Section: misc Priority: extra -Homepage: https://github.com/dotcloud/docker +Homepage: http://docker.io Maintainer: Daniel Mizyrycki -Build-Depends: debhelper (>= 8.0.0), git, golang -Vcs-Git: https://github.com/dotcloud/docker.git -Standards-Version: 3.9.2 +Build-Depends: debhelper (>= 8.0.0), pkg-config, git, golang, libsqlite3-dev +Vcs-Git: http://github.com/dotcloud/docker.git +Standards-Version: 3.9.3 -Package: dotcloud-docker +Package: lxc-docker Architecture: amd64 -Provides: dotcloud-docker -Depends: lxc, wget, bsdtar, curl +Depends: ${shlibs:Depends}, ${misc:Depends}, lxc, wget, bsdtar, curl, sqlite3 Conflicts: docker Description: A process manager with superpowers It encapsulates heterogeneous payloads in Standard Containers, and runs diff --git a/components/engine/deb/debian/copyright b/components/engine/packaging/ubuntu/debian/copyright similarity index 99% rename from components/engine/deb/debian/copyright rename to components/engine/packaging/ubuntu/debian/copyright index 6f3a66bbce..c6c97190a9 100644 --- a/components/engine/deb/debian/copyright +++ b/components/engine/packaging/ubuntu/debian/copyright @@ -1,5 +1,5 @@ Format: http://dep.debian.net/deps/dep5 -Upstream-Name: dotcloud-docker +Upstream-Name: docker Source: https://github.com/dotcloud/docker Files: * diff --git a/components/engine/deb/debian/docs b/components/engine/packaging/ubuntu/debian/docs similarity index 100% rename from components/engine/deb/debian/docs rename to components/engine/packaging/ubuntu/debian/docs diff --git a/components/engine/deb/debian/rules b/components/engine/packaging/ubuntu/debian/rules similarity index 100% rename from components/engine/deb/debian/rules rename to components/engine/packaging/ubuntu/debian/rules diff --git a/components/engine/deb/debian/source/format b/components/engine/packaging/ubuntu/debian/source/format similarity index 100% rename from components/engine/deb/debian/source/format rename to components/engine/packaging/ubuntu/debian/source/format diff --git a/components/engine/deb/etc/docker.upstart b/components/engine/packaging/ubuntu/etc/docker.upstart similarity index 100% rename from components/engine/deb/etc/docker.upstart rename to components/engine/packaging/ubuntu/etc/docker.upstart From 5d8f85d0ac0d3fcdf39cb2301bc214c807e40af9 Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Wed, 10 Apr 2013 21:00:39 -0700 Subject: [PATCH 2/4] packaging; issue #251: Add debian packaging Upstream-commit: 8ea1e9126f3d64216e2d8a91ce6f8ad1f3d8587c Component: engine --- components/engine/packaging/debian/Makefile | 35 +++ .../engine/packaging/debian/Vagrantfile | 22 ++ components/engine/packaging/debian/changelog | 14 ++ components/engine/packaging/debian/compat | 1 + components/engine/packaging/debian/control | 19 ++ components/engine/packaging/debian/copyright | 237 ++++++++++++++++++ .../engine/packaging/debian/docker.initd | 49 ++++ components/engine/packaging/debian/docs | 1 + .../packaging/debian/lxc-docker.postinst | 13 + components/engine/packaging/debian/rules | 13 + .../engine/packaging/debian/source/format | 1 + 11 files changed, 405 insertions(+) create mode 100644 components/engine/packaging/debian/Makefile create mode 100644 components/engine/packaging/debian/Vagrantfile create mode 100644 components/engine/packaging/debian/changelog create mode 100644 components/engine/packaging/debian/compat create mode 100644 components/engine/packaging/debian/control create mode 100644 components/engine/packaging/debian/copyright create mode 100644 components/engine/packaging/debian/docker.initd create mode 100644 components/engine/packaging/debian/docs create mode 100644 components/engine/packaging/debian/lxc-docker.postinst create mode 100755 components/engine/packaging/debian/rules create mode 100644 components/engine/packaging/debian/source/format diff --git a/components/engine/packaging/debian/Makefile b/components/engine/packaging/debian/Makefile new file mode 100644 index 0000000000..75ff8f34f5 --- /dev/null +++ b/components/engine/packaging/debian/Makefile @@ -0,0 +1,35 @@ +PKG_NAME=lxc-docker +DOCKER_VERSION=$(shell head -1 changelog | awk 'match($$0, /\(.+\)/) {print substr($$0, RSTART+1, RLENGTH-4)}') +GITHUB_PATH=github.com/dotcloud/docker +SOURCE_PKG=$(PKG_NAME)_$(DOCKER_VERSION).orig.tar.gz +BUILD_SRC=${CURDIR}/../../build_src + +all: + # Compile docker. Used by debian dpkg-buildpackage. + cd src/${GITHUB_PATH}/docker; GOPATH=${CURDIR} go build + +install: + # Used by debian dpkg-buildpackage + mkdir -p $(DESTDIR)/usr/bin + mkdir -p $(DESTDIR)/etc/init.d + install -m 0755 src/${GITHUB_PATH}/docker/docker $(DESTDIR)/usr/bin + install -o root -m 0755 debian/docker.initd $(DESTDIR)/etc/init.d/docker + +debian: + # This Makefile will compile the github master branch of dotcloud/docker + # Retrieve docker project and its go structure from internet + rm -rf ${BUILD_SRC} + GOPATH=${BUILD_SRC} go get ${GITHUB_PATH} + # Add debianization + mkdir ${BUILD_SRC}/debian + cp Makefile ${BUILD_SRC} + cp -r * ${BUILD_SRC}/debian + cp ../../README.md ${BUILD_SRC} + # Cleanup + for d in `find ${BUILD_SRC} -name '.git*'`; do rm -rf $$d; done + rm -rf ${BUILD_SRC}/../${SOURCE_PKG} + rm -rf ${BUILD_SRC}/pkg + # Create docker debian files + cd ${BUILD_SRC}; tar czf ../${SOURCE_PKG} . + cd ${BUILD_SRC}; dpkg-buildpackage + rm -rf ${BUILD_SRC} diff --git a/components/engine/packaging/debian/Vagrantfile b/components/engine/packaging/debian/Vagrantfile new file mode 100644 index 0000000000..2da2900605 --- /dev/null +++ b/components/engine/packaging/debian/Vagrantfile @@ -0,0 +1,22 @@ +# -*- mode: ruby -*- +# vi: set ft=ruby : + +$BUILDBOT_IP = '192.168.33.31' + +def v10(config) + config.vm.box = 'debian' + config.vm.share_folder 'v-data', '/data/docker', File.dirname(__FILE__) + '/../..' + config.vm.network :hostonly, $BUILDBOT_IP + + # Install debian packaging dependencies and create debian packages + config.vm.provision :shell, :inline => 'apt-get -qq update; apt-get install -y debhelper autotools-dev golang' + config.vm.provision :shell, :inline => 'cd /data/docker/packaging/debian; make debian' +end + +Vagrant::VERSION < '1.1.0' and Vagrant::Config.run do |config| + v10(config) +end + +Vagrant::VERSION >= '1.1.0' and Vagrant.configure('1') do |config| + v10(config) +end diff --git a/components/engine/packaging/debian/changelog b/components/engine/packaging/debian/changelog new file mode 100644 index 0000000000..761a879e8a --- /dev/null +++ b/components/engine/packaging/debian/changelog @@ -0,0 +1,14 @@ +lxc-docker (0.1.4-1) unstable; urgency=low + + Improvements [+], Updates [*], Bug fixes [-]: + * Changed default bridge interface do 'docker0' + - Fix a race condition when running the port allocator + + -- Daniel Mizyrycki Wed, 10 Apr 2013 18:06:21 -0700 + + +lxc-docker (0.1.0-1) unstable; urgency=low + + * Initial release + + -- Daniel Mizyrycki Mon, 29 Mar 2013 18:09:55 -0700 diff --git a/components/engine/packaging/debian/compat b/components/engine/packaging/debian/compat new file mode 100644 index 0000000000..ec635144f6 --- /dev/null +++ b/components/engine/packaging/debian/compat @@ -0,0 +1 @@ +9 diff --git a/components/engine/packaging/debian/control b/components/engine/packaging/debian/control new file mode 100644 index 0000000000..a09e9aee56 --- /dev/null +++ b/components/engine/packaging/debian/control @@ -0,0 +1,19 @@ +Source: lxc-docker +Section: admin +Priority: optional +Maintainer: Daniel Mizyrycki +Build-Depends: debhelper (>= 9),autotools-dev,golang +Standards-Version: 3.9.3 +Homepage: http://github.com/dotcloud/docker + +Package: lxc-docker +Architecture: linux-any +Depends: ${misc:Depends},${shlibs:Depends},lxc,bsdtar +Conflicts: docker +Description: lxc-docker is a Linux container runtime + 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. diff --git a/components/engine/packaging/debian/copyright b/components/engine/packaging/debian/copyright new file mode 100644 index 0000000000..668c8635e4 --- /dev/null +++ b/components/engine/packaging/debian/copyright @@ -0,0 +1,237 @@ +Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: docker +Upstream-Contact: DotCloud Inc +Source: http://github.com/dotcloud/docker + +Files: * +Copyright: 2012, DotCloud Inc +License: Apache-2.0 + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2012 DotCloud Inc + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + +Files: src/github.com/kr/pty/* +Copyright: Copyright (c) 2011 Keith Rarick +License: Expat + Copyright (c) 2011 Keith Rarick + + Permission is hereby granted, free of charge, to any person + obtaining a copy of this software and associated + documentation files (the "Software"), to deal in the + Software without restriction, including without limitation + the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, + subject to the following conditions: + + The above copyright notice and this permission notice shall + be included in all copies or substantial portions of the + Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY + KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE + WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS + OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR + OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR + OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/components/engine/packaging/debian/docker.initd b/components/engine/packaging/debian/docker.initd new file mode 100644 index 0000000000..2b6a3c0979 --- /dev/null +++ b/components/engine/packaging/debian/docker.initd @@ -0,0 +1,49 @@ +#!/bin/sh + +### BEGIN INIT INFO +# Provides: docker +# Required-Start: $local_fs +# Required-Stop: $local_fs +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# Short-Description: docker +# Description: docker daemon +### END INIT INFO + +DOCKER=/usr/bin/docker +PIDFILE=/var/run/docker.pid + +# Check docker is present +[ -x $DOCKER ] || log_success_msg "Docker not present" + +# Get lsb functions +. /lib/lsb/init-functions + + +case "$1" in + start) + log_begin_msg "Starting docker..." + start-stop-daemon --start --background --exec "$DOCKER" -- -d + log_end_msg $? + ;; + stop) + log_begin_msg "Stopping docker..." + docker_pid=`pgrep -f "$DOCKER -d"` + [ -n "$docker_pid" ] && kill $docker_pid + log_end_msg $? + ;; + status) + docker_pid=`pgrep -f "$DOCKER -d"` + if [ -z "$docker_pid" ] ; then + echo "docker not running" + else + echo "docker running (pid $docker_pid)" + fi + ;; + *) + echo "Usage: /etc/init.d/docker {start|stop|status}" + exit 1 + ;; +esac + +exit 0 diff --git a/components/engine/packaging/debian/docs b/components/engine/packaging/debian/docs new file mode 100644 index 0000000000..b43bf86b50 --- /dev/null +++ b/components/engine/packaging/debian/docs @@ -0,0 +1 @@ +README.md diff --git a/components/engine/packaging/debian/lxc-docker.postinst b/components/engine/packaging/debian/lxc-docker.postinst new file mode 100644 index 0000000000..91e251dc8d --- /dev/null +++ b/components/engine/packaging/debian/lxc-docker.postinst @@ -0,0 +1,13 @@ +#!/bin/sh + +# Ensure cgroup is mounted +if [ -z "`/bin/egrep -e '^cgroup' /etc/fstab`" ]; then + /bin/echo 'cgroup /sys/fs/cgroup cgroup defaults 0 0' >>/etc/fstab +fi +if [ -z "`/bin/mount | /bin/egrep -e '^cgroup'`" ]; then + /bin/mount /sys/fs/cgroup +fi + +# Start docker +/usr/sbin/update-rc.d docker defaults +/etc/init.d/docker start diff --git a/components/engine/packaging/debian/rules b/components/engine/packaging/debian/rules new file mode 100755 index 0000000000..25f16f9c61 --- /dev/null +++ b/components/engine/packaging/debian/rules @@ -0,0 +1,13 @@ +#!/usr/bin/make -f +# -*- makefile -*- +# Sample debian/rules that uses debhelper. +# This file was originally written by Joey Hess and Craig Small. +# As a special exception, when this file is copied by dh-make into a +# dh-make output file, you may use that output file without restriction. +# This special exception was added by Craig Small in version 0.37 of dh-make. + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + +%: + dh ${@} --with autotools_dev diff --git a/components/engine/packaging/debian/source/format b/components/engine/packaging/debian/source/format new file mode 100644 index 0000000000..163aaf8d82 --- /dev/null +++ b/components/engine/packaging/debian/source/format @@ -0,0 +1 @@ +3.0 (quilt) From 5b2bb885c11502f391f511e78dd7a28238757817 Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Thu, 11 Apr 2013 17:39:47 -0700 Subject: [PATCH 3/4] Packaging: Add README documentation Upstream-commit: b14164879b4461b77b630719e67d619acf1a7648 Component: engine --- components/engine/packaging/README.rst | 8 + .../engine/packaging/debian/README.debian | 31 ++ components/engine/packaging/ubuntu/README.md | 339 ------------------ 3 files changed, 39 insertions(+), 339 deletions(-) create mode 100644 components/engine/packaging/README.rst create mode 100644 components/engine/packaging/debian/README.debian delete mode 100644 components/engine/packaging/ubuntu/README.md diff --git a/components/engine/packaging/README.rst b/components/engine/packaging/README.rst new file mode 100644 index 0000000000..7e927ccffe --- /dev/null +++ b/components/engine/packaging/README.rst @@ -0,0 +1,8 @@ +Docker packaging +================ + +This directory has one subdirectory per packaging distribution. +At minimum, each of these subdirectories should contain a +README.$DISTRIBUTION explaining how to create the native +docker package and how to install it. + diff --git a/components/engine/packaging/debian/README.debian b/components/engine/packaging/debian/README.debian new file mode 100644 index 0000000000..83dc42268b --- /dev/null +++ b/components/engine/packaging/debian/README.debian @@ -0,0 +1,31 @@ +Docker on Debian +================ + +Docker has been built and tested on Wheezy. All docker functionality works +out of the box, except for memory limitation as the stock debian kernel +does not support it yet. + + +Building docker package +~~~~~~~~~~~~~~~~~~~~~~~ + +Building Dependencies: debhelper, autotools-dev and golang + + +Assuming you have a wheezy system up and running + +# Download a fresh copy of the docker project +git clone https://github.com/dotcloud/docker.git +cd docker + +# Get building dependencies +sudo apt-get update ; sudo apt-get install -y debhelper autotools-dev golang + +# Make the debian package, with no memory limitation support +(cd packaging/debian; make debian NO_MEMORY_LIMIT=1) + + +Install docker package +~~~~~~~~~~~~~~~~~~~~~~ + +sudo dpkg -i lxc-docker_0.1.4-1_amd64.deb; sudo apt-get install -f -y diff --git a/components/engine/packaging/ubuntu/README.md b/components/engine/packaging/ubuntu/README.md deleted file mode 100644 index c955a1dcf2..0000000000 --- a/components/engine/packaging/ubuntu/README.md +++ /dev/null @@ -1,339 +0,0 @@ -Docker: the Linux container runtime -=================================== - -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. - - - -* *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. - - -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 --------------- - -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. - - -Install instructions -================== - -Installing on Ubuntu 12.04 and 12.10 ------------------------------------- - -1. Install dependencies: - - ```bash - sudo apt-get install lxc wget bsdtar curl - sudo apt-get install linux-image-extra-`uname -r` - ``` - - The `linux-image-extra` package is needed on standard Ubuntu EC2 AMIs in order to install the aufs kernel module. - -2. Install the latest docker binary: - - ```bash - wget http://get.docker.io/builds/$(uname -s)/$(uname -m)/docker-master.tgz - tar -xf docker-master.tgz - ``` - -3. Run your first container! - - ```bash - cd docker-master - sudo ./docker run -i -t base /bin/bash - ``` - - Consider adding docker to your `PATH` for simplicity. - -Installing on other Linux distributions ---------------------------------------- - -Right now, the officially supported distributions are: - -* Ubuntu 12.04 (precise LTS) -* Ubuntu 12.10 (quantal) - -Docker probably works on other distributions featuring a recent kernel, the AUFS patch, and up-to-date lxc. However this has not been tested. - -Installing with Vagrant ------------------------ - -Currently, Docker can be installed with Vagrant both on your localhost -with VirtualBox as well as on Amazon EC2. Vagrant 1.1 is required for -EC2, but deploying is as simple as: - -```bash -$ export AWS_ACCESS_KEY_ID=xxx \ - AWS_SECRET_ACCESS_KEY=xxx \ - AWS_KEYPAIR_NAME=xxx \ - AWS_SSH_PRIVKEY=xxx -$ vagrant plugin install vagrant-aws -$ vagrant up --provider=aws -``` - -The environment variables are: - -* `AWS_ACCESS_KEY_ID` - The API key used to make requests to AWS -* `AWS_SECRET_ACCESS_KEY` - The secret key to make AWS API requests -* `AWS_KEYPAIR_NAME` - The name of the keypair used for this EC2 instance -* `AWS_SSH_PRIVKEY` - The path to the private key for the named keypair - -For VirtualBox, you can simply ignore setting any of the environment -variables and omit the `provider` flag. VirtualBox is still supported with -Vagrant <= 1.1: - -```bash -$ vagrant up -``` - - - -Usage examples -============== - -Running an interactive shell ----------------------------- - -```bash -# Download a base image -docker pull base - -# Run an interactive shell in the base image, -# allocate a tty, attach stdin and stdout -docker run -i -t base /bin/bash -``` - - -Starting a long-running worker process --------------------------------------- - -```bash -# Run docker in daemon mode -(docker -d || echo "Docker daemon already running") & - -# Start a very useful long-running process -JOB=$(docker run -d base /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 -``` - - -Listing all running containers ------------------------------- - -```bash -docker ps -``` - - -Expose a service on a TCP port ------------------------------- - -```bash -# 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 -echo hello world | nc $(hostname) $PORT - -# Verify that the network connection worked -echo "Daemon received: $(docker logs $JOB)" -``` - -Contributing to Docker -====================== - -Want to hack on Docker? Awesome! Here are instructions to get you started. They are probably not perfect, please let us know if anything feels wrong or incomplete. - -Contribution guidelines ------------------------ - -### Pull requests are always welcome - -We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it. - -If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve. - -We're trying very hard to keep Docker lean and focused. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. -However, there might be a way to implement that feature *on top of* docker. - -### 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 - - From f8333f7048494ea6ddc415271677b579f3cb5a94 Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Thu, 11 Apr 2013 20:17:41 -0700 Subject: [PATCH 4/4] Packaging, Debian: Add maintainer documentation Upstream-commit: f226842aa1f9148449558c90de7cdfb61105df28 Component: engine --- .../engine/packaging/debian/maintainer.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 components/engine/packaging/debian/maintainer.rst diff --git a/components/engine/packaging/debian/maintainer.rst b/components/engine/packaging/debian/maintainer.rst new file mode 100644 index 0000000000..111d4fcc3e --- /dev/null +++ b/components/engine/packaging/debian/maintainer.rst @@ -0,0 +1,16 @@ +Maintainer duty +=============== + +The Debian project specifies the role of a 'maintainer' which is the person +making the Debian package of the program. This role requires an 'sponsor' to +upload the package. As a maintainer you should follow the guide +http://www.debian.org/doc/manuals/maint-guide . Your sponsor will be there +helping you succeed. + +The most relevant information to update is the changelog file: +Each new release should create a new first paragraph with new release version, +changes, and the maintainer information. + +After this is done, follow README.debian to generate the actual source +packages and talk with your sponsor to upload them into the official Debian +package archive.