Browse code

packaging; issue #30: Original files to make the Ubuntu PPA on launch date

Daniel Mizyrycki authored on 2013/03/30 06:56:48
Showing 22 changed files
1 1
deleted file mode 120000
... ...
@@ -1 +0,0 @@
1
-../Makefile
2 1
\ No newline at end of file
3 2
deleted file mode 100644
... ...
@@ -1,73 +0,0 @@
1
-PKG_NAME=dotcloud-docker
2
-PKG_ARCH=amd64
3
-PKG_VERSION=1
4
-ROOT_PATH:=$(PWD)
5
-BUILD_PATH=build	# Do not change, decided by dpkg-buildpackage
6
-BUILD_SRC=build_src
7
-GITHUB_PATH=src/github.com/dotcloud/docker
8
-INSDIR=usr/bin
9
-SOURCE_PACKAGE=$(PKG_NAME)_$(PKG_VERSION).orig.tar.gz
10
-DEB_PACKAGE=$(PKG_NAME)_$(PKG_VERSION)_$(PKG_ARCH).deb
11
-EXTRA_GO_PKG=./auth
12
-
13
-TMPDIR=$(shell mktemp -d -t XXXXXX)
14
-
15
-
16
-# Build a debian source package
17
-all: clean build_in_deb
18
-
19
-build_in_deb:
20
-	echo "GOPATH = " $(ROOT_PATH)
21
-	mkdir bin
22
-	cd $(GITHUB_PATH)/docker; GOPATH=$(ROOT_PATH) go build -o $(ROOT_PATH)/bin/docker
23
-
24
-# DESTDIR provided by Debian packaging
25
-install:
26
-	# Call this from a go environment (as packaged for deb source package)
27
-	mkdir -p $(DESTDIR)/$(INSDIR)
28
-	mkdir -p $(DESTDIR)/etc/init
29
-	install -m 0755 bin/docker $(DESTDIR)/$(INSDIR)
30
-	install -o root -m 0755 etc/docker.upstart $(DESTDIR)/etc/init/docker.conf
31
-
32
-$(BUILD_SRC): clean
33
-	# Copy ourselves into $BUILD_SRC to comply with unusual golang constraints
34
-	tar --exclude=*.tar.gz --exclude=checkout.tgz -f checkout.tgz -cz *
35
-	mkdir -p $(BUILD_SRC)/$(GITHUB_PATH)
36
-	tar -f checkout.tgz -C $(BUILD_SRC)/$(GITHUB_PATH) -xz
37
-	cd $(BUILD_SRC)/$(GITHUB_PATH)/docker; GOPATH=$(ROOT_PATH)/$(BUILD_SRC) go get -d
38
-	for d in `find $(BUILD_SRC) -name '.git*'`; do rm -rf $$d; done
39
-	# Populate source build with debian stuff
40
-	cp -R -L ./deb/* $(BUILD_SRC)
41
-
42
-$(SOURCE_PACKAGE): $(BUILD_SRC)
43
-	rm -f $(SOURCE_PACKAGE)
44
-	# Create the debian source package
45
-	tar -f $(SOURCE_PACKAGE) -C ${ROOT_PATH}/${BUILD_SRC} -cz .
46
-
47
-# Build deb package fetching go dependencies and cleaning up git repositories
48
-deb: $(DEB_PACKAGE)
49
-
50
-$(DEB_PACKAGE): $(SOURCE_PACKAGE)
51
-	# dpkg-buildpackage looks for source package tarball in ../
52
-	cd $(BUILD_SRC); dpkg-buildpackage
53
-	rm -rf $(BUILD_PATH) debian/$(PKG_NAME)* debian/files
54
-
55
-debsrc: $(SOURCE_PACKAGE)
56
-
57
-# Build local sources
58
-#$(PKG_NAME): build_local
59
-
60
-build_local:
61
-	-@mkdir -p bin
62
-	cd docker && go build -o ../bin/docker
63
-
64
-gotest:
65
-	@echo "\033[36m[Testing]\033[00m docker..."
66
-	@sudo -E GOPATH=$(ROOT_PATH)/$(BUILD_SRC) go test -v . $(EXTRA_GO_PKG) && \
67
-		echo -n "\033[32m[OK]\033[00m" || \
68
-		echo -n "\033[31m[FAIL]\033[00m"; \
69
-		echo " docker"
70
-	@sudo rm -rf /tmp/docker-*
71
-
72
-clean:
73
-	rm -rf $(BUILD_PATH) debian/$(PKG_NAME)* debian/files $(BUILD_SRC) checkout.tgz bin
74 1
deleted file mode 120000
... ...
@@ -1 +0,0 @@
1
-../README.md
2 1
\ No newline at end of file
3 2
deleted file mode 100644
... ...
@@ -1,5 +0,0 @@
1
-dotcloud-docker (1) precise; urgency=low
2
-
3
-  * Initial release
4
-
5
- -- dotCloud <ops@dotcloud.com>  Mon, 14 Mar 2013 04:43:21 -0700
6 1
deleted file mode 100644
... ...
@@ -1 +0,0 @@
1
-8
2 1
deleted file mode 100644
... ...
@@ -1,20 +0,0 @@
1
-Source: dotcloud-docker
2
-Section: misc
3
-Priority: extra
4
-Homepage: https://github.com/dotcloud/docker
5
-Maintainer: Daniel Mizyrycki <daniel@dotcloud.com>
6
-Build-Depends: debhelper (>= 8.0.0), git, golang
7
-Vcs-Git: https://github.com/dotcloud/docker.git
8
-Standards-Version: 3.9.2
9
-
10
-Package: dotcloud-docker
11
-Architecture: amd64
12
-Provides: dotcloud-docker
13
-Depends: lxc, wget, bsdtar, curl
14
-Conflicts: docker
15
-Description: A process manager with superpowers
16
-    It encapsulates heterogeneous payloads in Standard Containers, and runs
17
-    them on any server with strong guarantees of isolation and repeatability.
18
-    Is is a great building block for automating distributed systems:
19
-    large-scale web deployments, database clusters, continuous deployment
20
-    systems, private PaaS, service-oriented architectures, etc.
21 1
deleted file mode 100644
... ...
@@ -1,209 +0,0 @@
1
-Format: http://dep.debian.net/deps/dep5
2
-Upstream-Name: dotcloud-docker
3
-Source: https://github.com/dotcloud/docker
4
-
5
-Files: *
6
-Copyright: 2012 DotCloud Inc (opensource@dotcloud.com)
7
-License: Apache License Version 2.0
8
-
9
-                                Apache License
10
-                           Version 2.0, January 2004
11
-                        http://www.apache.org/licenses/
12
-
13
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
14
-
15
-   1. Definitions.
16
-
17
-      "License" shall mean the terms and conditions for use, reproduction,
18
-      and distribution as defined by Sections 1 through 9 of this document.
19
-
20
-      "Licensor" shall mean the copyright owner or entity authorized by
21
-      the copyright owner that is granting the License.
22
-
23
-      "Legal Entity" shall mean the union of the acting entity and all
24
-      other entities that control, are controlled by, or are under common
25
-      control with that entity. For the purposes of this definition,
26
-      "control" means (i) the power, direct or indirect, to cause the
27
-      direction or management of such entity, whether by contract or
28
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
29
-      outstanding shares, or (iii) beneficial ownership of such entity.
30
-
31
-      "You" (or "Your") shall mean an individual or Legal Entity
32
-      exercising permissions granted by this License.
33
-
34
-      "Source" form shall mean the preferred form for making modifications,
35
-      including but not limited to software source code, documentation
36
-      source, and configuration files.
37
-
38
-      "Object" form shall mean any form resulting from mechanical
39
-      transformation or translation of a Source form, including but
40
-      not limited to compiled object code, generated documentation,
41
-      and conversions to other media types.
42
-
43
-      "Work" shall mean the work of authorship, whether in Source or
44
-      Object form, made available under the License, as indicated by a
45
-      copyright notice that is included in or attached to the work
46
-      (an example is provided in the Appendix below).
47
-
48
-      "Derivative Works" shall mean any work, whether in Source or Object
49
-      form, that is based on (or derived from) the Work and for which the
50
-      editorial revisions, annotations, elaborations, or other modifications
51
-      represent, as a whole, an original work of authorship. For the purposes
52
-      of this License, Derivative Works shall not include works that remain
53
-      separable from, or merely link (or bind by name) to the interfaces of,
54
-      the Work and Derivative Works thereof.
55
-
56
-      "Contribution" shall mean any work of authorship, including
57
-      the original version of the Work and any modifications or additions
58
-      to that Work or Derivative Works thereof, that is intentionally
59
-      submitted to Licensor for inclusion in the Work by the copyright owner
60
-      or by an individual or Legal Entity authorized to submit on behalf of
61
-      the copyright owner. For the purposes of this definition, "submitted"
62
-      means any form of electronic, verbal, or written communication sent
63
-      to the Licensor or its representatives, including but not limited to
64
-      communication on electronic mailing lists, source code control systems,
65
-      and issue tracking systems that are managed by, or on behalf of, the
66
-      Licensor for the purpose of discussing and improving the Work, but
67
-      excluding communication that is conspicuously marked or otherwise
68
-      designated in writing by the copyright owner as "Not a Contribution."
69
-
70
-      "Contributor" shall mean Licensor and any individual or Legal Entity
71
-      on behalf of whom a Contribution has been received by Licensor and
72
-      subsequently incorporated within the Work.
73
-
74
-   2. Grant of Copyright License. Subject to the terms and conditions of
75
-      this License, each Contributor hereby grants to You a perpetual,
76
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
-      copyright license to reproduce, prepare Derivative Works of,
78
-      publicly display, publicly perform, sublicense, and distribute the
79
-      Work and such Derivative Works in Source or Object form.
80
-
81
-   3. Grant of Patent License. Subject to the terms and conditions of
82
-      this License, each Contributor hereby grants to You a perpetual,
83
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
84
-      (except as stated in this section) patent license to make, have made,
85
-      use, offer to sell, sell, import, and otherwise transfer the Work,
86
-      where such license applies only to those patent claims licensable
87
-      by such Contributor that are necessarily infringed by their
88
-      Contribution(s) alone or by combination of their Contribution(s)
89
-      with the Work to which such Contribution(s) was submitted. If You
90
-      institute patent litigation against any entity (including a
91
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
92
-      or a Contribution incorporated within the Work constitutes direct
93
-      or contributory patent infringement, then any patent licenses
94
-      granted to You under this License for that Work shall terminate
95
-      as of the date such litigation is filed.
96
-
97
-   4. Redistribution. You may reproduce and distribute copies of the
98
-      Work or Derivative Works thereof in any medium, with or without
99
-      modifications, and in Source or Object form, provided that You
100
-      meet the following conditions:
101
-
102
-      (a) You must give any other recipients of the Work or
103
-          Derivative Works a copy of this License; and
104
-
105
-      (b) You must cause any modified files to carry prominent notices
106
-          stating that You changed the files; and
107
-
108
-      (c) You must retain, in the Source form of any Derivative Works
109
-          that You distribute, all copyright, patent, trademark, and
110
-          attribution notices from the Source form of the Work,
111
-          excluding those notices that do not pertain to any part of
112
-          the Derivative Works; and
113
-
114
-      (d) If the Work includes a "NOTICE" text file as part of its
115
-          distribution, then any Derivative Works that You distribute must
116
-          include a readable copy of the attribution notices contained
117
-          within such NOTICE file, excluding those notices that do not
118
-          pertain to any part of the Derivative Works, in at least one
119
-          of the following places: within a NOTICE text file distributed
120
-          as part of the Derivative Works; within the Source form or
121
-          documentation, if provided along with the Derivative Works; or,
122
-          within a display generated by the Derivative Works, if and
123
-          wherever such third-party notices normally appear. The contents
124
-          of the NOTICE file are for informational purposes only and
125
-          do not modify the License. You may add Your own attribution
126
-          notices within Derivative Works that You distribute, alongside
127
-          or as an addendum to the NOTICE text from the Work, provided
128
-          that such additional attribution notices cannot be construed
129
-          as modifying the License.
130
-
131
-      You may add Your own copyright statement to Your modifications and
132
-      may provide additional or different license terms and conditions
133
-      for use, reproduction, or distribution of Your modifications, or
134
-      for any such Derivative Works as a whole, provided Your use,
135
-      reproduction, and distribution of the Work otherwise complies with
136
-      the conditions stated in this License.
137
-
138
-   5. Submission of Contributions. Unless You explicitly state otherwise,
139
-      any Contribution intentionally submitted for inclusion in the Work
140
-      by You to the Licensor shall be under the terms and conditions of
141
-      this License, without any additional terms or conditions.
142
-      Notwithstanding the above, nothing herein shall supersede or modify
143
-      the terms of any separate license agreement you may have executed
144
-      with Licensor regarding such Contributions.
145
-
146
-   6. Trademarks. This License does not grant permission to use the trade
147
-      names, trademarks, service marks, or product names of the Licensor,
148
-      except as required for reasonable and customary use in describing the
149
-      origin of the Work and reproducing the content of the NOTICE file.
150
-
151
-   7. Disclaimer of Warranty. Unless required by applicable law or
152
-      agreed to in writing, Licensor provides the Work (and each
153
-      Contributor provides its Contributions) on an "AS IS" BASIS,
154
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
155
-      implied, including, without limitation, any warranties or conditions
156
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
157
-      PARTICULAR PURPOSE. You are solely responsible for determining the
158
-      appropriateness of using or redistributing the Work and assume any
159
-      risks associated with Your exercise of permissions under this License.
160
-
161
-   8. Limitation of Liability. In no event and under no legal theory,
162
-      whether in tort (including negligence), contract, or otherwise,
163
-      unless required by applicable law (such as deliberate and grossly
164
-      negligent acts) or agreed to in writing, shall any Contributor be
165
-      liable to You for damages, including any direct, indirect, special,
166
-      incidental, or consequential damages of any character arising as a
167
-      result of this License or out of the use or inability to use the
168
-      Work (including but not limited to damages for loss of goodwill,
169
-      work stoppage, computer failure or malfunction, or any and all
170
-      other commercial damages or losses), even if such Contributor
171
-      has been advised of the possibility of such damages.
172
-
173
-   9. Accepting Warranty or Additional Liability. While redistributing
174
-      the Work or Derivative Works thereof, You may choose to offer,
175
-      and charge a fee for, acceptance of support, warranty, indemnity,
176
-      or other liability obligations and/or rights consistent with this
177
-      License. However, in accepting such obligations, You may act only
178
-      on Your own behalf and on Your sole responsibility, not on behalf
179
-      of any other Contributor, and only if You agree to indemnify,
180
-      defend, and hold each Contributor harmless for any liability
181
-      incurred by, or claims asserted against, such Contributor by reason
182
-      of your accepting any such warranty or additional liability.
183
-
184
-   END OF TERMS AND CONDITIONS
185
-
186
-   APPENDIX: How to apply the Apache License to your work.
187
-
188
-      To apply the Apache License to your work, attach the following
189
-      boilerplate notice, with the fields enclosed by brackets "[]"
190
-      replaced with your own identifying information. (Don't include
191
-      the brackets!) The text should be enclosed in the appropriate
192
-      comment syntax for the file format. We also recommend that a
193
-      file or class name and description of purpose be included on the
194
-      same "printed page" as the copyright notice for easier
195
-      identification within third-party archives.
196
-
197
-   Copyright 2012 DotCloud Inc (opensource@dotcloud.com)
198
-
199
-   Licensed under the Apache License, Version 2.0 (the "License");
200
-   you may not use this file except in compliance with the License.
201
-   You may obtain a copy of the License at
202
-
203
-       http://www.apache.org/licenses/LICENSE-2.0
204
-
205
-   Unless required by applicable law or agreed to in writing, software
206
-   distributed under the License is distributed on an "AS IS" BASIS,
207
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
208
-   See the License for the specific language governing permissions and
209
-   limitations under the License.
210 1
deleted file mode 100644
... ...
@@ -1 +0,0 @@
1
-README.md
2 1
deleted file mode 100755
... ...
@@ -1,13 +0,0 @@
1
-#!/usr/bin/make -f
2
-# -*- makefile -*-
3
-# Sample debian/rules that uses debhelper.
4
-# This file was originally written by Joey Hess and Craig Small.
5
-# As a special exception, when this file is copied by dh-make into a
6
-# dh-make output file, you may use that output file without restriction.
7
-# This special exception was added by Craig Small in version 0.37 of dh-make.
8
-
9
-# Uncomment this to turn on verbose mode.
10
-#export DH_VERBOSE=1
11
-
12
-%:
13
-	dh $@
14 1
deleted file mode 100644
... ...
@@ -1 +0,0 @@
1
-3.0 (quilt)
2 1
deleted file mode 100644
... ...
@@ -1,10 +0,0 @@
1
-description     "Run docker"
2
-
3
-start on runlevel [2345]
4
-stop on starting rc RUNLEVEL=[016]
5
-respawn
6
-
7
-script
8
-    test -f /etc/default/locale && . /etc/default/locale || true
9
-    LANG=$LANG LC_ALL=$LANG /usr/bin/docker -d
10
-end script
11 1
deleted file mode 100644
... ...
@@ -1,10 +0,0 @@
1
-description     "Run docker"
2
-
3
-start on runlevel [2345]
4
-stop on starting rc RUNLEVEL=[016]
5
-respawn
6
-
7
-script
8
-    test -f /etc/default/locale && . /etc/default/locale || true
9
-    LANG=$LANG LC_ALL=$LANG /usr/bin/docker -d
10
-end script
11 1
new file mode 100644
... ...
@@ -0,0 +1,73 @@
0
+PKG_NAME=lxc-docker
1
+PKG_ARCH=amd64
2
+PKG_VERSION=1
3
+ROOT_PATH:=$(PWD)
4
+BUILD_PATH=build	# Do not change, decided by dpkg-buildpackage
5
+BUILD_SRC=build_src
6
+GITHUB_PATH=src/github.com/dotcloud/docker
7
+INSDIR=usr/bin
8
+SOURCE_PACKAGE=$(PKG_NAME)_$(PKG_VERSION).orig.tar.gz
9
+DEB_PACKAGE=$(PKG_NAME)_$(PKG_VERSION)_$(PKG_ARCH).deb
10
+EXTRA_GO_PKG=./auth
11
+
12
+TMPDIR=$(shell mktemp -d -t XXXXXX)
13
+
14
+
15
+# Build a debian source package
16
+all: clean build_in_deb
17
+
18
+build_in_deb:
19
+	echo "GOPATH = " $(ROOT_PATH)
20
+	mkdir bin
21
+	cd $(GITHUB_PATH)/docker; GOPATH=$(ROOT_PATH) go build -o $(ROOT_PATH)/bin/docker
22
+
23
+# DESTDIR provided by Debian packaging
24
+install:
25
+	# Call this from a go environment (as packaged for deb source package)
26
+	mkdir -p $(DESTDIR)/$(INSDIR)
27
+	mkdir -p $(DESTDIR)/etc/init
28
+	install -m 0755 bin/docker $(DESTDIR)/$(INSDIR)
29
+	install -o root -m 0755 etc/docker.upstart $(DESTDIR)/etc/init/docker.conf
30
+
31
+$(BUILD_SRC): clean
32
+	# Copy ourselves into $BUILD_SRC to comply with unusual golang constraints
33
+	tar --exclude=*.tar.gz --exclude=checkout.tgz -f checkout.tgz -cz *
34
+	mkdir -p $(BUILD_SRC)/$(GITHUB_PATH)
35
+	tar -f checkout.tgz -C $(BUILD_SRC)/$(GITHUB_PATH) -xz
36
+	cd $(BUILD_SRC)/$(GITHUB_PATH)/docker; GOPATH=$(ROOT_PATH)/$(BUILD_SRC) go get -d
37
+	for d in `find $(BUILD_SRC) -name '.git*'`; do rm -rf $$d; done
38
+	# Populate source build with debian stuff
39
+	cp -R -L ./deb/* $(BUILD_SRC)
40
+
41
+$(SOURCE_PACKAGE): $(BUILD_SRC)
42
+	rm -f $(SOURCE_PACKAGE)
43
+	# Create the debian source package
44
+	tar -f $(SOURCE_PACKAGE) -C ${ROOT_PATH}/${BUILD_SRC} -cz .
45
+
46
+# Build deb package fetching go dependencies and cleaning up git repositories
47
+deb: $(DEB_PACKAGE)
48
+
49
+$(DEB_PACKAGE): $(SOURCE_PACKAGE)
50
+	# dpkg-buildpackage looks for source package tarball in ../
51
+	cd $(BUILD_SRC); dpkg-buildpackage
52
+	rm -rf $(BUILD_PATH) debian/$(PKG_NAME)* debian/files
53
+
54
+debsrc: $(SOURCE_PACKAGE)
55
+
56
+# Build local sources
57
+#$(PKG_NAME): build_local
58
+
59
+build_local:
60
+	-@mkdir -p bin
61
+	cd docker && go build -o ../bin/docker
62
+
63
+gotest:
64
+	@echo "\033[36m[Testing]\033[00m docker..."
65
+	@sudo -E GOPATH=$(ROOT_PATH)/$(BUILD_SRC) go test -v . $(EXTRA_GO_PKG) && \
66
+		echo -n "\033[32m[OK]\033[00m" || \
67
+		echo -n "\033[31m[FAIL]\033[00m"; \
68
+		echo " docker"
69
+	@sudo rm -rf /tmp/docker-*
70
+
71
+clean:
72
+	rm -rf $(BUILD_PATH) debian/$(PKG_NAME)* debian/files $(BUILD_SRC) checkout.tgz bin
0 73
new file mode 100644
... ...
@@ -0,0 +1,339 @@
0
+Docker: the Linux container runtime
1
+===================================
2
+
3
+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.
4
+
5
+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.
6
+
7
+<img src="http://bricks.argz.com/bricksfiles/lego/07000/7823/012.jpg"/>
8
+
9
+* *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.
10
+
11
+* *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.
12
+
13
+* *Isolation*: docker isolates processes from each other and from the underlying host, using lightweight containers.
14
+
15
+* *Repeatability*: because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run.
16
+
17
+
18
+Notable features
19
+-----------------
20
+
21
+* Filesystem isolation: each process container runs in a completely separate root filesystem.
22
+
23
+* Resource isolation: system resources like cpu and memory can be allocated differently to each process container, using cgroups.
24
+
25
+* Network isolation: each process container runs in its own network namespace, with a virtual interface and IP address of its own.
26
+
27
+* Copy-on-write: root filesystems are created using copy-on-write, which makes deployment extremeley fast, memory-cheap and disk-cheap.
28
+
29
+* Logging: the standard streams (stdout/stderr/stdin) of each process container are collected and logged for real-time or batch retrieval.
30
+
31
+* 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.
32
+
33
+* 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.
34
+
35
+
36
+
37
+Under the hood
38
+--------------
39
+
40
+Under the hood, Docker is built on the following components:
41
+
42
+
43
+* 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;
44
+
45
+* [AUFS](http://aufs.sourceforge.net/aufs.html), a powerful union filesystem with copy-on-write capabilities;
46
+
47
+* The [Go](http://golang.org) programming language;
48
+
49
+* [lxc](http://lxc.sourceforge.net/), a set of convenience scripts to simplify the creation of linux containers.
50
+
51
+
52
+Install instructions
53
+==================
54
+
55
+Installing on Ubuntu 12.04 and 12.10
56
+------------------------------------
57
+
58
+1. Install dependencies:
59
+
60
+    ```bash
61
+    sudo apt-get install lxc wget bsdtar curl
62
+    sudo apt-get install linux-image-extra-`uname -r`
63
+    ```
64
+
65
+    The `linux-image-extra` package is needed on standard Ubuntu EC2 AMIs in order to install the aufs kernel module.
66
+
67
+2. Install the latest docker binary:
68
+
69
+    ```bash
70
+    wget http://get.docker.io/builds/$(uname -s)/$(uname -m)/docker-master.tgz
71
+    tar -xf docker-master.tgz
72
+    ```
73
+
74
+3. Run your first container!
75
+
76
+    ```bash
77
+    cd docker-master
78
+    sudo ./docker run -i -t base /bin/bash
79
+    ```
80
+
81
+    Consider adding docker to your `PATH` for simplicity.
82
+
83
+Installing on other Linux distributions
84
+---------------------------------------
85
+
86
+Right now, the officially supported distributions are:
87
+
88
+* Ubuntu 12.04 (precise LTS)
89
+* Ubuntu 12.10 (quantal)
90
+
91
+Docker probably works on other distributions featuring a recent kernel, the AUFS patch, and up-to-date lxc. However this has not been tested.
92
+
93
+Installing with Vagrant
94
+-----------------------
95
+
96
+Currently, Docker can be installed with Vagrant both on your localhost
97
+with VirtualBox as well as on Amazon EC2. Vagrant 1.1 is required for
98
+EC2, but deploying is as simple as:
99
+
100
+```bash
101
+$ export AWS_ACCESS_KEY_ID=xxx \
102
+	AWS_SECRET_ACCESS_KEY=xxx \
103
+	AWS_KEYPAIR_NAME=xxx \
104
+	AWS_SSH_PRIVKEY=xxx
105
+$ vagrant plugin install vagrant-aws
106
+$ vagrant up --provider=aws
107
+```
108
+
109
+The environment variables are:
110
+
111
+* `AWS_ACCESS_KEY_ID` - The API key used to make requests to AWS
112
+* `AWS_SECRET_ACCESS_KEY` - The secret key to make AWS API requests
113
+* `AWS_KEYPAIR_NAME` - The name of the keypair used for this EC2 instance
114
+* `AWS_SSH_PRIVKEY` - The path to the private key for the named keypair
115
+
116
+For VirtualBox, you can simply ignore setting any of the environment
117
+variables and omit the `provider` flag. VirtualBox is still supported with
118
+Vagrant &lt;= 1.1:
119
+
120
+```bash
121
+$ vagrant up
122
+```
123
+
124
+
125
+
126
+Usage examples
127
+==============
128
+
129
+Running an interactive shell
130
+----------------------------
131
+
132
+```bash
133
+# Download a base image
134
+docker pull base
135
+
136
+# Run an interactive shell in the base image,
137
+# allocate a tty, attach stdin and stdout
138
+docker run -i -t base /bin/bash
139
+```
140
+
141
+
142
+Starting a long-running worker process
143
+--------------------------------------
144
+
145
+```bash
146
+# Run docker in daemon mode
147
+(docker -d || echo "Docker daemon already running") &
148
+
149
+# Start a very useful long-running process
150
+JOB=$(docker run -d base /bin/sh -c "while true; do echo Hello world; sleep 1; done")
151
+
152
+# Collect the output of the job so far
153
+docker logs $JOB
154
+
155
+# Kill the job
156
+docker kill $JOB
157
+```
158
+
159
+
160
+Listing all running containers
161
+------------------------------
162
+
163
+```bash
164
+docker ps
165
+```
166
+
167
+
168
+Expose a service on a TCP port
169
+------------------------------
170
+
171
+```bash
172
+# Expose port 4444 of this container, and tell netcat to listen on it
173
+JOB=$(docker run -d -p 4444 base /bin/nc -l -p 4444)
174
+
175
+# Which public port is NATed to my container?
176
+PORT=$(docker port $JOB 4444)
177
+
178
+# Connect to the public port via the host's public address
179
+echo hello world | nc $(hostname) $PORT
180
+
181
+# Verify that the network connection worked
182
+echo "Daemon received: $(docker logs $JOB)"
183
+```
184
+
185
+Contributing to Docker
186
+======================
187
+
188
+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.
189
+
190
+Contribution guidelines
191
+-----------------------
192
+
193
+### Pull requests are always welcome
194
+
195
+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.
196
+
197
+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.
198
+
199
+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.
200
+However, there might be a way to implement that feature *on top of* docker.
201
+
202
+### Discuss your design on the mailing list
203
+
204
+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
205
+you in the right direction, give feedback on your design, and maybe point out if someone else is working on the same thing.
206
+
207
+### Create issues...
208
+
209
+Any significant improvement should be documented as [a github issue](https://github.com/dotcloud/docker/issues) before anybody starts working on it.
210
+
211
+### ...but check for existing issues first!
212
+
213
+Please take a moment to check that an issue doesn't already exist documenting your bug report or improvement proposal.
214
+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.
215
+
216
+
217
+### Write tests
218
+
219
+Golang has a great testing suite built in: use it! Take a look at existing tests for inspiration.
220
+
221
+
222
+
223
+Setting up a dev environment
224
+----------------------------
225
+
226
+Instructions that have been verified to work on Ubuntu 12.10,
227
+
228
+```bash
229
+sudo apt-get -y install lxc wget bsdtar curl golang git
230
+
231
+export GOPATH=~/go/
232
+export PATH=$GOPATH/bin:$PATH
233
+
234
+mkdir -p $GOPATH/src/github.com/dotcloud
235
+cd $GOPATH/src/github.com/dotcloud
236
+git clone git@github.com:dotcloud/docker.git
237
+cd docker
238
+
239
+go get -v github.com/dotcloud/docker/...
240
+go install -v github.com/dotcloud/docker/...
241
+```
242
+
243
+Then run the docker daemon,
244
+
245
+```bash
246
+sudo $GOPATH/bin/docker -d
247
+```
248
+
249
+Run the `go install` command (above) to recompile docker.
250
+
251
+
252
+What is a Standard Container?
253
+=============================
254
+
255
+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
256
+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.
257
+
258
+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.
259
+
260
+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.
261
+
262
+### 1. STANDARD OPERATIONS
263
+
264
+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.
265
+
266
+
267
+### 2. CONTENT-AGNOSTIC
268
+
269
+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.
270
+
271
+
272
+### 3. INFRASTRUCTURE-AGNOSTIC
273
+
274
+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.
275
+
276
+
277
+### 4. DESIGNED FOR AUTOMATION
278
+
279
+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.
280
+
281
+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.
282
+
283
+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.
284
+
285
+
286
+### 5. INDUSTRIAL-GRADE DELIVERY
287
+
288
+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.
289
+
290
+With Standard Containers we can put an end to that embarrassment, by making INDUSTRIAL-GRADE DELIVERY of software a reality.
291
+
292
+
293
+
294
+
295
+Standard Container Specification
296
+--------------------------------
297
+
298
+(TODO)
299
+
300
+### Image format
301
+
302
+
303
+### Standard operations
304
+
305
+* Copy
306
+* Run
307
+* Stop
308
+* Wait
309
+* Commit
310
+* Attach standard streams
311
+* List filesystem changes
312
+* ...
313
+
314
+### Execution environment
315
+
316
+#### Root filesystem
317
+
318
+#### Environment variables
319
+
320
+#### Process arguments
321
+
322
+#### Networking
323
+
324
+#### Process namespacing
325
+
326
+#### Resource limits
327
+
328
+#### Process monitoring
329
+
330
+#### Logging
331
+
332
+#### Signals
333
+
334
+#### Pseudo-terminal allocation
335
+
336
+#### Security
337
+
338
+
0 339
new file mode 100644
... ...
@@ -0,0 +1,5 @@
0
+lxc-docker (1) precise; urgency=low
1
+
2
+  * Initial release
3
+
4
+ -- dotCloud <ops@dotcloud.com>  Mon, 25 Mar 2013 05:51:12 -0700
0 5
new file mode 100644
... ...
@@ -0,0 +1 @@
0
+8
0 1
new file mode 100644
... ...
@@ -0,0 +1,19 @@
0
+Source: lxc-docker
1
+Section: misc
2
+Priority: extra
3
+Homepage: http://docker.io
4
+Maintainer: Daniel Mizyrycki <daniel@dotcloud.com>
5
+Build-Depends: debhelper (>= 8.0.0), pkg-config, git, golang, libsqlite3-dev
6
+Vcs-Git: http://github.com/dotcloud/docker.git
7
+Standards-Version: 3.9.3
8
+
9
+Package: lxc-docker
10
+Architecture: amd64
11
+Depends: ${shlibs:Depends}, ${misc:Depends}, lxc, wget, bsdtar, curl, sqlite3
12
+Conflicts: docker
13
+Description: A process manager with superpowers
14
+    It encapsulates heterogeneous payloads in Standard Containers, and runs
15
+    them on any server with strong guarantees of isolation and repeatability.
16
+    Is is a great building block for automating distributed systems:
17
+    large-scale web deployments, database clusters, continuous deployment
18
+    systems, private PaaS, service-oriented architectures, etc.
0 19
new file mode 100644
... ...
@@ -0,0 +1,209 @@
0
+Format: http://dep.debian.net/deps/dep5
1
+Upstream-Name: docker
2
+Source: https://github.com/dotcloud/docker
3
+
4
+Files: *
5
+Copyright: 2012 DotCloud Inc (opensource@dotcloud.com)
6
+License: Apache License Version 2.0
7
+
8
+                                Apache License
9
+                           Version 2.0, January 2004
10
+                        http://www.apache.org/licenses/
11
+
12
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
13
+
14
+   1. Definitions.
15
+
16
+      "License" shall mean the terms and conditions for use, reproduction,
17
+      and distribution as defined by Sections 1 through 9 of this document.
18
+
19
+      "Licensor" shall mean the copyright owner or entity authorized by
20
+      the copyright owner that is granting the License.
21
+
22
+      "Legal Entity" shall mean the union of the acting entity and all
23
+      other entities that control, are controlled by, or are under common
24
+      control with that entity. For the purposes of this definition,
25
+      "control" means (i) the power, direct or indirect, to cause the
26
+      direction or management of such entity, whether by contract or
27
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
28
+      outstanding shares, or (iii) beneficial ownership of such entity.
29
+
30
+      "You" (or "Your") shall mean an individual or Legal Entity
31
+      exercising permissions granted by this License.
32
+
33
+      "Source" form shall mean the preferred form for making modifications,
34
+      including but not limited to software source code, documentation
35
+      source, and configuration files.
36
+
37
+      "Object" form shall mean any form resulting from mechanical
38
+      transformation or translation of a Source form, including but
39
+      not limited to compiled object code, generated documentation,
40
+      and conversions to other media types.
41
+
42
+      "Work" shall mean the work of authorship, whether in Source or
43
+      Object form, made available under the License, as indicated by a
44
+      copyright notice that is included in or attached to the work
45
+      (an example is provided in the Appendix below).
46
+
47
+      "Derivative Works" shall mean any work, whether in Source or Object
48
+      form, that is based on (or derived from) the Work and for which the
49
+      editorial revisions, annotations, elaborations, or other modifications
50
+      represent, as a whole, an original work of authorship. For the purposes
51
+      of this License, Derivative Works shall not include works that remain
52
+      separable from, or merely link (or bind by name) to the interfaces of,
53
+      the Work and Derivative Works thereof.
54
+
55
+      "Contribution" shall mean any work of authorship, including
56
+      the original version of the Work and any modifications or additions
57
+      to that Work or Derivative Works thereof, that is intentionally
58
+      submitted to Licensor for inclusion in the Work by the copyright owner
59
+      or by an individual or Legal Entity authorized to submit on behalf of
60
+      the copyright owner. For the purposes of this definition, "submitted"
61
+      means any form of electronic, verbal, or written communication sent
62
+      to the Licensor or its representatives, including but not limited to
63
+      communication on electronic mailing lists, source code control systems,
64
+      and issue tracking systems that are managed by, or on behalf of, the
65
+      Licensor for the purpose of discussing and improving the Work, but
66
+      excluding communication that is conspicuously marked or otherwise
67
+      designated in writing by the copyright owner as "Not a Contribution."
68
+
69
+      "Contributor" shall mean Licensor and any individual or Legal Entity
70
+      on behalf of whom a Contribution has been received by Licensor and
71
+      subsequently incorporated within the Work.
72
+
73
+   2. Grant of Copyright License. Subject to the terms and conditions of
74
+      this License, each Contributor hereby grants to You a perpetual,
75
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+      copyright license to reproduce, prepare Derivative Works of,
77
+      publicly display, publicly perform, sublicense, and distribute the
78
+      Work and such Derivative Works in Source or Object form.
79
+
80
+   3. Grant of Patent License. Subject to the terms and conditions of
81
+      this License, each Contributor hereby grants to You a perpetual,
82
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83
+      (except as stated in this section) patent license to make, have made,
84
+      use, offer to sell, sell, import, and otherwise transfer the Work,
85
+      where such license applies only to those patent claims licensable
86
+      by such Contributor that are necessarily infringed by their
87
+      Contribution(s) alone or by combination of their Contribution(s)
88
+      with the Work to which such Contribution(s) was submitted. If You
89
+      institute patent litigation against any entity (including a
90
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
91
+      or a Contribution incorporated within the Work constitutes direct
92
+      or contributory patent infringement, then any patent licenses
93
+      granted to You under this License for that Work shall terminate
94
+      as of the date such litigation is filed.
95
+
96
+   4. Redistribution. You may reproduce and distribute copies of the
97
+      Work or Derivative Works thereof in any medium, with or without
98
+      modifications, and in Source or Object form, provided that You
99
+      meet the following conditions:
100
+
101
+      (a) You must give any other recipients of the Work or
102
+          Derivative Works a copy of this License; and
103
+
104
+      (b) You must cause any modified files to carry prominent notices
105
+          stating that You changed the files; and
106
+
107
+      (c) You must retain, in the Source form of any Derivative Works
108
+          that You distribute, all copyright, patent, trademark, and
109
+          attribution notices from the Source form of the Work,
110
+          excluding those notices that do not pertain to any part of
111
+          the Derivative Works; and
112
+
113
+      (d) If the Work includes a "NOTICE" text file as part of its
114
+          distribution, then any Derivative Works that You distribute must
115
+          include a readable copy of the attribution notices contained
116
+          within such NOTICE file, excluding those notices that do not
117
+          pertain to any part of the Derivative Works, in at least one
118
+          of the following places: within a NOTICE text file distributed
119
+          as part of the Derivative Works; within the Source form or
120
+          documentation, if provided along with the Derivative Works; or,
121
+          within a display generated by the Derivative Works, if and
122
+          wherever such third-party notices normally appear. The contents
123
+          of the NOTICE file are for informational purposes only and
124
+          do not modify the License. You may add Your own attribution
125
+          notices within Derivative Works that You distribute, alongside
126
+          or as an addendum to the NOTICE text from the Work, provided
127
+          that such additional attribution notices cannot be construed
128
+          as modifying the License.
129
+
130
+      You may add Your own copyright statement to Your modifications and
131
+      may provide additional or different license terms and conditions
132
+      for use, reproduction, or distribution of Your modifications, or
133
+      for any such Derivative Works as a whole, provided Your use,
134
+      reproduction, and distribution of the Work otherwise complies with
135
+      the conditions stated in this License.
136
+
137
+   5. Submission of Contributions. Unless You explicitly state otherwise,
138
+      any Contribution intentionally submitted for inclusion in the Work
139
+      by You to the Licensor shall be under the terms and conditions of
140
+      this License, without any additional terms or conditions.
141
+      Notwithstanding the above, nothing herein shall supersede or modify
142
+      the terms of any separate license agreement you may have executed
143
+      with Licensor regarding such Contributions.
144
+
145
+   6. Trademarks. This License does not grant permission to use the trade
146
+      names, trademarks, service marks, or product names of the Licensor,
147
+      except as required for reasonable and customary use in describing the
148
+      origin of the Work and reproducing the content of the NOTICE file.
149
+
150
+   7. Disclaimer of Warranty. Unless required by applicable law or
151
+      agreed to in writing, Licensor provides the Work (and each
152
+      Contributor provides its Contributions) on an "AS IS" BASIS,
153
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
154
+      implied, including, without limitation, any warranties or conditions
155
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
156
+      PARTICULAR PURPOSE. You are solely responsible for determining the
157
+      appropriateness of using or redistributing the Work and assume any
158
+      risks associated with Your exercise of permissions under this License.
159
+
160
+   8. Limitation of Liability. In no event and under no legal theory,
161
+      whether in tort (including negligence), contract, or otherwise,
162
+      unless required by applicable law (such as deliberate and grossly
163
+      negligent acts) or agreed to in writing, shall any Contributor be
164
+      liable to You for damages, including any direct, indirect, special,
165
+      incidental, or consequential damages of any character arising as a
166
+      result of this License or out of the use or inability to use the
167
+      Work (including but not limited to damages for loss of goodwill,
168
+      work stoppage, computer failure or malfunction, or any and all
169
+      other commercial damages or losses), even if such Contributor
170
+      has been advised of the possibility of such damages.
171
+
172
+   9. Accepting Warranty or Additional Liability. While redistributing
173
+      the Work or Derivative Works thereof, You may choose to offer,
174
+      and charge a fee for, acceptance of support, warranty, indemnity,
175
+      or other liability obligations and/or rights consistent with this
176
+      License. However, in accepting such obligations, You may act only
177
+      on Your own behalf and on Your sole responsibility, not on behalf
178
+      of any other Contributor, and only if You agree to indemnify,
179
+      defend, and hold each Contributor harmless for any liability
180
+      incurred by, or claims asserted against, such Contributor by reason
181
+      of your accepting any such warranty or additional liability.
182
+
183
+   END OF TERMS AND CONDITIONS
184
+
185
+   APPENDIX: How to apply the Apache License to your work.
186
+
187
+      To apply the Apache License to your work, attach the following
188
+      boilerplate notice, with the fields enclosed by brackets "[]"
189
+      replaced with your own identifying information. (Don't include
190
+      the brackets!) The text should be enclosed in the appropriate
191
+      comment syntax for the file format. We also recommend that a
192
+      file or class name and description of purpose be included on the
193
+      same "printed page" as the copyright notice for easier
194
+      identification within third-party archives.
195
+
196
+   Copyright 2012 DotCloud Inc (opensource@dotcloud.com)
197
+
198
+   Licensed under the Apache License, Version 2.0 (the "License");
199
+   you may not use this file except in compliance with the License.
200
+   You may obtain a copy of the License at
201
+
202
+       http://www.apache.org/licenses/LICENSE-2.0
203
+
204
+   Unless required by applicable law or agreed to in writing, software
205
+   distributed under the License is distributed on an "AS IS" BASIS,
206
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
207
+   See the License for the specific language governing permissions and
208
+   limitations under the License.
0 209
new file mode 100644
... ...
@@ -0,0 +1 @@
0
+README.md
0 1
new file mode 100755
... ...
@@ -0,0 +1,13 @@
0
+#!/usr/bin/make -f
1
+# -*- makefile -*-
2
+# Sample debian/rules that uses debhelper.
3
+# This file was originally written by Joey Hess and Craig Small.
4
+# As a special exception, when this file is copied by dh-make into a
5
+# dh-make output file, you may use that output file without restriction.
6
+# This special exception was added by Craig Small in version 0.37 of dh-make.
7
+
8
+# Uncomment this to turn on verbose mode.
9
+#export DH_VERBOSE=1
10
+
11
+%:
12
+	dh $@
0 13
new file mode 100644
... ...
@@ -0,0 +1 @@
0
+3.0 (quilt)
0 1
new file mode 100644
... ...
@@ -0,0 +1,10 @@
0
+description     "Run docker"
1
+
2
+start on runlevel [2345]
3
+stop on starting rc RUNLEVEL=[016]
4
+respawn
5
+
6
+script
7
+    test -f /etc/default/locale && . /etc/default/locale || true
8
+    LANG=$LANG LC_ALL=$LANG /usr/bin/docker -d
9
+end script