From a22d73d8b018ac79dd6e3a4c95b1734b5fdcc007 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Thu, 13 Jun 2013 17:53:38 -0700 Subject: [PATCH 01/18] Remove bsdtar by checking magic Upstream-commit: 0425f65e6373dc38cd18a6d0f2a50671544ad4b2 Component: engine --- components/engine/archive.go | 48 +++++++++++++++++++++++++++++++++--- 1 file changed, 45 insertions(+), 3 deletions(-) diff --git a/components/engine/archive.go b/components/engine/archive.go index 06466627a1..5686408179 100644 --- a/components/engine/archive.go +++ b/components/engine/archive.go @@ -1,8 +1,10 @@ package docker import ( + "bytes" "errors" "fmt" + "github.com/dotcloud/docker/utils" "io" "io/ioutil" "os" @@ -20,6 +22,37 @@ const ( Xz ) +func DetectCompression(source []byte) Compression { + for _, c := range source[:10] { + utils.Debugf("%x", c) + } + + sourceLen := len(source) + for compression, m := range map[Compression][]byte{ + Bzip2: {0x42, 0x5A, 0x68}, + Gzip: {0x1F, 0x8B, 0x08}, + Xz: {0xFD, 0x37, 0x7A, 0x58, 0x5A, 0x00}, + } { + fail := false + if len(m) > sourceLen { + utils.Debugf("Len too short") + continue + } + i := 0 + for _, b := range m { + if b != source[i] { + fail = true + break + } + i++ + } + if !fail { + return compression + } + } + return Uncompressed +} + func (compression *Compression) Flag() string { switch *compression { case Bzip2: @@ -47,12 +80,21 @@ func (compression *Compression) Extension() string { } func Tar(path string, compression Compression) (io.Reader, error) { - cmd := exec.Command("bsdtar", "-f", "-", "-C", path, "-c"+compression.Flag(), ".") - return CmdStream(cmd) + return CmdStream(exec.Command("tar", "-f", "-", "-C", path, "-c"+compression.Flag(), ".")) } func Untar(archive io.Reader, path string) error { - cmd := exec.Command("bsdtar", "-f", "-", "-C", path, "-x") + + buf := make([]byte, 10) + if _, err := archive.Read(buf); err != nil { + return err + } + compression := DetectCompression(buf) + archive = io.MultiReader(bytes.NewReader(buf), archive) + + utils.Debugf("Archive compression detected: %s", compression.Extension()) + + cmd := exec.Command("tar", "-f", "-", "-C", path, "-x"+compression.Flag()) cmd.Stdin = archive // Hardcode locale environment for predictable outcome regardless of host configuration. // (see https://github.com/dotcloud/docker/issues/355) From c803fc1f04e28ad9ff6095858506890ba6293b75 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Fri, 14 Jun 2013 10:47:49 -0700 Subject: [PATCH 02/18] Add unit tests for tar/untar with multiple compression + detection Upstream-commit: 6f7de49aa8771ef4bc35548f9aa07fee660f1844 Component: engine --- components/engine/archive_test.go | 51 ++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 5 deletions(-) diff --git a/components/engine/archive_test.go b/components/engine/archive_test.go index f583604497..bb4235ad5b 100644 --- a/components/engine/archive_test.go +++ b/components/engine/archive_test.go @@ -1,10 +1,13 @@ package docker import ( + "bytes" + "fmt" "io" "io/ioutil" "os" "os/exec" + "path" "testing" "time" ) @@ -58,20 +61,58 @@ func TestCmdStreamGood(t *testing.T) { } } -func TestTarUntar(t *testing.T) { - archive, err := Tar(".", Uncompressed) +func tarUntar(t *testing.T, origin string, compression Compression) error { + archive, err := Tar(origin, compression) if err != nil { t.Fatal(err) } + + buf := make([]byte, 10) + if _, err := archive.Read(buf); err != nil { + return err + } + archive = io.MultiReader(bytes.NewReader(buf), archive) + + detectedCompression := DetectCompression(buf) + if detectedCompression.Extension() != compression.Extension() { + return fmt.Errorf("Wrong compression detected. Actual compression: %s, found %s", compression.Extension(), detectedCompression.Extension()) + } + tmp, err := ioutil.TempDir("", "docker-test-untar") if err != nil { - t.Fatal(err) + return err } defer os.RemoveAll(tmp) if err := Untar(archive, tmp); err != nil { - t.Fatal(err) + return err } if _, err := os.Stat(tmp); err != nil { - t.Fatalf("Error stating %s: %s", tmp, err.Error()) + return err + } + return nil +} + +func TestTarUntar(t *testing.T) { + origin, err := ioutil.TempDir("", "docker-test-untar-origin") + if err != nil { + t.Fatal(err) + } + defer os.RemoveAll(origin) + if err := ioutil.WriteFile(path.Join(origin, "1"), []byte("hello world"), 0700); err != nil { + t.Fatal(err) + } + if err := ioutil.WriteFile(path.Join(origin, "2"), []byte("welcome!"), 0700); err != nil { + t.Fatal(err) + } + + for _, c := range []Compression{ + Uncompressed, + Gzip, + Bzip2, + Xz, + } { + if err := tarUntar(t, origin, c); err != nil { + t.Fatalf("Error tar/untar for compression %s: %s", c.Extension(), err) + } } } From f73437e29d72d0331c748f4a987adbfb410ca55a Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Fri, 14 Jun 2013 10:58:16 -0700 Subject: [PATCH 03/18] Update docs Upstream-commit: 79fe864d9a117193b4dce8b7fe156a55bbadcce6 Component: engine --- components/engine/README.md | 2 +- components/engine/docs/sources/contributing/devenvironment.rst | 2 +- components/engine/docs/sources/installation/binaries.rst | 3 +-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/components/engine/README.md b/components/engine/README.md index 1c909e5431..d15ee3cc41 100644 --- a/components/engine/README.md +++ b/components/engine/README.md @@ -262,7 +262,7 @@ 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 +sudo apt-get -y install lxc curl xz-utils golang git export GOPATH=~/go/ export PATH=$GOPATH/bin:$PATH diff --git a/components/engine/docs/sources/contributing/devenvironment.rst b/components/engine/docs/sources/contributing/devenvironment.rst index 5d937c5a44..8b26688bcf 100644 --- a/components/engine/docs/sources/contributing/devenvironment.rst +++ b/components/engine/docs/sources/contributing/devenvironment.rst @@ -33,7 +33,7 @@ Installation sudo apt-get install python-software-properties sudo add-apt-repository ppa:gophers/go sudo apt-get update - sudo apt-get -y install lxc wget bsdtar curl golang-stable git + sudo apt-get -y install lxc xz-utils curl golang-stable git export GOPATH=~/go/ export PATH=$GOPATH/bin:$PATH diff --git a/components/engine/docs/sources/installation/binaries.rst b/components/engine/docs/sources/installation/binaries.rst index e7a07b6db1..6d87787752 100644 --- a/components/engine/docs/sources/installation/binaries.rst +++ b/components/engine/docs/sources/installation/binaries.rst @@ -30,8 +30,7 @@ Dependencies: * 3.8 Kernel (read more about :ref:`kernel`) * AUFS filesystem support * lxc -* bsdtar - +* xz-utils Get the docker binary: ---------------------- From 91e6023ad799fe03bbd37a93e5934d0fb6f210ab Mon Sep 17 00:00:00 2001 From: Joseph Anthony Pasquale Holsten Date: Mon, 17 Jun 2013 14:50:58 -0700 Subject: [PATCH 04/18] fix missing command in irc bouncer example Upstream-commit: 2626d88a21f639913f7f8e8b0719fd9e07cfbed4 Component: engine --- components/engine/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/engine/README.md b/components/engine/README.md index 1c909e5431..f778ff521d 100644 --- a/components/engine/README.md +++ b/components/engine/README.md @@ -181,7 +181,7 @@ Running an irc bouncer ---------------------- ```bash -BOUNCER_ID=$(docker run -d -p 6667 -u irc shykes/znc $USER $PASSWORD) +BOUNCER_ID=$(docker run -d -p 6667 -u irc shykes/znc zncrun $USER $PASSWORD) echo "Configure your irc client to connect to port $(docker port $BOUNCER_ID 6667) of this machine" ``` From fa0630fa0a0b282666e539db57700930d439bca3 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Mon, 17 Jun 2013 15:40:04 -0700 Subject: [PATCH 05/18] Move the attach prevention from server to client Upstream-commit: c106ed32ea7613573a2081d47ad2498429ac86f2 Component: engine --- components/engine/commands.go | 4 ++++ components/engine/server.go | 3 --- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/components/engine/commands.go b/components/engine/commands.go index ce15fd6cf1..4297ac0c11 100644 --- a/components/engine/commands.go +++ b/components/engine/commands.go @@ -1058,6 +1058,10 @@ func (cli *DockerCli) CmdAttach(args ...string) error { return err } + if !container.State.Running { + return fmt.Errorf("Impossible to attach to a stopped container, start it first") + } + splitStderr := container.Config.Tty connections := 1 diff --git a/components/engine/server.go b/components/engine/server.go index 30e3ec6b3a..ece6a93ceb 100644 --- a/components/engine/server.go +++ b/components/engine/server.go @@ -930,9 +930,6 @@ func (srv *Server) ContainerAttach(name string, logs, stream, stdin, stdout, std if container.State.Ghost { return fmt.Errorf("Impossible to attach to a ghost container") } - if !container.State.Running { - return fmt.Errorf("Impossible to attach to a stopped container, start it first") - } var ( cStdin io.ReadCloser From 5a843b1afc5fc7131753e0a06d17231ef255db87 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Mon, 17 Jun 2013 15:45:08 -0700 Subject: [PATCH 06/18] Remove Run race condition Upstream-commit: 2b6ca3872883dcb487d8a39a1a8530be6a62f947 Component: engine --- components/engine/commands.go | 33 ++++++--------------------------- 1 file changed, 6 insertions(+), 27 deletions(-) diff --git a/components/engine/commands.go b/components/engine/commands.go index 4297ac0c11..fb8bb528bb 100644 --- a/components/engine/commands.go +++ b/components/engine/commands.go @@ -1261,16 +1261,6 @@ func (cli *DockerCli) CmdRun(args ...string) error { fmt.Fprintln(os.Stderr, "WARNING: ", warning) } - splitStderr := !config.Tty - - connections := 0 - if config.AttachStdin || config.AttachStdout || (!splitStderr && config.AttachStderr) { - connections += 1 - } - if splitStderr && config.AttachStderr { - connections += 1 - } - //start the container _, _, err = cli.call("POST", "/containers/"+out.ID+"/start", nil) if err != nil { @@ -1279,19 +1269,12 @@ func (cli *DockerCli) CmdRun(args ...string) error { if !config.AttachStdout && !config.AttachStderr { fmt.Println(out.ID) - } - if connections > 0 { - chErrors := make(chan error, connections) + } else { + chErrors := make(chan error) if config.Tty { cli.monitorTtySize(out.ID) } - if splitStderr && config.AttachStderr { - go func() { - chErrors <- cli.hijack("POST", "/containers/"+out.ID+"/attach?logs=1&stream=1&stderr=1", config.Tty, nil, os.Stderr) - }() - } - v := url.Values{} v.Set("logs", "1") v.Set("stream", "1") @@ -1302,19 +1285,15 @@ func (cli *DockerCli) CmdRun(args ...string) error { if config.AttachStdout { v.Set("stdout", "1") } - if !splitStderr && config.AttachStderr { + if config.AttachStderr { v.Set("stderr", "1") } go func() { chErrors <- cli.hijack("POST", "/containers/"+out.ID+"/attach?"+v.Encode(), config.Tty, os.Stdin, os.Stdout) }() - for connections > 0 { - err := <-chErrors - if err != nil { - utils.Debugf("Error hijack: %s", err) - return err - } - connections -= 1 + if err := <-chErrors; err != nil { + utils.Debugf("Error hijack: %s", err) + return err } } return nil From b0870dd8c53d9d8c2c76be1a737b21b519740649 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Mon, 17 Jun 2013 18:11:58 -0700 Subject: [PATCH 07/18] Fix bug on compression detection when chunck < 10bytes Upstream-commit: 02c291d13be261f84cdfa1d51513bf4dba31ce72 Component: engine --- components/engine/archive.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/components/engine/archive.go b/components/engine/archive.go index 5686408179..1e5b683765 100644 --- a/components/engine/archive.go +++ b/components/engine/archive.go @@ -1,7 +1,7 @@ package docker import ( - "bytes" + "bufio" "errors" "fmt" "github.com/dotcloud/docker/utils" @@ -85,17 +85,17 @@ func Tar(path string, compression Compression) (io.Reader, error) { func Untar(archive io.Reader, path string) error { - buf := make([]byte, 10) - if _, err := archive.Read(buf); err != nil { + bufferedArchive := bufio.NewReaderSize(archive, 10) + buf, err := bufferedArchive.Peek(10) + if err != nil { return err } compression := DetectCompression(buf) - archive = io.MultiReader(bytes.NewReader(buf), archive) utils.Debugf("Archive compression detected: %s", compression.Extension()) cmd := exec.Command("tar", "-f", "-", "-C", path, "-x"+compression.Flag()) - cmd.Stdin = archive + cmd.Stdin = bufferedArchive // Hardcode locale environment for predictable outcome regardless of host configuration. // (see https://github.com/dotcloud/docker/issues/355) cmd.Env = []string{"LANG=en_US.utf-8", "LC_ALL=en_US.utf-8"} From 00bc56197bc749b413622665cbdffe92c447a0b0 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Mon, 17 Jun 2013 18:39:30 -0700 Subject: [PATCH 08/18] * API: Add tag lookup to history command. Fixes #882 Upstream-commit: 3bfc82257878e55141bb029390574130c3ac0530 Component: engine --- components/engine/api_params.go | 1 + components/engine/commands.go | 2 +- components/engine/server.go | 14 ++++++++++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/components/engine/api_params.go b/components/engine/api_params.go index 2a641f8ccd..c3fabb2be0 100644 --- a/components/engine/api_params.go +++ b/components/engine/api_params.go @@ -2,6 +2,7 @@ package docker type APIHistory struct { ID string `json:"Id"` + Tag string `json:",omitempty"` Created int64 CreatedBy string `json:",omitempty"` } diff --git a/components/engine/commands.go b/components/engine/commands.go index ce15fd6cf1..98be40181c 100644 --- a/components/engine/commands.go +++ b/components/engine/commands.go @@ -627,7 +627,7 @@ func (cli *DockerCli) CmdHistory(args ...string) error { fmt.Fprintln(w, "ID\tCREATED\tCREATED BY") for _, out := range outs { - fmt.Fprintf(w, "%s\t%s ago\t%s\n", out.ID, utils.HumanDuration(time.Now().Sub(time.Unix(out.Created, 0))), out.CreatedBy) + fmt.Fprintf(w, "%s (%s)\t%s ago\t%s\n", out.ID, out.Tag, utils.HumanDuration(time.Now().Sub(time.Unix(out.Created, 0))), out.CreatedBy) } w.Flush() return nil diff --git a/components/engine/server.go b/components/engine/server.go index 30e3ec6b3a..912349b82e 100644 --- a/components/engine/server.go +++ b/components/engine/server.go @@ -218,12 +218,26 @@ func (srv *Server) ImageHistory(name string) ([]APIHistory, error) { return nil, err } + lookupMap := make(map[string]string) + for name, repository := range srv.runtime.repositories.Repositories { + for tag, id := range repository { + // If the ID already has a reverse lookup, do not update it unless for "latest" + if _, exists := lookupMap[id]; exists { + if tag != "latest" { + continue + } + } + lookupMap[id] = name + ":" + tag + } + } + outs := []APIHistory{} //produce [] when empty instead of 'null' err = image.WalkHistory(func(img *Image) error { var out APIHistory out.ID = srv.runtime.repositories.ImageName(img.ShortID()) out.Created = img.Created.Unix() out.CreatedBy = strings.Join(img.ContainerConfig.Cmd, " ") + out.Tag = lookupMap[img.ID] outs = append(outs, out) return nil }) From 176d1b39a424f8a652893e826834359b1ca5c6a3 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Mon, 17 Jun 2013 18:41:13 -0700 Subject: [PATCH 09/18] Update documentation Upstream-commit: 02a002d264faa7b8cdf5c68b7370c31d6794a44d Component: engine --- components/engine/docs/sources/api/docker_remote_api_v1.2.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/components/engine/docs/sources/api/docker_remote_api_v1.2.rst b/components/engine/docs/sources/api/docker_remote_api_v1.2.rst index fb69168120..44a397a4db 100644 --- a/components/engine/docs/sources/api/docker_remote_api_v1.2.rst +++ b/components/engine/docs/sources/api/docker_remote_api_v1.2.rst @@ -691,6 +691,7 @@ Get the history of an image [ { "Id":"b750fe79269d", + "Tag":"base:latest", "Created":1364102658, "CreatedBy":"/bin/bash" }, From c44c8b06a4f3030170bfeb7782527975eab01c03 Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Mon, 17 Jun 2013 20:16:56 -0700 Subject: [PATCH 10/18] Fixed on documentation. * replaced previously removed concepts/containers and concepts/introcution by a redirect * moved orphan index/varable to workingwiththerepository * added favicon to the layout.html * added redirect_home which is a http refresh redirect. It works like a 301 for google * fixed an issue in the layout that would make it break when on small screens Upstream-commit: 3491d7d2f11246ba4067708a3c5336ba21da4767 Component: engine --- .../docs/sources/concepts/containers.rst | 8 -- .../docs/sources/concepts/introduction.rst | 125 ------------------ components/engine/docs/sources/conf.py | 24 +++- .../engine/docs/sources/index/variable.rst | 27 ---- .../sources/use/workingwithrepository.rst | 25 ++++ .../engine/docs/theme/docker/layout.html | 12 +- .../docs/theme/docker/redirect_home.html | 12 ++ .../docs/theme/docker/static/css/main.css | 10 +- .../docs/theme/docker/static/css/main.less | 29 ++-- .../docs/theme/docker/static/favicon.ico | Bin 1150 -> 0 bytes .../docs/theme/docker/static/favicon.png | Bin 0 -> 404 bytes 11 files changed, 82 insertions(+), 190 deletions(-) delete mode 100644 components/engine/docs/sources/concepts/containers.rst delete mode 100644 components/engine/docs/sources/concepts/introduction.rst delete mode 100644 components/engine/docs/sources/index/variable.rst create mode 100644 components/engine/docs/theme/docker/redirect_home.html delete mode 100755 components/engine/docs/theme/docker/static/favicon.ico create mode 100644 components/engine/docs/theme/docker/static/favicon.png diff --git a/components/engine/docs/sources/concepts/containers.rst b/components/engine/docs/sources/concepts/containers.rst deleted file mode 100644 index e08c3654c0..0000000000 --- a/components/engine/docs/sources/concepts/containers.rst +++ /dev/null @@ -1,8 +0,0 @@ -:title: Introduction -:description: An introduction to docker and standard containers? -:keywords: containers, lxc, concepts, explanation, docker, documentation - - -:note: This version of the introduction is temporary, just to make sure we don't break the links from the website when the documentation is updated - -This document has been moved to :ref:`introduction`, please update your bookmarks. \ No newline at end of file diff --git a/components/engine/docs/sources/concepts/introduction.rst b/components/engine/docs/sources/concepts/introduction.rst deleted file mode 100644 index 7251b51786..0000000000 --- a/components/engine/docs/sources/concepts/introduction.rst +++ /dev/null @@ -1,125 +0,0 @@ -:title: Introduction -:description: An introduction to docker and standard containers? -:keywords: containers, lxc, concepts, explanation - -Introduction -============ - -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. - -.. image:: images/lego_docker.jpg - - -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 dependency, regardless of the underlying machine and the contents of the container. - -The spec for Standard Containers is currently 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. - -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. - - -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. - - -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. - - -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. - - -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/docs/sources/conf.py b/components/engine/docs/sources/conf.py index d443d34052..41dba70201 100644 --- a/components/engine/docs/sources/conf.py +++ b/components/engine/docs/sources/conf.py @@ -20,6 +20,20 @@ import sys, os # -- General configuration ----------------------------------------------------- + + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# the 'redirect_home.html' page redirects using a http meta refresh which, according +# to official sources is more or less equivalent of a 301. + +html_additional_pages = { + 'concepts/containers': 'redirect_home.html', + 'concepts/introduction': 'redirect_home.html', + } + + + # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' @@ -120,7 +134,11 @@ html_theme_path = ['../theme'] # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None + +# We use a png favicon. This is not compatible with internet explorer, but looks +# much better on all other browsers. However, sphynx doesn't like it (it likes +# .ico better) so we have just put it in the template rather than used this setting +# html_favicon = 'favicon.png' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -138,10 +156,6 @@ html_static_path = ['static_files'] # Custom sidebar templates, maps document names to template names. #html_sidebars = {} -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - # If false, no module index is generated. #html_domain_indices = True diff --git a/components/engine/docs/sources/index/variable.rst b/components/engine/docs/sources/index/variable.rst deleted file mode 100644 index 90eac3af8a..0000000000 --- a/components/engine/docs/sources/index/variable.rst +++ /dev/null @@ -1,27 +0,0 @@ -:title: Index Environment Variable -:description: Setting this environment variable on the docker server will change the URL docker index. -:keywords: docker, index environment variable, documentation - -================================= -Docker Index Environment Variable -================================= - -Variable --------- - -.. code-block:: sh - - DOCKER_INDEX_URL - -Setting this environment variable on the docker server will change the URL docker index. -This address is used in commands such as ``docker login``, ``docker push`` and ``docker pull``. -The docker daemon doesn't need to be restarted for this parameter to take effect. - -Example -------- - -.. code-block:: sh - - docker -d & - export DOCKER_INDEX_URL="https://index.docker.io" - diff --git a/components/engine/docs/sources/use/workingwithrepository.rst b/components/engine/docs/sources/use/workingwithrepository.rst index 6fccc01a98..45702597ab 100644 --- a/components/engine/docs/sources/use/workingwithrepository.rst +++ b/components/engine/docs/sources/use/workingwithrepository.rst @@ -77,3 +77,28 @@ Now you can commit this image to the repository # for example docker push dhrp/kickassapp docker push + +Changing the server to connect to +---------------------------------- + +When you are running your own index and/or registry, You can change the server the docker client will connect to. + +Variable +^^^^^^^^ + +.. code-block:: sh + + DOCKER_INDEX_URL + +Setting this environment variable on the docker server will change the URL docker index. +This address is used in commands such as ``docker login``, ``docker push`` and ``docker pull``. +The docker daemon doesn't need to be restarted for this parameter to take effect. + +Example +^^^^^^^ + +.. code-block:: sh + + docker -d & + export DOCKER_INDEX_URL="https://index.docker.io" + diff --git a/components/engine/docs/theme/docker/layout.html b/components/engine/docs/theme/docker/layout.html index baaaec9155..707888a927 100755 --- a/components/engine/docs/theme/docker/layout.html +++ b/components/engine/docs/theme/docker/layout.html @@ -40,6 +40,8 @@ {%- set script_files = script_files + ['_static/js/docs.js'] %} + + {%- for cssfile in css_files %} {%- endfor %} @@ -48,9 +50,8 @@ {%- endfor %} - {%- if favicon %} - - {%- endif %} + + {%- block extrahead %}{% endblock %} @@ -104,11 +105,8 @@
-
-
- -