From df86cb9a5c949530336b43100b303876f07c69ba Mon Sep 17 00:00:00 2001 From: unclejack Date: Sat, 20 Jul 2013 13:47:13 +0300 Subject: [PATCH 01/55] make docker run handle SIGINT/SIGTERM --- commands.go | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/commands.go b/commands.go index f0e1695b3..db8a12669 100644 --- a/commands.go +++ b/commands.go @@ -1393,6 +1393,21 @@ func (cli *DockerCli) CmdRun(args ...string) error { v.Set("stderr", "1") } + signals := make(chan os.Signal, 1) + signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM) + go func() { + for { + sig := <-signals + if sig == syscall.SIGINT || sig == syscall.SIGTERM { + fmt.Printf("\nReceived signal: %s; cleaning up\n", sig) + if err := cli.CmdStop("-t", "4", runResult.ID); err != nil { + fmt.Printf("failed to stop container:", err) + } + return + } + } + }() + if err := cli.hijack("POST", "/containers/"+runResult.ID+"/attach?"+v.Encode(), config.Tty, cli.in, cli.out); err != nil { utils.Debugf("Error hijack: %s", err) return err From cd6aeaf97912a0c18994c978a4b58678e671d9ee Mon Sep 17 00:00:00 2001 From: David Calavera Date: Sat, 3 Aug 2013 15:33:51 -0700 Subject: [PATCH 02/55] Sort APIImages by most recent creation date. Fixes #985. --- server.go | 2 ++ sorter.go | 36 ++++++++++++++++++++++++++++++++++++ sorter_test.go | 30 ++++++++++++++++++++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 sorter.go create mode 100644 sorter_test.go diff --git a/server.go b/server.go index cb7b2cf1b..5e30dd011 100644 --- a/server.go +++ b/server.go @@ -241,6 +241,8 @@ func (srv *Server) Images(all bool, filter string) ([]APIImages, error) { outs = append(outs, out) } } + + sortImagesByCreation(outs) return outs, nil } diff --git a/sorter.go b/sorter.go new file mode 100644 index 000000000..a61be0ef7 --- /dev/null +++ b/sorter.go @@ -0,0 +1,36 @@ +package docker + +import "sort" + +type imageSorter struct { + images []APIImages + by func(i1, i2 *APIImages) bool // Closure used in the Less method. +} + +// Len is part of sort.Interface. +func (s *imageSorter) Len() int { + return len(s.images) +} + +// Swap is part of sort.Interface. +func (s *imageSorter) Swap(i, j int) { + s.images[i], s.images[j] = s.images[j], s.images[i] +} + +// Less is part of sort.Interface. It is implemented by calling the "by" closure in the sorter. +func (s *imageSorter) Less(i, j int) bool { + return s.by(&s.images[i], &s.images[j]) +} + +// Sort []ApiImages by most recent creation date. +func sortImagesByCreation(images []APIImages) { + creation := func(i1, i2 *APIImages) bool { + return i1.Created > i2.Created + } + + sorter := &imageSorter{ + images: images, + by: creation} + + sort.Sort(sorter) +} diff --git a/sorter_test.go b/sorter_test.go new file mode 100644 index 000000000..3c4b3b487 --- /dev/null +++ b/sorter_test.go @@ -0,0 +1,30 @@ +package docker + +import ( + "testing" +) + +func TestServerListOrderedImages(t *testing.T) { + runtime := mkRuntime(t) + defer nuke(runtime) + + archive, err := fakeTar() + if err != nil { + t.Fatal(err) + } + _, err = runtime.graph.Create(archive, nil, "Testing", "", nil) + if err != nil { + t.Fatal(err) + } + + srv := &Server{runtime: runtime} + + images, err := srv.Images(true, "") + if err != nil { + t.Fatal(err) + } + + if images[0].Created < images[1].Created { + t.Error("Expected []APIImges to be ordered by most recent creation date.") + } +} From 88cb9f3116e41b00b00fdccf6359a555e87061bd Mon Sep 17 00:00:00 2001 From: unclejack Date: Fri, 9 Aug 2013 20:33:17 +0300 Subject: [PATCH 03/55] keep processing signals after the first one --- commands.go | 1 - 1 file changed, 1 deletion(-) diff --git a/commands.go b/commands.go index db8a12669..d045625c7 100644 --- a/commands.go +++ b/commands.go @@ -1403,7 +1403,6 @@ func (cli *DockerCli) CmdRun(args ...string) error { if err := cli.CmdStop("-t", "4", runResult.ID); err != nil { fmt.Printf("failed to stop container:", err) } - return } } }() From 2ba5c915473ce6fe769fb059db4120e2a21fb42e Mon Sep 17 00:00:00 2001 From: unclejack Date: Fri, 9 Aug 2013 23:23:27 +0300 Subject: [PATCH 04/55] minor cleanup for signal handling --- commands.go | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/commands.go b/commands.go index d045625c7..ffe4ce230 100644 --- a/commands.go +++ b/commands.go @@ -1396,13 +1396,10 @@ func (cli *DockerCli) CmdRun(args ...string) error { signals := make(chan os.Signal, 1) signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM) go func() { - for { - sig := <-signals - if sig == syscall.SIGINT || sig == syscall.SIGTERM { - fmt.Printf("\nReceived signal: %s; cleaning up\n", sig) - if err := cli.CmdStop("-t", "4", runResult.ID); err != nil { - fmt.Printf("failed to stop container:", err) - } + for sig := range signals { + fmt.Printf("\nReceived signal: %s; cleaning up\n", sig) + if err := cli.CmdStop("-t", "4", runResult.ID); err != nil { + fmt.Printf("failed to stop container:", err) } } }() From 641ddaeb03f8b8eee5c1ca11e3024976378ceb6d Mon Sep 17 00:00:00 2001 From: unclejack Date: Fri, 9 Aug 2013 23:27:34 +0300 Subject: [PATCH 05/55] add formatting directive to failure to stop container error --- commands.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/commands.go b/commands.go index ffe4ce230..85b5c9abe 100644 --- a/commands.go +++ b/commands.go @@ -1399,7 +1399,7 @@ func (cli *DockerCli) CmdRun(args ...string) error { for sig := range signals { fmt.Printf("\nReceived signal: %s; cleaning up\n", sig) if err := cli.CmdStop("-t", "4", runResult.ID); err != nil { - fmt.Printf("failed to stop container:", err) + fmt.Printf("failed to stop container: %v", err) } } }() From 3bd73a96333e011738136f6a9eda23642cc204ab Mon Sep 17 00:00:00 2001 From: Greg Thornton Date: Sat, 10 Aug 2013 04:55:23 +0000 Subject: [PATCH 06/55] Apply volumes-from before creating volumes Copies the volumes from the container specified in `Config.VolumesFrom` before creating volumes from `Config.Volumes`. Skips any preexisting volumes when processing `Config.Volumes`. Fixes #1351 --- container.go | 60 ++++++++++++++++++++++++----------------------- container_test.go | 59 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 29 deletions(-) diff --git a/container.go b/container.go index 8721d45a5..44797e672 100644 --- a/container.go +++ b/container.go @@ -574,40 +574,12 @@ func (container *Container) Start(hostConfig *HostConfig) error { binds[path.Clean(dst)] = bindMap } - // FIXME: evaluate volumes-from before individual volumes, so that the latter can override the former. - // Create the requested volumes volumes if container.Volumes == nil || len(container.Volumes) == 0 { container.Volumes = make(map[string]string) container.VolumesRW = make(map[string]bool) - - for volPath := range container.Config.Volumes { - volPath = path.Clean(volPath) - // If an external bind is defined for this volume, use that as a source - if bindMap, exists := binds[volPath]; exists { - container.Volumes[volPath] = bindMap.SrcPath - if strings.ToLower(bindMap.Mode) == "rw" { - container.VolumesRW[volPath] = true - } - // Otherwise create an directory in $ROOT/volumes/ and use that - } else { - c, err := container.runtime.volumes.Create(nil, container, "", "", nil) - if err != nil { - return err - } - srcPath, err := c.layer() - if err != nil { - return err - } - container.Volumes[volPath] = srcPath - container.VolumesRW[volPath] = true // RW by default - } - // Create the mountpoint - if err := os.MkdirAll(path.Join(container.RootfsPath(), volPath), 0755); err != nil { - return nil - } - } } + // Apply volumes from another container if requested if container.Config.VolumesFrom != "" { c := container.runtime.Get(container.Config.VolumesFrom) if c == nil { @@ -627,6 +599,36 @@ func (container *Container) Start(hostConfig *HostConfig) error { } } + // Create the requested volumes if they don't exist + for volPath := range container.Config.Volumes { + volPath = path.Clean(volPath) + // If an external bind is defined for this volume, use that as a source + if _, exists := container.Volumes[volPath]; exists { + // Skip existing mounts + } else if bindMap, exists := binds[volPath]; exists { + container.Volumes[volPath] = bindMap.SrcPath + if strings.ToLower(bindMap.Mode) == "rw" { + container.VolumesRW[volPath] = true + } + // Otherwise create an directory in $ROOT/volumes/ and use that + } else { + c, err := container.runtime.volumes.Create(nil, container, "", "", nil) + if err != nil { + return err + } + srcPath, err := c.layer() + if err != nil { + return err + } + container.Volumes[volPath] = srcPath + container.VolumesRW[volPath] = true // RW by default + } + // Create the mountpoint + if err := os.MkdirAll(path.Join(container.RootfsPath(), volPath), 0755); err != nil { + return nil + } + } + if err := container.generateLXCConfig(); err != nil { return err } diff --git a/container_test.go b/container_test.go index aca53e5eb..c4f219373 100644 --- a/container_test.go +++ b/container_test.go @@ -1276,6 +1276,65 @@ func TestRestartWithVolumes(t *testing.T) { } } +// Test for #1351 +func TestVolumesFromWithVolumes(t *testing.T) { + runtime := mkRuntime(t) + defer nuke(runtime) + + container, err := NewBuilder(runtime).Create(&Config{ + Image: GetTestImage(runtime).ID, + Cmd: []string{"sh", "-c", "echo -n bar > /test/foo"}, + Volumes: map[string]struct{}{"/test": {}}, + }, + ) + if err != nil { + t.Fatal(err) + } + defer runtime.Destroy(container) + + for key := range container.Config.Volumes { + if key != "/test" { + t.Fail() + } + } + + _, err = container.Output() + if err != nil { + t.Fatal(err) + } + + expected := container.Volumes["/test"] + if expected == "" { + t.Fail() + } + + container2, err := NewBuilder(runtime).Create( + &Config{ + Image: GetTestImage(runtime).ID, + Cmd: []string{"cat", "/test/foo"}, + VolumesFrom: container.ID, + Volumes: map[string]struct{}{"/test": {}}, + }, + ) + if err != nil { + t.Fatal(err) + } + defer runtime.Destroy(container2) + + output, err := container2.Output() + if err != nil { + t.Fatal(err) + } + + if string(output) != "bar" { + t.Fail() + } + + if container.Volumes["/test"] != container2.Volumes["/test"] { + t.Fail() + } +} + func TestOnlyLoopbackExistsWhenUsingDisableNetworkOption(t *testing.T) { runtime := mkRuntime(t) defer nuke(runtime) From 57b49efc98d2f4605c95d5579a6cd952dfd6f124 Mon Sep 17 00:00:00 2001 From: Greg Thornton Date: Sat, 10 Aug 2013 06:37:57 +0000 Subject: [PATCH 07/55] Skip existing volumes in volumes-from Removes the error when a container already has a volume that would otherwise be created by `Config.VolumesFrom`. Allows restarting containers with a `Config.VolumesFrom` set. --- container.go | 10 ++++++---- container_test.go | 6 ++++++ 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/container.go b/container.go index 44797e672..326c0c55f 100644 --- a/container.go +++ b/container.go @@ -587,7 +587,7 @@ func (container *Container) Start(hostConfig *HostConfig) error { } for volPath, id := range c.Volumes { if _, exists := container.Volumes[volPath]; exists { - return fmt.Errorf("The requested volume %s overlap one of the volume of the container %s", volPath, c.ID) + continue } if err := os.MkdirAll(path.Join(container.RootfsPath(), volPath), 0755); err != nil { return nil @@ -602,10 +602,12 @@ func (container *Container) Start(hostConfig *HostConfig) error { // Create the requested volumes if they don't exist for volPath := range container.Config.Volumes { volPath = path.Clean(volPath) - // If an external bind is defined for this volume, use that as a source + // Skip existing volumes if _, exists := container.Volumes[volPath]; exists { - // Skip existing mounts - } else if bindMap, exists := binds[volPath]; exists { + continue + } + // If an external bind is defined for this volume, use that as a source + if bindMap, exists := binds[volPath]; exists { container.Volumes[volPath] = bindMap.SrcPath if strings.ToLower(bindMap.Mode) == "rw" { container.VolumesRW[volPath] = true diff --git a/container_test.go b/container_test.go index c4f219373..644e1c058 100644 --- a/container_test.go +++ b/container_test.go @@ -1333,6 +1333,12 @@ func TestVolumesFromWithVolumes(t *testing.T) { if container.Volumes["/test"] != container2.Volumes["/test"] { t.Fail() } + + // Ensure it restarts successfully + _, err = container2.Output() + if err != nil { + t.Fatal(err) + } } func TestOnlyLoopbackExistsWhenUsingDisableNetworkOption(t *testing.T) { From 025c759e443cc4eb43fc20b1f7da5520956b3b30 Mon Sep 17 00:00:00 2001 From: Brandon Liu Date: Sun, 11 Aug 2013 00:37:16 -0700 Subject: [PATCH 08/55] Fix Graph ByParent() to generate list of child images per parent image. --- graph.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/graph.go b/graph.go index 606a6833e..c54725fdb 100644 --- a/graph.go +++ b/graph.go @@ -323,9 +323,9 @@ func (graph *Graph) ByParent() (map[string][]*Image, error) { return } if children, exists := byParent[parent.ID]; exists { - byParent[parent.ID] = []*Image{image} - } else { byParent[parent.ID] = append(children, image) + } else { + byParent[parent.ID] = []*Image{image} } }) return byParent, err From 02b8d14bdd1837aad5b8fb667d1f4e7eace59687 Mon Sep 17 00:00:00 2001 From: Brandon Liu Date: Sun, 11 Aug 2013 01:24:21 -0700 Subject: [PATCH 09/55] Add test case for Graph ByParent(). --- graph_test.go | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/graph_test.go b/graph_test.go index 2898fccf9..32fb0ef44 100644 --- a/graph_test.go +++ b/graph_test.go @@ -234,6 +234,45 @@ func TestDelete(t *testing.T) { assertNImages(graph, t, 1) } +func TestByParent(t *testing.T) { + archive1, _ := fakeTar() + archive2, _ := fakeTar() + archive3, _ := fakeTar() + + graph := tempGraph(t) + defer os.RemoveAll(graph.Root) + parentImage := &Image{ + ID: GenerateID(), + Comment: "parent", + Created: time.Now(), + Parent: "", + } + childImage1 := &Image{ + ID: GenerateID(), + Comment: "child1", + Created: time.Now(), + Parent: parentImage.ID, + } + childImage2 := &Image{ + ID: GenerateID(), + Comment: "child2", + Created: time.Now(), + Parent: parentImage.ID, + } + _ = graph.Register(nil, archive1, parentImage) + _ = graph.Register(nil, archive2, childImage1) + _ = graph.Register(nil, archive3, childImage2) + + byParent, err := graph.ByParent() + if err != nil { + t.Fatal(err) + } + numChildren := len(byParent[parentImage.ID]) + if numChildren != 2 { + t.Fatalf("Expected 2 children, found %d", numChildren) + } +} + func assertNImages(graph *Graph, t *testing.T, n int) { if images, err := graph.All(); err != nil { t.Fatal(err) From def9598ed968eac934699db1b8717f852652b1ef Mon Sep 17 00:00:00 2001 From: Kawsar Saiyeed Date: Mon, 12 Aug 2013 05:22:33 +0100 Subject: [PATCH 10/55] Install websocket library before building docker --- Dockerfile | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Dockerfile b/Dockerfile index 46f9b585c..7430ec6c0 100644 --- a/Dockerfile +++ b/Dockerfile @@ -22,6 +22,9 @@ run echo 'deb http://archive.ubuntu.com/ubuntu precise main universe' > /etc/apt run apt-get update run apt-get install -y lxc run apt-get install -y aufs-tools +# Docker requires code.google.com/p/go.net/websocket +run apt-get install -y -q mercurial +run PKG=code.google.com/p/go.net REV=78ad7f42aa2e; hg clone https://$PKG /go/src/$PKG && cd /go/src/$PKG && hg checkout -r $REV # Upload docker source add . /go/src/github.com/dotcloud/docker # Build the binary From 703905d7ece5b4a71ae1faf2743341ace98c4fbb Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Mon, 12 Aug 2013 11:50:03 +0000 Subject: [PATCH 11/55] ensure the use oh IDs and add image's name in /events --- container.go | 2 +- server.go | 22 +++++++++++----------- utils/utils.go | 4 ++++ 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/container.go b/container.go index 8721d45a5..18c56c834 100644 --- a/container.go +++ b/container.go @@ -813,7 +813,7 @@ func (container *Container) monitor() { } utils.Debugf("Process finished") if container.runtime != nil && container.runtime.srv != nil { - container.runtime.srv.LogEvent("die", container.ShortID()) + container.runtime.srv.LogEvent("die", container.ShortID(), container.runtime.repositories.ImageName(container.Image)) } exitCode := -1 if container.cmd != nil { diff --git a/server.go b/server.go index f06b5ce68..663b9683b 100644 --- a/server.go +++ b/server.go @@ -76,7 +76,7 @@ func (srv *Server) ContainerKill(name string) error { if err := container.Kill(); err != nil { return fmt.Errorf("Error killing container %s: %s", name, err) } - srv.LogEvent("kill", name) + srv.LogEvent("kill", container.ShortID(), srv.runtime.repositories.ImageName(container.Image)) } else { return fmt.Errorf("No such container: %s", name) } @@ -95,7 +95,7 @@ func (srv *Server) ContainerExport(name string, out io.Writer) error { if _, err := io.Copy(out, data); err != nil { return err } - srv.LogEvent("export", name) + srv.LogEvent("export", container.ShortID(), srv.runtime.repositories.ImageName(container.Image)) return nil } return fmt.Errorf("No such container: %s", name) @@ -832,7 +832,7 @@ func (srv *Server) ContainerCreate(config *Config) (string, error) { } return "", err } - srv.LogEvent("create", container.ShortID()) + srv.LogEvent("create", container.ShortID(), srv.runtime.repositories.ImageName(container.Image)) return container.ShortID(), nil } @@ -841,7 +841,7 @@ func (srv *Server) ContainerRestart(name string, t int) error { if err := container.Restart(t); err != nil { return fmt.Errorf("Error restarting container %s: %s", name, err) } - srv.LogEvent("restart", name) + srv.LogEvent("restart", container.ShortID(), srv.runtime.repositories.ImageName(container.Image)) } else { return fmt.Errorf("No such container: %s", name) } @@ -861,7 +861,7 @@ func (srv *Server) ContainerDestroy(name string, removeVolume bool) error { if err := srv.runtime.Destroy(container); err != nil { return fmt.Errorf("Error destroying container %s: %s", name, err) } - srv.LogEvent("destroy", name) + srv.LogEvent("destroy", container.ShortID(), srv.runtime.repositories.ImageName(container.Image)) if removeVolume { // Retrieve all volumes from all remaining containers @@ -928,7 +928,7 @@ func (srv *Server) deleteImageAndChildren(id string, imgs *[]APIRmi) error { return err } *imgs = append(*imgs, APIRmi{Deleted: utils.TruncateID(id)}) - srv.LogEvent("delete", utils.TruncateID(id)) + srv.LogEvent("delete", utils.TruncateID(id), "") return nil } return nil @@ -975,7 +975,7 @@ func (srv *Server) deleteImage(img *Image, repoName, tag string) ([]APIRmi, erro } if tagDeleted { imgs = append(imgs, APIRmi{Untagged: img.ShortID()}) - srv.LogEvent("untag", img.ShortID()) + srv.LogEvent("untag", img.ShortID(), "") } if len(srv.runtime.repositories.ByID()[img.ID]) == 0 { if err := srv.deleteImageAndChildren(img.ID, &imgs); err != nil { @@ -1042,7 +1042,7 @@ func (srv *Server) ContainerStart(name string, hostConfig *HostConfig) error { if err := container.Start(hostConfig); err != nil { return fmt.Errorf("Error starting container %s: %s", name, err) } - srv.LogEvent("start", name) + srv.LogEvent("start", container.ShortID(), srv.runtime.repositories.ImageName(container.Image)) } else { return fmt.Errorf("No such container: %s", name) } @@ -1054,7 +1054,7 @@ func (srv *Server) ContainerStop(name string, t int) error { if err := container.Stop(t); err != nil { return fmt.Errorf("Error stopping container %s: %s", name, err) } - srv.LogEvent("stop", name) + srv.LogEvent("stop", container.ShortID(), srv.runtime.repositories.ImageName(container.Image)) } else { return fmt.Errorf("No such container: %s", name) } @@ -1222,9 +1222,9 @@ func (srv *Server) HTTPRequestFactory() *utils.HTTPRequestFactory { return srv.reqFactory } -func (srv *Server) LogEvent(action, id string) { +func (srv *Server) LogEvent(action, id, from string) { now := time.Now().Unix() - jm := utils.JSONMessage{Status: action, ID: id, Time: now} + jm := utils.JSONMessage{Status: action, ID: id, From: from, Time: now} srv.events = append(srv.events, jm) for _, c := range srv.listeners { select { // non blocking channel diff --git a/utils/utils.go b/utils/utils.go index df21e75ae..497d7f4e4 100644 --- a/utils/utils.go +++ b/utils/utils.go @@ -622,6 +622,7 @@ type JSONMessage struct { Progress string `json:"progress,omitempty"` ErrorMessage string `json:"error,omitempty"` //deprecated ID string `json:"id,omitempty"` + From string `json:"from,omitempty"` Time int64 `json:"time,omitempty"` Error *JSONError `json:"errorDetail,omitempty"` } @@ -650,6 +651,9 @@ func (jm *JSONMessage) Display(out io.Writer) error { if jm.ID != "" { fmt.Fprintf(out, "%s: ", jm.ID) } + if jm.From != "" { + fmt.Fprintf(out, "(from %s) ", jm.From) + } if jm.Progress != "" { fmt.Fprintf(out, "%c[2K", 27) fmt.Fprintf(out, "%s %s\r", jm.Status, jm.Progress) From 123c80467bb6e7bef22827b55640a4789e42558d Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Mon, 12 Aug 2013 11:55:23 +0000 Subject: [PATCH 12/55] Added docs --- docs/sources/api/docker_remote_api.rst | 4 +++ docs/sources/api/docker_remote_api_v1.4.rst | 31 +++++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/docs/sources/api/docker_remote_api.rst b/docs/sources/api/docker_remote_api.rst index 7e4b67434..ec19fed48 100644 --- a/docs/sources/api/docker_remote_api.rst +++ b/docs/sources/api/docker_remote_api.rst @@ -48,6 +48,10 @@ What's new **New!** You can now use ps args with docker top, like `docker top aux` +.. http:get:: /events: + + **New!** Image's name added in the events + :doc:`docker_remote_api_v1.3` ***************************** diff --git a/docs/sources/api/docker_remote_api_v1.4.rst b/docs/sources/api/docker_remote_api_v1.4.rst index 06e8f46f9..1073ddcd6 100644 --- a/docs/sources/api/docker_remote_api_v1.4.rst +++ b/docs/sources/api/docker_remote_api_v1.4.rst @@ -1095,6 +1095,37 @@ Create a new image from a container's changes :statuscode 404: no such container :statuscode 500: server error + +Monitor Docker's events +*********************** + +.. http:get:: /events + + Get events from docker, either in real time via streaming, or via polling (using `since`) + + **Example request**: + + .. sourcecode:: http + + POST /events?since=1374067924 + + **Example response**: + + .. sourcecode:: http + + HTTP/1.1 200 OK + Content-Type: application/json + + {"status":"create","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"start","id":"dfdf82bd3881","from":"base:latest","time":1374067924} + {"status":"stop","id":"dfdf82bd3881","from":"base:latest","time":1374067966} + {"status":"destroy","id":"dfdf82bd3881","from":"base:latest","time":1374067970} + + :query since: timestamp used for polling + :statuscode 200: no error + :statuscode 500: server error + + 3. Going further ================ From ec61c46bf73b8c727fe8de1982d86a1417a8a0c4 Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Mon, 12 Aug 2013 22:42:29 +0000 Subject: [PATCH 13/55] Add import for dotcloud/tar to replace std tar pkg --- Dockerfile | 1 + utils/tarsum.go | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 46f9b585c..2e4953fb1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -15,6 +15,7 @@ run cd /tmp && echo 'package main' > t.go && go test -a -i -v run PKG=github.com/kr/pty REV=27435c699; git clone http://$PKG /go/src/$PKG && cd /go/src/$PKG && git checkout -f $REV run PKG=github.com/gorilla/context/ REV=708054d61e5; git clone http://$PKG /go/src/$PKG && cd /go/src/$PKG && git checkout -f $REV run PKG=github.com/gorilla/mux/ REV=9b36453141c; git clone http://$PKG /go/src/$PKG && cd /go/src/$PKG && git checkout -f $REV +run PKG=github.com/dotcloud/tar/ REV=d06045a6d9; git clone http://$PKG /go/src/$PKG && cd /go/src/$PKG && git checkout -f $REV # Run dependencies run apt-get install -y iptables # lxc requires updating ubuntu sources diff --git a/utils/tarsum.go b/utils/tarsum.go index d3e1db61f..290be241a 100644 --- a/utils/tarsum.go +++ b/utils/tarsum.go @@ -1,11 +1,11 @@ package utils import ( - "archive/tar" "bytes" "compress/gzip" "crypto/sha256" "encoding/hex" + "github.com/dotcloud/tar" "hash" "io" "sort" From c015d26e96e1f6ebee2a577468c747bf3d2aeeb9 Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Mon, 12 Aug 2013 11:07:58 -0700 Subject: [PATCH 14/55] API, issue 1471: Allow users belonging to the docker group to use the docker client --- api.go | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/api.go b/api.go index 221cabed5..6b692ed98 100644 --- a/api.go +++ b/api.go @@ -13,6 +13,7 @@ import ( "net/http" "os" "os/exec" + "regexp" "strconv" "strings" ) @@ -974,7 +975,20 @@ func ListenAndServe(proto, addr string, srv *Server, logging bool) error { return e } if proto == "unix" { - os.Chmod(addr, 0700) + os.Chmod(addr, 0660) + groups, err := ioutil.ReadFile("/etc/group") + if err != nil { + return err + } + re := regexp.MustCompile("(^|\n)docker:.*?:([0-9]+)") + if gidMatch := re.FindStringSubmatch(string(groups)); gidMatch != nil { + gid, err := strconv.Atoi(gidMatch[2]) + if err != nil { + return err + } + utils.Debugf("docker group found. gid: %d", gid) + os.Chown(addr, 0, gid) + } } httpSrv := http.Server{Addr: addr, Handler: r} return httpSrv.Serve(l) From ef1d1aefa73f71296911b0f5593e46a81c1f5c55 Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Sat, 10 Aug 2013 03:06:08 +0000 Subject: [PATCH 15/55] Revert "docker.upstart: avoid spawning a `sh` process" This reverts commit 24dd50490a027f01ea086eb90663d53348fa770e. --- packaging/ubuntu/docker.upstart | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packaging/ubuntu/docker.upstart b/packaging/ubuntu/docker.upstart index f4d2fbe92..143be0340 100644 --- a/packaging/ubuntu/docker.upstart +++ b/packaging/ubuntu/docker.upstart @@ -5,4 +5,6 @@ stop on runlevel [!2345] respawn -exec /usr/bin/docker -d +script + /usr/bin/docker -d +end script From 68934878f1e707b126ab754d48ff6c6eb858b37e Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Wed, 7 Aug 2013 17:23:49 -0700 Subject: [PATCH 16/55] Make sure ENV instruction within build perform a commit each time --- buildfile.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/buildfile.go b/buildfile.go index 33e68c621..b13643fd8 100644 --- a/buildfile.go +++ b/buildfile.go @@ -167,9 +167,9 @@ func (b *buildFile) CmdEnv(args string) error { if envKey >= 0 { b.config.Env[envKey] = replacedVar - return nil + } else { + b.config.Env = append(b.config.Env, replacedVar) } - b.config.Env = append(b.config.Env, replacedVar) return b.commit("", b.config.Cmd, fmt.Sprintf("ENV %s", replacedVar)) } From 0ca133dd7681bb3af1d1de18a5ea6ed42142a11e Mon Sep 17 00:00:00 2001 From: Steeve Morin Date: Thu, 1 Aug 2013 02:42:22 +0200 Subject: [PATCH 17/55] Handle ip route showing mask-less IP addresses Sometimes `ip route` will show mask-less IPs, so net.ParseCIDR will fail. If it does we check if we can net.ParseIP, and fail only if we can't. Fixes #1214 Fixes #362 --- network.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/network.go b/network.go index 4e3c7456a..02268314a 100644 --- a/network.go +++ b/network.go @@ -104,7 +104,11 @@ func checkRouteOverlaps(dockerNetwork *net.IPNet) error { continue } if _, network, err := net.ParseCIDR(strings.Split(line, " ")[0]); err != nil { - return fmt.Errorf("Unexpected ip route output: %s (%s)", err, line) + // is this a mask-less IP address? + if ip := net.ParseIP(strings.Split(line, " ")[0]); ip == nil { + // fail only if it's neither a network nor a mask-less IP address + return fmt.Errorf("Unexpected ip route output: %s (%s)", err, line) + } } else if networkOverlaps(dockerNetwork, network) { return fmt.Errorf("Network %s is already routed: '%s'", dockerNetwork.String(), line) } From c3773740d982d62c5c478d3fb27aa4494383b11b Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Mon, 12 Aug 2013 23:55:42 +0000 Subject: [PATCH 18/55] Bump to 0.5.3 --- CHANGELOG.md | 6 ++++++ commands.go | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ab145e595..7a8122416 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## 0.5.3 (2013-08-13) +* Runtime: Use docker group for socket permissions +- Runtime: Spawn shell within upstart script +- Builder: Make sure ENV instruction within build perform a commit each time +- Runtime: Handle ip route showing mask-less IP addresses + ## 0.5.2 (2013-08-08) * Builder: Forbid certain paths within docker build ADD - Runtime: Change network range to avoid conflict with EC2 DNS diff --git a/commands.go b/commands.go index 7f70c8c09..e1246d588 100644 --- a/commands.go +++ b/commands.go @@ -27,7 +27,7 @@ import ( "unicode" ) -const VERSION = "0.5.2" +const VERSION = "0.5.3" var ( GITCOMMIT string From 6cb908bb823409661bfedab806da924d232bf200 Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Tue, 13 Aug 2013 13:35:34 +0000 Subject: [PATCH 19/55] fix merge issue --- commands.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/commands.go b/commands.go index 9b9dd51e7..d9d4f1b62 100644 --- a/commands.go +++ b/commands.go @@ -857,7 +857,7 @@ func (cli *DockerCli) CmdPush(args ...string) error { } if err := push(); err != nil { - if err == fmt.Errorf("Authentication is required.") { + if err.Error() == "Authentication is required." { if err = cli.checkIfLogged("push"); err == nil { return push() } From 2ba1300773857273585288c79aa65f011b045b4c Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Tue, 13 Aug 2013 13:51:49 +0000 Subject: [PATCH 20/55] remove checkIfLogged --- commands.go | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/commands.go b/commands.go index d9d4f1b62..8cefe3408 100644 --- a/commands.go +++ b/commands.go @@ -858,9 +858,11 @@ func (cli *DockerCli) CmdPush(args ...string) error { if err := push(); err != nil { if err.Error() == "Authentication is required." { - if err = cli.checkIfLogged("push"); err == nil { - return push() + fmt.Fprintln(cli.out, "\nPlease login prior to push:") + if err := cli.CmdLogin(""); err != nil { + return err } + return push() } return err } @@ -1512,19 +1514,6 @@ func (cli *DockerCli) CmdCp(args ...string) error { return nil } -func (cli *DockerCli) checkIfLogged(action string) error { - // If condition AND the login failed - if cli.configFile.Configs[auth.IndexServerAddress()].Username == "" { - if err := cli.CmdLogin(""); err != nil { - return err - } - if cli.configFile.Configs[auth.IndexServerAddress()].Username == "" { - return fmt.Errorf("Please login prior to %s. ('docker login')", action) - } - } - return nil -} - func (cli *DockerCli) call(method, path string, data interface{}) ([]byte, int, error) { var params io.Reader if data != nil { From e09863fedb1b2fec4672d2d1ebad29ecdb8eed1a Mon Sep 17 00:00:00 2001 From: unclejack Date: Tue, 13 Aug 2013 19:48:30 +0300 Subject: [PATCH 21/55] use Go 1.1.2 for dockerbuilder --- hack/dockerbuilder/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hack/dockerbuilder/Dockerfile b/hack/dockerbuilder/Dockerfile index 60cd93b17..496ee45e7 100644 --- a/hack/dockerbuilder/Dockerfile +++ b/hack/dockerbuilder/Dockerfile @@ -23,7 +23,7 @@ run add-apt-repository -y ppa:dotcloud/docker-golang/ubuntu run apt-get update # Packages required to checkout, build and upload docker run DEBIAN_FRONTEND=noninteractive apt-get install -y -q s3cmd curl -run curl -s -o /go.tar.gz https://go.googlecode.com/files/go1.1.1.linux-amd64.tar.gz +run curl -s -o /go.tar.gz https://go.googlecode.com/files/go1.1.2.linux-amd64.tar.gz run tar -C /usr/local -xzf /go.tar.gz run echo "export PATH=/usr/local/go/bin:$PATH" > /.bashrc run echo "export PATH=/usr/local/go/bin:$PATH" > /.bash_profile From 05219d6b52d8448fdad72f89b192d61480483aff Mon Sep 17 00:00:00 2001 From: Nolan Date: Tue, 30 Jul 2013 13:23:34 -0500 Subject: [PATCH 22/55] Add hostname to the container environment. --- container.go | 1 + 1 file changed, 1 insertion(+) diff --git a/container.go b/container.go index d610c3c7d..ccc7ab3e9 100644 --- a/container.go +++ b/container.go @@ -652,6 +652,7 @@ func (container *Container) Start(hostConfig *HostConfig) error { "-e", "HOME=/", "-e", "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", "-e", "container=lxc", + "-e", "HOSTNAME="+container.Config.Hostname, ) for _, elem := range container.Config.Env { From 1a1c89556f3869baded68eb56ae20f8a7e90a708 Mon Sep 17 00:00:00 2001 From: "Guillaume J. Charmes" Date: Fri, 2 Aug 2013 15:58:10 -0700 Subject: [PATCH 23/55] Fix TestEnv --- container_test.go | 1 + 1 file changed, 1 insertion(+) diff --git a/container_test.go b/container_test.go index a1ac0bd33..f29ae9e4e 100644 --- a/container_test.go +++ b/container_test.go @@ -960,6 +960,7 @@ func TestEnv(t *testing.T) { "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin", "HOME=/", "container=lxc", + "HOSTNAME=" + container.ShortID(), } sort.Strings(goodEnv) if len(goodEnv) != len(actualEnv) { From 5d25f3232c38d6a7ed31860948058b8ec1d95656 Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Tue, 13 Aug 2013 17:36:24 +0000 Subject: [PATCH 24/55] Update changelog to include hostname commit --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a8122416..cfbd86cd7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ - Runtime: Spawn shell within upstart script - Builder: Make sure ENV instruction within build perform a commit each time - Runtime: Handle ip route showing mask-less IP addresses +- Runtime: Add hostname to environment ## 0.5.2 (2013-08-08) * Builder: Forbid certain paths within docker build ADD From fb7c4214ced3b0533316e3eebd90ac07fe7b2933 Mon Sep 17 00:00:00 2001 From: shin- Date: Mon, 12 Aug 2013 19:45:12 +0200 Subject: [PATCH 25/55] brew: Reuse repositories when possible --- contrib/brew/brew/brew.py | 12 ++++++++++-- contrib/brew/brew/git.py | 17 ++++++++++++++++- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/contrib/brew/brew/brew.py b/contrib/brew/brew/brew.py index 8cbbaca06..352d20c77 100644 --- a/contrib/brew/brew/brew.py +++ b/contrib/brew/brew/brew.py @@ -14,6 +14,7 @@ logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s', level='INFO') client = docker.Client() processed = {} +processed_folders = [] def build_library(repository=None, branch=None, namespace=None, push=False, @@ -92,20 +93,27 @@ def build_library(repository=None, branch=None, namespace=None, push=False, f.close() if dst_folder != repository: rmtree(dst_folder, True) + for d in processed_folders: + rmtree(d, True) summary.print_summary(logger) def build_repo(repository, ref, docker_repo, docker_tag, namespace, push, registry): docker_repo = '{0}/{1}'.format(namespace or 'library', docker_repo) img_id = None + dst_folder = None if '{0}@{1}'.format(repository, ref) not in processed.keys(): logger.info('Cloning {0} (ref: {1})'.format(repository, ref)) - dst_folder = git.clone(repository, ref) + if repository not in processed: + rep, dst_folder = git.clone(repository, ref) + processed[repository] = rep + processed_folders.append(dst_folder) + else: + dst_folder = git.checkout(processed[repository], ref) if not 'Dockerfile' in os.listdir(dst_folder): raise RuntimeError('Dockerfile not found in cloned repository') logger.info('Building using dockerfile...') img_id, logs = client.build(path=dst_folder, quiet=True) - rmtree(dst_folder, True) else: img_id = processed['{0}@{1}'.format(repository, ref)] logger.info('Committing to {0}:{1}'.format(docker_repo, diff --git a/contrib/brew/brew/git.py b/contrib/brew/brew/git.py index 40cae8753..e45e99545 100644 --- a/contrib/brew/brew/git.py +++ b/contrib/brew/brew/git.py @@ -16,6 +16,21 @@ def clone_tag(repo_url, tag, folder=None): return clone(repo_url, 'refs/tags/' + tag, folder) +def checkout(rep, ref=None): + is_commit = False + if ref is None: + ref = 'refs/heads/master' + elif not ref.startswith('refs/'): + is_commit = True + if is_commit: + rep['HEAD'] = rep.commit(ref) + else: + rep['HEAD'] = rep.refs[ref] + indexfile = rep.index_path() + tree = rep["HEAD"].tree + index.build_index_from_tree(rep.path, indexfile, rep.object_store, tree) + return rep.path + def clone(repo_url, ref=None, folder=None): is_commit = False if ref is None: @@ -45,4 +60,4 @@ def clone(repo_url, ref=None, folder=None): tree = rep["HEAD"].tree index.build_index_from_tree(rep.path, indexfile, rep.object_store, tree) logger.debug("done") - return folder + return rep, folder From 79fc90b6463d9b20391b4edd1540bc0a8e84da6f Mon Sep 17 00:00:00 2001 From: shin- Date: Mon, 12 Aug 2013 19:52:09 +0200 Subject: [PATCH 26/55] brew: Don't build if docker daemon can't be reached --- contrib/brew/brew/brew.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/contrib/brew/brew/brew.py b/contrib/brew/brew/brew.py index 352d20c77..e07fdfdbb 100644 --- a/contrib/brew/brew/brew.py +++ b/contrib/brew/brew/brew.py @@ -32,6 +32,15 @@ def build_library(repository=None, branch=None, namespace=None, push=False, logger.info('Repository provided assumed to be a local path') dst_folder = repository + try: + client.version() + except Exception as e: + logger.error('Could not reach the docker daemon. Please make sure it ' + 'is running.') + logger.warning('Also make sure you have access to the docker UNIX ' + 'socket (use sudo)') + return + #FIXME: set destination folder and only pull latest changes instead of # cloning the whole repo everytime if not dst_folder: From e5f1b6b9a4b934eab9c42d6534fe52672c018405 Mon Sep 17 00:00:00 2001 From: shin- Date: Tue, 13 Aug 2013 20:12:44 +0200 Subject: [PATCH 27/55] brew: Updated requirements --- contrib/brew/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/brew/requirements.txt b/contrib/brew/requirements.txt index 78a574953..6100b01d0 100644 --- a/contrib/brew/requirements.txt +++ b/contrib/brew/requirements.txt @@ -1,2 +1,2 @@ dulwich==0.9.0 -docker-py==0.1.3 \ No newline at end of file +docker-py==0.1.4 \ No newline at end of file From 2cebe09924c9afea47bb1f2444ba1cd8fc423669 Mon Sep 17 00:00:00 2001 From: shin- Date: Tue, 13 Aug 2013 20:28:06 +0200 Subject: [PATCH 28/55] brew: Display a clear error message when the path is invalid --- contrib/brew/brew/brew.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/contrib/brew/brew/brew.py b/contrib/brew/brew/brew.py index e07fdfdbb..22fe5b7b4 100644 --- a/contrib/brew/brew/brew.py +++ b/contrib/brew/brew/brew.py @@ -53,7 +53,13 @@ def build_library(repository=None, branch=None, namespace=None, push=False, logger.error('Source repository could not be fetched. Check ' 'that the address is correct and the branch exists.') return - for buildfile in os.listdir(os.path.join(dst_folder, 'library')): + try: + dirlist = os.listdir(os.path.join(dst_folder, 'library')) + except OSError as e: + logger.error('The path provided ({0}) could not be found or didn\'t' + 'contain a library/ folder.'.format(dst_folder)) + return + for buildfile in dirlist: if buildfile == 'MAINTAINERS': continue f = open(os.path.join(dst_folder, 'library', buildfile)) From e4f35dd4cf81a7f2d19a61cc8b1084c3adcc5253 Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Tue, 13 Aug 2013 12:02:20 -0700 Subject: [PATCH 29/55] Update docs for docker group --- docs/sources/api/docker_remote_api.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/sources/api/docker_remote_api.rst b/docs/sources/api/docker_remote_api.rst index 9113d8e15..aa11ba50a 100644 --- a/docs/sources/api/docker_remote_api.rst +++ b/docs/sources/api/docker_remote_api.rst @@ -16,6 +16,7 @@ Docker Remote API - The Remote API is replacing rcli - By default the Docker daemon listens on unix:///var/run/docker.sock and the client must have root access to interact with the daemon +- If a group named *docker* exists on your system, docker will apply ownership of the socket to the group - The API tends to be REST, but for some complex commands, like attach or pull, the HTTP connection is hijacked to transport stdout stdin and stderr From e2409ad3376baeb36d1011732f7d7b1a239320ae Mon Sep 17 00:00:00 2001 From: Andy Rothfusz Date: Tue, 13 Aug 2013 13:45:07 -0700 Subject: [PATCH 30/55] Added information about Docker's high level tools over LXC. Formatting cleanup. Mailing list cleanup. --- docs/sources/api/registry_index_spec.rst | 3 +- docs/sources/faq.rst | 124 ++++++++++++++++++++--- docs/sources/use/builder.rst | 2 + 3 files changed, 116 insertions(+), 13 deletions(-) diff --git a/docs/sources/api/registry_index_spec.rst b/docs/sources/api/registry_index_spec.rst index a41523e81..4ea0c687d 100644 --- a/docs/sources/api/registry_index_spec.rst +++ b/docs/sources/api/registry_index_spec.rst @@ -2,9 +2,10 @@ :description: Documentation for docker Registry and Registry API :keywords: docker, registry, api, index +.. _registryindexspec: ===================== -Registry & index Spec +Registry & Index Spec ===================== .. contents:: Table of Contents diff --git a/docs/sources/faq.rst b/docs/sources/faq.rst index 3cc0086c5..dd5fd11fd 100644 --- a/docs/sources/faq.rst +++ b/docs/sources/faq.rst @@ -9,40 +9,140 @@ FAQ Most frequently asked questions. -------------------------------- -1. **How much does Docker cost?** +How much does Docker cost? +.......................... Docker is 100% free, it is open source, so you can use it without paying. -2. **What open source license are you using?** +What open source license are you using? +....................................... - We are using the Apache License Version 2.0, see it here: https://github.com/dotcloud/docker/blob/master/LICENSE + We are using the Apache License Version 2.0, see it here: + https://github.com/dotcloud/docker/blob/master/LICENSE -3. **Does Docker run on Mac OS X or Windows?** +Does Docker run on Mac OS X or Windows? +....................................... - Not at this time, Docker currently only runs on Linux, but you can use VirtualBox to run Docker in a - virtual machine on your box, and get the best of both worlds. Check out the :ref:`install_using_vagrant` and :ref:`windows` installation guides. + Not at this time, Docker currently only runs on Linux, but you can + use VirtualBox to run Docker in a virtual machine on your box, and + get the best of both worlds. Check out the + :ref:`install_using_vagrant` and :ref:`windows` installation + guides. -4. **How do containers compare to virtual machines?** +How do containers compare to virtual machines? +.............................................. - They are complementary. VMs are best used to allocate chunks of hardware resources. Containers operate at the process level, which makes them very lightweight and perfect as a unit of software delivery. + They are complementary. VMs are best used to allocate chunks of + hardware resources. Containers operate at the process level, which + makes them very lightweight and perfect as a unit of software + delivery. -5. **Can I help by adding some questions and answers?** +What does Docker add to just plain LXC? +....................................... + + Docker is not a replacement for LXC. "LXC" refers to capabilities + of the Linux kernel (specifically namespaces and control groups) + which allow sandboxing processes from one another, and controlling + their resource allocations. On top of this low-level foundation of + kernel features, Docker offers a high-level tool with several + powerful functionalities: + + * *Portable deployment across machines.* + Docker defines a format for bundling an application and all its + dependencies into a single object which can be transferred to + any Docker-enabled machine, and executed there with the + guarantee that the execution environment exposed to the + application will be the same. LXC implements process sandboxing, + which is an important pre-requisite for portable deployment, but + that alone is not enough for portable deployment. If you sent me + a copy of your application installed in a custom LXC + configuration, it would almost certainly not run on my machine + the way it does on yours, because it is tied to your machine's + specific configuration: networking, storage, logging, distro, + etc. Docker defines an abstraction for these machine-specific + settings, so that the exact same Docker container can run - + unchanged - on many different machines, with many different + configurations. + + * *Application-centric.* + Docker is optimized for the deployment of applications, as + opposed to machines. This is reflected in its API, user + interface, design philosophy and documentation. By contrast, the + ``lxc`` helper scripts focus on containers as lightweight + machines - basically servers that boot faster and need less + RAM. We think there's more to containers than just that. + + * *Automatic build.* + Docker includes :ref:`a tool for developers to automatically + assemble a container from their source code `, + with full control over application dependencies, build tools, + packaging etc. They are free to use ``make, maven, chef, puppet, + salt,`` Debian packages, RPMs, source tarballs, or any + combination of the above, regardless of the configuration of the + machines. + + * *Versioning.* + Docker includes git-like capabilities for tracking successive + versions of a container, inspecting the diff between versions, + committing new versions, rolling back etc. The history also + includes how a container was assembled and by whom, so you get + full traceability from the production server all the way back to + the upstream developer. Docker also implements incremental + uploads and downloads, similar to ``git pull``, so new versions + of a container can be transferred by only sending diffs. + + * *Component re-use.* + Any container can be used as a :ref:`"base image" + ` to create more specialized components. This + can be done manually or as part of an automated build. For + example you can prepare the ideal Python environment, and use it + as a base for 10 different applications. Your ideal Postgresql + setup can be re-used for all your future projects. And so on. + + * *Sharing.* + Docker has access to a `public registry + `_ where thousands of people have + uploaded useful containers: anything from Redis, CouchDB, + Postgres to IRC bouncers to Rails app servers to Hadoop to base + images for various Linux distros. The :ref:`registry + ` also includes an official "standard + library" of useful containers maintained by the Docker team. The + registry itself is open-source, so anyone can deploy their own + registry to store and transfer private containers, for internal + server deployments for example. + + * *Tool ecosystem.* + Docker defines an API for automating and customizing the + creation and deployment of containers. There are a huge number + of tools integrating with Docker to extend its + capabilities. PaaS-like deployment (Dokku, Deis, Flynn), + multi-node orchestration (Maestro, Salt, Mesos, Openstack Nova), + management dashboards (docker-ui, Openstack Horizon, Shipyard), + configuration management (Chef, Puppet), continuous integration + (Jenkins, Strider, Travis), etc. Docker is rapidly establishing + itself as the standard for container-based tooling. + +Can I help by adding some questions and answers? +................................................ Definitely! You can fork `the repo`_ and edit the documentation sources. -42. **Where can I find more answers?** +Where can I find more answers? +.............................. You can find more answers on: - * `Docker club mailinglist`_ + * `Docker user mailinglist`_ + * `Docker developer mailinglist`_ * `IRC, docker on freenode`_ * `Github`_ * `Ask questions on Stackoverflow`_ * `Join the conversation on Twitter`_ - .. _Docker club mailinglist: https://groups.google.com/d/forum/docker-club + .. _Docker user mailinglist: https://groups.google.com/d/forum/docker-user + .. _Docker developer mailinglist: https://groups.google.com/d/forum/docker-dev .. _the repo: http://www.github.com/dotcloud/docker .. _IRC, docker on freenode: irc://chat.freenode.net#docker .. _Github: http://www.github.com/dotcloud/docker diff --git a/docs/sources/use/builder.rst b/docs/sources/use/builder.rst index d111e335a..293ad3206 100644 --- a/docs/sources/use/builder.rst +++ b/docs/sources/use/builder.rst @@ -2,6 +2,8 @@ :description: Dockerfiles use a simple DSL which allows you to automate the steps you would normally manually take to create an image. :keywords: builder, docker, Dockerfile, automation, image creation +.. _dockerbuilder: + ================== Dockerfile Builder ================== From f14db4934605235bd77e9d1dc22377ca710e4c7b Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Tue, 13 Aug 2013 16:18:32 -0700 Subject: [PATCH 31/55] [docs] Some user-friendly changes to the documentation. - Added parmalinks (closes #1527) - Changed the 'fork us on github' button to 'Edit this page on github', so people can edit quickly (closes #1532) - Changed the favicon --- docs/sources/conf.py | 5 ++--- docs/theme/docker/layout.html | 4 ++-- docs/theme/docker/static/css/main.css | 16 ++++++++++++++++ docs/theme/docker/static/css/main.less | 18 ++++++++++++++++++ docs/theme/docker/static/favicon.png | Bin 404 -> 1475 bytes 5 files changed, 38 insertions(+), 5 deletions(-) diff --git a/docs/sources/conf.py b/docs/sources/conf.py index b4c23f0c5..9342ab503 100644 --- a/docs/sources/conf.py +++ b/docs/sources/conf.py @@ -18,7 +18,7 @@ import sys, os # documentation root, use os.path.abspath to make it absolute, like shown here. #sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ----------------------------------------------------- +# -- General configuratiofn ----------------------------------------------------- @@ -52,8 +52,7 @@ source_suffix = '.rst' #source_encoding = 'utf-8-sig' #disable the parmalinks on headers, I find them really annoying -html_add_permalinks = None - +html_add_permalinks = u'¶' # The master toctree document. master_doc = 'toctree' diff --git a/docs/theme/docker/layout.html b/docs/theme/docker/layout.html index d6bfff79b..2b7796628 100755 --- a/docs/theme/docker/layout.html +++ b/docs/theme/docker/layout.html @@ -70,8 +70,8 @@
    - + @@ -93,7 +93,7 @@

    DOCUMENTATION

    diff --git a/docs/theme/docker/static/css/main.css b/docs/theme/docker/static/css/main.css index 0b11890f7..fc1fd4886 100755 --- a/docs/theme/docker/static/css/main.css +++ b/docs/theme/docker/static/css/main.css @@ -375,3 +375,19 @@ section.header { table th { text-align: left; } +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} +.headerlink { + font-size: smaller; + color: #666; + font-weight: bold; + float: right; + visibility: hidden; +} diff --git a/docs/theme/docker/static/css/main.less b/docs/theme/docker/static/css/main.less index 8c470518d..0451df1d3 100644 --- a/docs/theme/docker/static/css/main.less +++ b/docs/theme/docker/static/css/main.less @@ -486,4 +486,22 @@ section.header { /* Misc fixes */ table th { text-align: left; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +.headerlink { + font-size: smaller; + color: #666; + font-weight: bold; + float: right; + visibility: hidden; } \ No newline at end of file diff --git a/docs/theme/docker/static/favicon.png b/docs/theme/docker/static/favicon.png index 2915dbd01ae8f10885c31e67d00ac2a24ad0c498..ee01a5ee8a9ea542f17123ed9c587510a2e26aef 100644 GIT binary patch literal 1475 zcmV;!1w8tRP)+(fofHYbct z7*K_dWFwmr35jN}Fd7pRjiT8b<4YG~_HK!0x)@EIj7*}LWu##SsR%e!jR>VYCg?1bo3s&Wq=Fp7Z;D&i6dO=Q)oO5$YSi5ceL*k{DJLkk$3kJZT{rY7j31U11z*grKSiAPVO#SF|u>ah6@nZo* znTD^7uUP$^M8L03ldH=i=`1QNGc`F*ICULuG|ln+1|;`C`=jEjri~lctbC@g|HP$_ zj?Y;I)}+EjX{>WtZLr$lY=YAo=LcY8M8J6|H&>1gO-+qaN7s(2ZQoio)wT6!yOi?h zbzuGGXF9dmywX;@Tzk7Xhtmde4kdzk0V=X!6P%wyDTRqD3pQ@qvJ!l(qkOP;-{8L! z78bPFTyt}r&JlKP+I;58zV$y;>Muo*pNLd$0VuXDeyP~;>21zh(&duM8y}ZSV{A;R zR3xz$6PC$pL#8f=PGYL9_ia75JvK>4YqgJ?qm56&%Auo7T6%8qx!s#)Ac%PXjIw{&`Lv)Au$G*L?lWfnJflDdp=P^ zlS)z`5_l{pFGM=jERQC%@F06h26GQ8Fd~&kzz?Z$S)Z}g7 zzTM*#7IPmD3)rAQ?a!SxZEhE85-A2|4fgT1|fRF6Hk^V`?%|LiwY>8$w3 z!YGri6TnL%w4XwZhl(Q-XK}_uJBtTMkU}|!3o9gk3I+JpQm93Z2%-tn4YF`)<3w90 zm%}Q{_P=@}J302IUoHKkb@*i8?~e`)19)PBO&3>gTDqX6Ku&vzOKRJJ0&YAj)UGXx z7-ro0PaGgoI)&C9|B6mWRYodhnlB8{e)j0@zPI0c>((kza>Rs{o}^kve1GQoQL_}) zZ8oJ)z+@D1rCLTQ#lpeA9r*fzKkc9Gb}uz~^+@LYX~ruNrF6hY+@p9X_BfGyOVrKWNI5X3W-lNpG6vQJRZh7& zu7q}WZ&WQRQH)fpU>z8r=FzhhPQUYFUvKZxxeU{9oH#Moa&_o8>9B+g6C4_+J)F`= z9MkMV9vT^-T_*?%rEch2qm+WgBGYB0TmdKG1vE}wrt{Rnm;btN&rjzP2T&rymUZje zFD-lQkk|34&IG~p42`~~BV*{Nke6%{6Vn7+OcqvUKp! zkH5R;weQbm{Y?M>PdwHA_~)M9`et{}=2p)bQmGWp`38PBJjILs!zis#2v}DWwzjrf zsJ$zUArns1cH!?Mi!UDE{pWpeyf&ZkEdT(^*KB-rL(dmpdFu1sj}{geYI`J(R|dxT z<$Gf@Gt^AipcEQMU8P9V=(+Kh(KEkpzxeJ;e>n8+h1(Io1)!E+WjB6t=L-)$vg)fH zot+OaDir*DLzcHcDDkV)S1E=uei9Oti)6~zuho~Xp3F~N-nVFEaPQv3htJ=x@SFfQ zfcTw{tX|%}Wa-1Xy6mRFsCC82R;Qz6zi*@Cb=A^PS dzXxy+;Gc5Vg6*aX&Q$;a002ovPDHLkV1knE)4Biv literal 404 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbL!WQl7;NpOBzNqJ&XDuZK6ep0G} zXKrG8YEWuoN@d~6R2!h8iU6MwS0G(gRTUExbN>AK?Ck94&!5-V*9!;;OrAV>-MV!w zEG)BU&+h5zQBhF|4-e|Nk#cHPq?+xMz!P=B@*I z2lxZ`G;jSd=daV9nd_S^rtb}yV(H{|N-i*7;jZvJ(~ek)d%gulPS+0{ZSqQM5!!!g zf2W6v<(A~XudXlSU%Pl=-`NUxsSSOfY-(2h3{ndEKX3L=4g&`HP2%rdSQrihUBck$ L>gTe~DWM4f6s@`L From 280901e5fbd0c2dabd14d7a9b69a073f6e8f87e4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Petazzoni?= Date: Fri, 9 Aug 2013 15:53:02 -0700 Subject: [PATCH 32/55] add -insecure flag and relevant tests --- container.go | 3 +++ container_test.go | 32 ++++++++++++++++++++++++ docs/sources/commandline/command/run.rst | 13 ++++++++++ lxc_template.go | 9 ++++++- 4 files changed, 56 insertions(+), 1 deletion(-) diff --git a/container.go b/container.go index 8721d45a5..c20ee11f5 100644 --- a/container.go +++ b/container.go @@ -78,6 +78,7 @@ type Config struct { VolumesFrom string Entrypoint []string NetworkDisabled bool + Privileged bool } type HostConfig struct { @@ -108,6 +109,7 @@ func ParseRun(args []string, capabilities *Capabilities) (*Config, *HostConfig, flMemory := cmd.Int64("m", 0, "Memory limit (in bytes)") flContainerIDFile := cmd.String("cidfile", "", "Write the container ID to the file") flNetwork := cmd.Bool("n", true, "Enable networking for this container") + flPrivileged := cmd.Bool("privileged", false, "Give extended privileges to this container") if capabilities != nil && *flMemory > 0 && !capabilities.MemoryLimit { //fmt.Fprintf(stdout, "WARNING: Your kernel does not support memory limit capabilities. Limitation discarded.\n") @@ -194,6 +196,7 @@ func ParseRun(args []string, capabilities *Capabilities) (*Config, *HostConfig, Volumes: flVolumes, VolumesFrom: *flVolumesFrom, Entrypoint: entrypoint, + Privileged: *flPrivileged, } hostConfig := &HostConfig{ Binds: binds, diff --git a/container_test.go b/container_test.go index 1050bfb2a..0bab8ea8f 100644 --- a/container_test.go +++ b/container_test.go @@ -1313,3 +1313,35 @@ func TestOnlyLoopbackExistsWhenUsingDisableNetworkOption(t *testing.T) { } } + +func TestPrivilegedCanMknod(t *testing.T) { + runtime := mkRuntime(t) + defer nuke(runtime) + if output, _ := runContainer(runtime, []string{"-privileged", "_", "sh", "-c", "mknod /tmp/sda b 8 0 && echo ok"}, t); output != "ok\n" { + t.Fatal("Could not mknod into privileged container") + } +} + +func TestPrivilegedCanMount(t *testing.T) { + runtime := mkRuntime(t) + defer nuke(runtime) + if output, _ := runContainer(runtime, []string{"-privileged", "_", "sh", "-c", "mount -t tmpfs none /tmp && echo ok"}, t); output != "ok\n" { + t.Fatal("Could not mount into privileged container") + } +} + +func TestPrivilegedCannotMknod(t *testing.T) { + runtime := mkRuntime(t) + defer nuke(runtime) + if output, _ := runContainer(runtime, []string{"_", "sh", "-c", "mknod /tmp/sda b 8 0 || echo ok"}, t); output != "ok\n" { + t.Fatal("Could mknod into secure container") + } +} + +func TestPrivilegedCannotMount(t *testing.T) { + runtime := mkRuntime(t) + defer nuke(runtime) + if output, _ := runContainer(runtime, []string{"_", "sh", "-c", "mount -t tmpfs none /tmp || echo ok"}, t); output != "ok\n" { + t.Fatal("Could mount into secure container") + } +} diff --git a/docs/sources/commandline/command/run.rst b/docs/sources/commandline/command/run.rst index c5b363d78..2e3e96e46 100644 --- a/docs/sources/commandline/command/run.rst +++ b/docs/sources/commandline/command/run.rst @@ -19,6 +19,7 @@ -e=[]: Set environment variables -h="": Container host name -i=false: Keep stdin open even if not attached + -privileged=false: Give extended privileges to this container -m=0: Memory limit (in bytes) -n=true: Enable networking for this container -p=[]: Map a network port to the container @@ -38,3 +39,15 @@ Examples docker run -cidfile /tmp/docker_test.cid ubuntu echo "test" | This will create a container and print "test" to the console. The cidfile flag makes docker attempt to create a new file and write the container ID to it. If the file exists already, docker will return an error. Docker will close this file when docker run exits. + +.. code-block:: bash + + docker run mount -t tmpfs none /var/spool/squid + +| This will *not* work, because by default, most potentially dangerous kernel capabilities are dropped; including ``cap_sys_admin`` (which is required to mount filesystems). However, the ``-privileged`` flag will allow it to run: + +.. code-block:: bash + + docker run -privileged mount -t tmpfs none /var/spool/squid + +| The ``-privileged`` flag gives *all* capabilities to the container, and it also lifts all the limitations enforced by the ``device`` cgroup controller. In other words, the container can then do almost everything that the host can do. This flag exists to allow special use-cases, like running Docker within Docker. diff --git a/lxc_template.go b/lxc_template.go index d49d66b4d..3ab2d2c86 100644 --- a/lxc_template.go +++ b/lxc_template.go @@ -40,6 +40,9 @@ lxc.console = none # no controlling tty at all lxc.tty = 1 +{{if .Config.Privileged}} +lxc.cgroup.devices.allow = a +{{else}} # no implicit access to devices lxc.cgroup.devices.deny = a @@ -69,7 +72,7 @@ lxc.cgroup.devices.allow = c 10:200 rwm # rtc #lxc.cgroup.devices.allow = c 254:0 rwm - +{{end}} # standard mount point # WARNING: procfs is a known attack vector and should probably be disabled @@ -95,11 +98,15 @@ lxc.mount.entry = {{$realPath}} {{$ROOTFS}}/{{$virtualPath}} none bind,{{ if ind {{end}} {{end}} +{{if .Config.Privileged}} +# retain all capabilities; no lxc.cap.drop line +{{else}} # drop linux capabilities (apply mainly to the user root in the container) # (Note: 'lxc.cap.keep' is coming soon and should replace this under the # security principle 'deny all unless explicitly permitted', see # http://sourceforge.net/mailarchive/message.php?msg_id=31054627 ) lxc.cap.drop = audit_control audit_write mac_admin mac_override mknod setfcap setpcap sys_admin sys_boot sys_module sys_nice sys_pacct sys_rawio sys_resource sys_time sys_tty_config +{{end}} # limits {{if .Config.Memory}} From 6c87db97a629f3d7b7f6e276a515506bcca8dbb1 Mon Sep 17 00:00:00 2001 From: Thatcher Peskens Date: Tue, 13 Aug 2013 16:28:24 -0700 Subject: [PATCH 33/55] Resolved conflict in conf.py ps. also changed navigation (swapped community and getting started) --- docs/sources/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/sources/conf.py b/docs/sources/conf.py index 0a58279b0..7aa27c7b8 100644 --- a/docs/sources/conf.py +++ b/docs/sources/conf.py @@ -51,7 +51,6 @@ source_suffix = '.rst' # The encoding of source files. #source_encoding = 'utf-8-sig' -#disable the parmalinks on headers, I find them really annoying html_add_permalinks = u'¶' # The master toctree document. From 44eb1b3892cdcf3bda6478119d90cb69eafbc481 Mon Sep 17 00:00:00 2001 From: Kawsar Saiyeed Date: Wed, 14 Aug 2013 02:45:03 +0100 Subject: [PATCH 34/55] Limit commands to containers of a relevant state --- contrib/docker.bash | 44 +++++++++++++++++++++++++++++--------------- 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/contrib/docker.bash b/contrib/docker.bash index b9fb2ec6e..6719ef6a9 100644 --- a/contrib/docker.bash +++ b/contrib/docker.bash @@ -22,13 +22,27 @@ # must have access to the socket for the completions to function correctly have docker && { -__docker_containers() +__docker_containers_all() { local containers containers="$( docker ps -a -q )" COMPREPLY=( $( compgen -W "$containers" -- "$cur" ) ) } +__docker_containers_running() +{ + local containers + containers="$( docker ps -q )" + COMPREPLY=( $( compgen -W "$containers" -- "$cur" ) ) +} + +__docker_containers_stopped() +{ + local containers + containers="$( comm -13 <(docker ps -q | sort -u) <(docker ps -a -q | sort -u) )" + COMPREPLY=( $( compgen -W "$containers" -- "$cur" ) ) +} + __docker_image_repos() { local repos @@ -85,7 +99,7 @@ _docker_docker() _docker_attach() { if [ $cpos -eq $cword ]; then - __docker_containers + __docker_containers_running fi } @@ -124,7 +138,7 @@ _docker_commit() COMPREPLY=( $( compgen -W "-author -m -run" -- "$cur" ) ) ;; *) - __docker_containers + __docker_containers_all ;; esac } @@ -132,7 +146,7 @@ _docker_commit() _docker_diff() { if [ $cpos -eq $cword ]; then - __docker_containers + __docker_containers_all fi } @@ -144,7 +158,7 @@ _docker_events() _docker_export() { if [ $cpos -eq $cword ]; then - __docker_containers + __docker_containers_all fi } @@ -212,7 +226,7 @@ _docker_inspect() _docker_kill() { - __docker_containers + __docker_containers_running } _docker_login() @@ -223,14 +237,14 @@ _docker_login() _docker_logs() { if [ $cpos -eq $cword ]; then - __docker_containers + __docker_containers_all fi } _docker_port() { if [ $cpos -eq $cword ]; then - __docker_containers + __docker_containers_all fi } @@ -264,7 +278,7 @@ _docker_restart() COMPREPLY=( $( compgen -W "-t" -- "$cur" ) ) ;; *) - __docker_containers + __docker_containers_all ;; esac } @@ -276,7 +290,7 @@ _docker_rm() COMPREPLY=( $( compgen -W "-v" -- "$cur" ) ) ;; *) - __docker_containers + __docker_containers_stopped ;; esac } @@ -293,7 +307,7 @@ _docker_run() _filedir ;; -volumes-from) - __docker_containers + __docker_containers_all ;; -a|-c|-dns|-e|-entrypoint|-h|-m|-p|-u|-v) return @@ -343,7 +357,7 @@ _docker_search() _docker_start() { - __docker_containers + __docker_containers_stopped } _docker_stop() @@ -361,7 +375,7 @@ _docker_stop() COMPREPLY=( $( compgen -W "-t" -- "$cur" ) ) ;; *) - __docker_containers + __docker_containers_running ;; esac } @@ -374,7 +388,7 @@ _docker_tag() _docker_top() { if [ $cpos -eq $cword ]; then - __docker_containers + __docker_containers_running fi } @@ -385,7 +399,7 @@ _docker_version() _docker_wait() { - __docker_containers + __docker_containers_all } _docker() From 62c0f433fa794092fe2a795784f36fbac7b9feec Mon Sep 17 00:00:00 2001 From: Joffrey F Date: Wed, 14 Aug 2013 05:05:44 +0200 Subject: [PATCH 35/55] brew: Fixed a bug with remote repository builds --- contrib/brew/brew/brew.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contrib/brew/brew/brew.py b/contrib/brew/brew/brew.py index 22fe5b7b4..0d9f0f3e9 100644 --- a/contrib/brew/brew/brew.py +++ b/contrib/brew/brew/brew.py @@ -47,7 +47,7 @@ def build_library(repository=None, branch=None, namespace=None, push=False, logger.info('Cloning docker repo from {0}, branch: {1}'.format( repository, branch)) try: - dst_folder = git.clone_branch(repository, branch) + rep, dst_folder = git.clone_branch(repository, branch) except Exception as e: logger.exception(e) logger.error('Source repository could not be fetched. Check ' @@ -182,4 +182,4 @@ class Summary(object): if logger: logger.info(s + success + details) else: - print s, success, details \ No newline at end of file + print s, success, details From 80ebff0fa49b7813205102431633baba789685fb Mon Sep 17 00:00:00 2001 From: "Frederick F. Kautz IV" Date: Tue, 13 Aug 2013 22:28:41 -0700 Subject: [PATCH 36/55] Install script should be fetched over https, not http. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5eee1a3db..ed2709158 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ Quick install on Ubuntu 12.04 and 12.10 --------------------------------------- ```bash -curl get.docker.io | sudo sh -x +curl https://get.docker.io | sudo sh -x ``` Binary installs From 3c9f9945c949e981a4c09da915ea28356b2c58ae Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Wed, 14 Aug 2013 10:26:18 +0000 Subject: [PATCH 37/55] prevent crash when .dockercfg not readable --- auth/auth.go | 2 +- commands.go | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/auth/auth.go b/auth/auth.go index b9e1ee153..003a6e737 100644 --- a/auth/auth.go +++ b/auth/auth.go @@ -80,7 +80,7 @@ func LoadConfig(rootPath string) (*ConfigFile, error) { } b, err := ioutil.ReadFile(confFile) if err != nil { - return nil, err + return &configFile, err } if err := json.Unmarshal(b, &configFile.Configs); err != nil { diff --git a/commands.go b/commands.go index e920aa3c4..6f5c3bc1f 100644 --- a/commands.go +++ b/commands.go @@ -1751,7 +1751,10 @@ func NewDockerCli(in io.ReadCloser, out, err io.Writer, proto, addr string) *Doc err = out } - configFile, _ := auth.LoadConfig(os.Getenv("HOME")) + configFile, e := auth.LoadConfig(os.Getenv("HOME")) + if e != nil { + fmt.Fprintf(err, "WARNING: %s\n", e) + } return &DockerCli{ proto: proto, addr: addr, From c84d74df8c17f50c8ca7f5027ade4db8360f5ed3 Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Wed, 14 Aug 2013 16:59:21 +0000 Subject: [PATCH 38/55] add missing ParseRepositoryTag --- server.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/server.go b/server.go index 16b59dc83..4660918e8 100644 --- a/server.go +++ b/server.go @@ -955,11 +955,11 @@ func (srv *Server) deleteImage(img *Image, repoName, tag string) ([]APIRmi, erro //If delete by id, see if the id belong only to one repository if strings.Contains(img.ID, repoName) && tag == "" { for _, repoAndTag := range srv.runtime.repositories.ByID()[img.ID] { - parsedRepo := strings.Split(repoAndTag, ":")[0] + parsedRepo, parsedTag := utils.ParseRepositoryTag(repoAndTag) if strings.Contains(img.ID, repoName) { repoName = parsedRepo - if len(srv.runtime.repositories.ByID()[img.ID]) == 1 && len(strings.Split(repoAndTag, ":")) > 1 { - tag = strings.Split(repoAndTag, ":")[1] + if len(srv.runtime.repositories.ByID()[img.ID]) == 1 && len(parsedTag) > 1 { + tag = parsedTag } } else if repoName != parsedRepo { // the id belongs to multiple repos, like base:latest and user:test, From 49597f0f52d824967779ce26e720a5f3bab54d3e Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Wed, 14 Aug 2013 10:12:08 -0700 Subject: [PATCH 39/55] testing, issue #1544: Add new docker dependencies into docker-ci --- testing/Vagrantfile | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/testing/Vagrantfile b/testing/Vagrantfile index e76a95150..033f14b3d 100644 --- a/testing/Vagrantfile +++ b/testing/Vagrantfile @@ -22,7 +22,10 @@ Vagrant::Config.run do |config| # Deploy buildbot and its dependencies if it was not done if Dir.glob("#{File.dirname(__FILE__)}/.vagrant/machines/default/*/id").empty? - pkg_cmd = "apt-get update -qq; apt-get install -q -y linux-image-generic-lts-raring; " + # Add memory limitation capabilities + pkg_cmd = 'sed -Ei \'s/^(GRUB_CMDLINE_LINUX_DEFAULT)=.+/\\1="cgroup_enable=memory swapaccount=1 quiet"/\' /etc/default/grub; ' + # Install new kernel + pkg_cmd << "apt-get update -qq; apt-get install -q -y linux-image-generic-lts-raring; " # Deploy buildbot CI pkg_cmd << "apt-get install -q -y python-dev python-pip supervisor; " \ "pip install -r #{CFG_PATH}/requirements.txt; " \ @@ -35,7 +38,7 @@ Vagrant::Config.run do |config| # Install docker dependencies pkg_cmd << "apt-get install -q -y python-software-properties; " \ "add-apt-repository -y ppa:dotcloud/docker-golang/ubuntu; apt-get update -qq; " \ - "DEBIAN_FRONTEND=noninteractive apt-get install -q -y lxc git golang-stable aufs-tools make; " + "DEBIAN_FRONTEND=noninteractive apt-get install -q -y lxc git mercurial golang-stable aufs-tools make; " # Activate new kernel pkg_cmd << "shutdown -r +1; " config.vm.provision :shell, :inline => pkg_cmd From 1d8562b290d636c61aba13e8148963210c5f89aa Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Wed, 14 Aug 2013 14:27:46 -0700 Subject: [PATCH 40/55] testing, issue #1542: Add docker dependencies coverage testing into docker-ci --- testing/buildbot/master.cfg | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/testing/buildbot/master.cfg b/testing/buildbot/master.cfg index 29926dbe5..05dcacbf5 100644 --- a/testing/buildbot/master.cfg +++ b/testing/buildbot/master.cfg @@ -66,8 +66,9 @@ c['builders'] = [BuilderConfig(name=BUILDER_NAME,slavenames=['buildworker'], # Docker coverage test coverage_cmd = ('GOPATH=`pwd` go get -d github.com/dotcloud/docker\n' 'GOPATH=`pwd` go get github.com/axw/gocov/gocov\n' - 'sudo -E GOPATH=`pwd` ./bin/gocov test github.com/dotcloud/docker | ' - './bin/gocov report') + 'sudo -E GOPATH=`pwd` ./bin/gocov test -deps -exclude-goroot -v' + ' -exclude github.com/gorilla/context,github.com/gorilla/mux,github.com/kr/pty,' + 'code.google.com/p/go.net/websocket github.com/dotcloud/docker | ./bin/gocov report') factory = BuildFactory() factory.addStep(ShellCommand(description='Coverage',logEnviron=False,usePTY=True, command=coverage_cmd)) From 8b26e4ea3c92748a96b90fa245ccce7c7eebb81c Mon Sep 17 00:00:00 2001 From: shin- Date: Wed, 14 Aug 2013 23:31:18 +0200 Subject: [PATCH 41/55] brew: docker-py requirement points to git repository --- contrib/brew/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/brew/requirements.txt b/contrib/brew/requirements.txt index 6100b01d0..2f4400d20 100644 --- a/contrib/brew/requirements.txt +++ b/contrib/brew/requirements.txt @@ -1,2 +1,2 @@ dulwich==0.9.0 -docker-py==0.1.4 \ No newline at end of file +-e git://github.com/dotcloud/docker-py.git#egg=docker-py From d4eab77f0c604e10f63519833dc25fbd5a3419bf Mon Sep 17 00:00:00 2001 From: Andy Rothfusz Date: Tue, 13 Aug 2013 18:05:35 -0700 Subject: [PATCH 42/55] Fix #1517, #1521 by adding sudo to examples and installation. --- docs/sources/commandline/cli.rst | 2 +- docs/sources/commandline/command/build.rst | 40 ++++--- docs/sources/commandline/command/commit.rst | 3 +- docs/sources/commandline/command/images.rst | 2 +- docs/sources/commandline/command/import.rst | 19 ++-- docs/sources/commandline/command/run.rst | 19 +++- docs/sources/commandline/command/search.rst | 4 +- docs/sources/contributing/devenvironment.rst | 31 +++--- .../sources/examples/couchdb_data_volumes.rst | 21 ++-- docs/sources/examples/hello_world.rst | 14 +-- docs/sources/examples/hello_world_daemon.rst | 37 ++++--- docs/sources/examples/nodejs_web_app.rst | 41 +++---- docs/sources/examples/postgresql_service.rst | 42 ++++---- docs/sources/examples/python_web_app.rst | 54 ++++++---- docs/sources/examples/running_examples.rst | 11 +- .../examples/running_redis_service.rst | 15 +-- docs/sources/examples/running_ssh_service.rst | 14 ++- docs/sources/installation/amazon.rst | 2 +- docs/sources/installation/binaries.rst | 4 +- docs/sources/installation/ubuntulinux.rst | 4 +- docs/sources/installation/vagrant.rst | 2 +- docs/sources/use/basics.rst | 100 ++++++++++++------ docs/sources/use/builder.rst | 4 +- docs/sources/use/port_redirection.rst | 19 ++-- docs/sources/use/puppet.rst | 18 ++-- docs/sources/use/workingwithrepository.rst | 14 +-- 26 files changed, 326 insertions(+), 210 deletions(-) diff --git a/docs/sources/commandline/cli.rst b/docs/sources/commandline/cli.rst index bdc4827a6..6d9688647 100644 --- a/docs/sources/commandline/cli.rst +++ b/docs/sources/commandline/cli.rst @@ -13,7 +13,7 @@ Docker Usage To list available commands, either run ``docker`` with no parameters or execute ``docker help``:: - $ docker + $ sudo docker Usage: docker [OPTIONS] COMMAND [arg...] -H=[tcp://127.0.0.1:4243]: tcp://host:port to bind/connect to or unix://path/to/socket to use diff --git a/docs/sources/commandline/command/build.rst b/docs/sources/commandline/command/build.rst index 80e5d2c64..cc36aa0dd 100644 --- a/docs/sources/commandline/command/build.rst +++ b/docs/sources/commandline/command/build.rst @@ -21,32 +21,44 @@ Examples .. code-block:: bash - docker build . + sudo docker build . -| This will read the Dockerfile from the current directory. It will also send any other files and directories found in the current directory to the docker daemon. -| The contents of this directory would be used by ADD commands found within the Dockerfile. -| This will send a lot of data to the docker daemon if the current directory contains a lot of data. -| If the absolute path is provided instead of '.', only the files and directories required by the ADD commands from the Dockerfile will be added to the context and transferred to the docker daemon. -| +This will read the ``Dockerfile`` from the current directory. It will +also send any other files and directories found in the current +directory to the ``docker`` daemon. + +The contents of this directory would be used by ``ADD`` commands found +within the ``Dockerfile``. This will send a lot of data to the +``docker`` daemon if the current directory contains a lot of data. If +the absolute path is provided instead of ``.`` then only the files and +directories required by the ADD commands from the ``Dockerfile`` will be +added to the context and transferred to the ``docker`` daemon. .. code-block:: bash - docker build -t vieux/apache:2.0 . + sudo docker build -t vieux/apache:2.0 . -| This will build like the preview example, but it will then tag the resulting image, the repository name will be 'vieux/apache' and the tag will be '2.0' +This will build like the previous example, but it will then tag the +resulting image. The repository name will be ``vieux/apache`` and the +tag will be ``2.0`` .. code-block:: bash - docker build - < Dockerfile + sudo docker build - < Dockerfile -| This will read a Dockerfile from Stdin without context. Due to the lack of a context, no contents of any local directory will be sent to the docker daemon. -| ADD doesn't work when running in this mode due to the absence of the context, thus having no source files to copy to the container. +This will read a ``Dockerfile`` from *stdin* without context. Due to +the lack of a context, no contents of any local directory will be sent +to the ``docker`` daemon. ``ADD`` doesn't work when running in this +mode because the absence of the context provides no source files to +copy to the container. .. code-block:: bash - docker build github.com/creack/docker-firefox + sudo docker build github.com/creack/docker-firefox -| This will clone the github repository and use it as context. The Dockerfile at the root of the repository is used as Dockerfile. -| Note that you can specify an arbitrary git repository by using the 'git://' schema. +This will clone the Github repository and use it as context. The +``Dockerfile`` at the root of the repository is used as +``Dockerfile``. Note that you can specify an arbitrary git repository +by using the ``git://`` schema. diff --git a/docs/sources/commandline/command/commit.rst b/docs/sources/commandline/command/commit.rst index 92f320566..64d74157f 100644 --- a/docs/sources/commandline/command/commit.rst +++ b/docs/sources/commandline/command/commit.rst @@ -14,7 +14,8 @@ -m="": Commit message -author="": Author (eg. "John Hannibal Smith " - -run="": Config automatically applied when the image is run. "+`(ex: {"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}') + -run="": Config automatically applied when the image is + run. "+`(ex: {"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}') Full -run example:: diff --git a/docs/sources/commandline/command/images.rst b/docs/sources/commandline/command/images.rst index 497bda6e1..ec8b9f051 100644 --- a/docs/sources/commandline/command/images.rst +++ b/docs/sources/commandline/command/images.rst @@ -21,6 +21,6 @@ Displaying images visually :: - docker images -viz | dot -Tpng -o docker.png + sudo docker images -viz | dot -Tpng -o docker.png .. image:: images/docker_images.gif diff --git a/docs/sources/commandline/command/import.rst b/docs/sources/commandline/command/import.rst index 0083068e1..e236c5bc2 100644 --- a/docs/sources/commandline/command/import.rst +++ b/docs/sources/commandline/command/import.rst @@ -12,10 +12,11 @@ Create a new filesystem image from the contents of a tarball -At this time, the URL must start with ``http`` and point to a single file archive -(.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) -containing a root filesystem. If you would like to import from a local directory or archive, -you can use the ``-`` parameter to take the data from standard in. +At this time, the URL must start with ``http`` and point to a single +file archive (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) containing a +root filesystem. If you would like to import from a local directory or +archive, you can use the ``-`` parameter to take the data from +standard in. Examples -------- @@ -23,19 +24,21 @@ Examples Import from a remote location ............................. -``$ docker import http://example.com/exampleimage.tgz exampleimagerepo`` +``$ sudo docker import http://example.com/exampleimage.tgz exampleimagerepo`` Import from a local file ........................ Import to docker via pipe and standard in -``$ cat exampleimage.tgz | docker import - exampleimagelocal`` +``$ cat exampleimage.tgz | sudo docker import - exampleimagelocal`` Import from a local directory ............................. ``$ sudo tar -c . | docker import - exampleimagedir`` -Note the ``sudo`` in this example -- you must preserve the ownership of the files (especially root ownership) -during the archiving with tar. If you are not root (or sudo) when you tar, then the ownerships might not get preserved. +Note the ``sudo`` in this example -- you must preserve the ownership +of the files (especially root ownership) during the archiving with +tar. If you are not root (or sudo) when you tar, then the ownerships +might not get preserved. diff --git a/docs/sources/commandline/command/run.rst b/docs/sources/commandline/command/run.rst index e50290a14..46b206a20 100644 --- a/docs/sources/commandline/command/run.rst +++ b/docs/sources/commandline/command/run.rst @@ -36,18 +36,29 @@ Examples .. code-block:: bash - docker run -cidfile /tmp/docker_test.cid ubuntu echo "test" + sudo docker run -cidfile /tmp/docker_test.cid ubuntu echo "test" -| This will create a container and print "test" to the console. The cidfile flag makes docker attempt to create a new file and write the container ID to it. If the file exists already, docker will return an error. Docker will close this file when docker run exits. +This will create a container and print "test" to the console. The +``cidfile`` flag makes docker attempt to create a new file and write the +container ID to it. If the file exists already, docker will return an +error. Docker will close this file when docker run exits. .. code-block:: bash docker run mount -t tmpfs none /var/spool/squid -| This will *not* work, because by default, most potentially dangerous kernel capabilities are dropped; including ``cap_sys_admin`` (which is required to mount filesystems). However, the ``-privileged`` flag will allow it to run: +This will *not* work, because by default, most potentially dangerous +kernel capabilities are dropped; including ``cap_sys_admin`` (which is +required to mount filesystems). However, the ``-privileged`` flag will +allow it to run: .. code-block:: bash docker run -privileged mount -t tmpfs none /var/spool/squid -| The ``-privileged`` flag gives *all* capabilities to the container, and it also lifts all the limitations enforced by the ``device`` cgroup controller. In other words, the container can then do almost everything that the host can do. This flag exists to allow special use-cases, like running Docker within Docker. +The ``-privileged`` flag gives *all* capabilities to the container, +and it also lifts all the limitations enforced by the ``device`` +cgroup controller. In other words, the container can then do almost +everything that the host can do. This flag exists to allow special +use-cases, like running Docker within Docker. + diff --git a/docs/sources/commandline/command/search.rst b/docs/sources/commandline/command/search.rst index 2f07e20c3..8107016a4 100644 --- a/docs/sources/commandline/command/search.rst +++ b/docs/sources/commandline/command/search.rst @@ -10,5 +10,5 @@ Usage: docker search TERM - Searches for the TERM parameter on the Docker index and prints out a list of repositories - that match. + Searches for the TERM parameter on the Docker index and prints out + a list of repositories that match. diff --git a/docs/sources/contributing/devenvironment.rst b/docs/sources/contributing/devenvironment.rst index 869cc4374..564d6f658 100644 --- a/docs/sources/contributing/devenvironment.rst +++ b/docs/sources/contributing/devenvironment.rst @@ -5,18 +5,23 @@ Setting Up a Dev Environment ============================ -To make it easier to contribute to Docker, we provide a standard development environment. It is important that -the same environment be used for all tests, builds and releases. The standard development environment defines -all build dependencies: system libraries and binaries, go environment, go dependencies, etc. +To make it easier to contribute to Docker, we provide a standard +development environment. It is important that the same environment be +used for all tests, builds and releases. The standard development +environment defines all build dependencies: system libraries and +binaries, go environment, go dependencies, etc. Step 1: install docker ---------------------- -Docker's build environment itself is a docker container, so the first step is to install docker on your system. +Docker's build environment itself is a Docker container, so the first +step is to install docker on your system. -You can follow the `install instructions most relevant to your system `. -Make sure you have a working, up-to-date docker installation, then continue to the next step. +You can follow the `install instructions most relevant to your system +`_. Make sure you have +a working, up-to-date docker installation, then continue to the next +step. Step 2: check out the source @@ -35,24 +40,24 @@ When you are ready to build docker, run this command: :: - docker build -t docker . + sudo docker build -t docker . -This will build the revision currently checked out in the repository. Feel free to check out the version -of your choice. +This will build the revision currently checked out in the +repository. Feel free to check out the version of your choice. -If the build is successful, congratulations! You have produced a clean build of docker, neatly encapsulated -in a standard build environment. +If the build is successful, congratulations! You have produced a clean +build of docker, neatly encapsulated in a standard build environment. You can run an interactive session in the newly built container: :: - docker run -i -t docker bash + sudo docker run -i -t docker bash To extract the binaries from the container: :: - docker run docker sh -c 'cat $(which docker)' > docker-build && chmod +x docker-build + sudo docker run docker sh -c 'cat $(which docker)' > docker-build && chmod +x docker-build diff --git a/docs/sources/examples/couchdb_data_volumes.rst b/docs/sources/examples/couchdb_data_volumes.rst index 97af733a8..7296a3eea 100644 --- a/docs/sources/examples/couchdb_data_volumes.rst +++ b/docs/sources/examples/couchdb_data_volumes.rst @@ -9,27 +9,29 @@ CouchDB Service .. include:: example_header.inc -Here's an example of using data volumes to share the same data between 2 couchdb containers. -This could be used for hot upgrades, testing different versions of couchdb on the same data, etc. +Here's an example of using data volumes to share the same data between +2 CouchDB containers. This could be used for hot upgrades, testing +different versions of CouchDB on the same data, etc. Create first database --------------------- -Note that we're marking /var/lib/couchdb as a data volume. +Note that we're marking ``/var/lib/couchdb`` as a data volume. .. code-block:: bash - COUCH1=$(docker run -d -v /var/lib/couchdb shykes/couchdb:2013-05-03) + COUCH1=$(sudo docker run -d -v /var/lib/couchdb shykes/couchdb:2013-05-03) Add data to the first database ------------------------------ -We're assuming your docker host is reachable at `localhost`. If not, replace `localhost` with the public IP of your docker host. +We're assuming your docker host is reachable at `localhost`. If not, +replace `localhost` with the public IP of your docker host. .. code-block:: bash HOST=localhost - URL="http://$HOST:$(docker port $COUCH1 5984)/_utils/" + URL="http://$HOST:$(sudo docker port $COUCH1 5984)/_utils/" echo "Navigate to $URL in your browser, and use the couch interface to add data" Create second database @@ -39,7 +41,7 @@ This time, we're requesting shared access to $COUCH1's volumes. .. code-block:: bash - COUCH2=$(docker run -d -volumes-from $COUCH1 shykes/couchdb:2013-05-03) + COUCH2=$(sudo docker run -d -volumes-from $COUCH1 shykes/couchdb:2013-05-03) Browse data on the second database ---------------------------------- @@ -47,7 +49,8 @@ Browse data on the second database .. code-block:: bash HOST=localhost - URL="http://$HOST:$(docker port $COUCH2 5984)/_utils/" + URL="http://$HOST:$(sudo docker port $COUCH2 5984)/_utils/" echo "Navigate to $URL in your browser. You should see the same data as in the first database"'!' -Congratulations, you are running 2 Couchdb containers, completely isolated from each other *except* for their data. +Congratulations, you are running 2 Couchdb containers, completely +isolated from each other *except* for their data. diff --git a/docs/sources/examples/hello_world.rst b/docs/sources/examples/hello_world.rst index 448247e57..26e6f4c8a 100644 --- a/docs/sources/examples/hello_world.rst +++ b/docs/sources/examples/hello_world.rst @@ -11,26 +11,28 @@ Hello World This is the most basic example available for using Docker. -Download the base container +Download the base image (named "ubuntu"): .. code-block:: bash # Download an ubuntu image - docker pull ubuntu + sudo docker pull ubuntu -The *base* image is a minimal *ubuntu* based container, alternatively you can select *busybox*, a bare -minimal linux system. The images are retrieved from the docker repository. +Alternatively to the *ubuntu* image, you can select *busybox*, a bare +minimal Linux system. The images are retrieved from the Docker +repository. .. code-block:: bash #run a simple echo command, that will echo hello world back to the console over standard out. - docker run base /bin/echo hello world + sudo docker run ubuntu /bin/echo hello world **Explanation:** +- **"sudo"** execute the following commands as user *root* - **"docker run"** run a command in a new container -- **"base"** is the image we want to run the command inside of. +- **"ubuntu"** is the image we want to run the command inside of. - **"/bin/echo"** is the command we want to run in the container - **"hello world"** is the input for the echo command diff --git a/docs/sources/examples/hello_world_daemon.rst b/docs/sources/examples/hello_world_daemon.rst index 7d876329d..1d9c4ebe7 100644 --- a/docs/sources/examples/hello_world_daemon.rst +++ b/docs/sources/examples/hello_world_daemon.rst @@ -11,27 +11,35 @@ Hello World Daemon The most boring daemon ever written. -This example assumes you have Docker installed and with the ubuntu image already imported ``docker pull ubuntu``. -We will use the ubuntu image to run a simple hello world daemon that will just print hello world to standard -out every second. It will continue to do this until we stop it. +This example assumes you have Docker installed and with the Ubuntu +image already imported ``docker pull ubuntu``. We will use the Ubuntu +image to run a simple hello world daemon that will just print hello +world to standard out every second. It will continue to do this until +we stop it. **Steps:** .. code-block:: bash - CONTAINER_ID=$(docker run -d ubuntu /bin/sh -c "while true; do echo hello world; sleep 1; done") + CONTAINER_ID=$(sudo docker run -d ubuntu /bin/sh -c "while true; do echo hello world; sleep 1; done") -We are going to run a simple hello world daemon in a new container made from the ubuntu image. +We are going to run a simple hello world daemon in a new container +made from the *ubuntu* image. -- **"docker run -d "** run a command in a new container. We pass "-d" so it runs as a daemon. +- **"docker run -d "** run a command in a new container. We pass "-d" + so it runs as a daemon. - **"ubuntu"** is the image we want to run the command inside of. - **"/bin/sh -c"** is the command we want to run in the container -- **"while true; do echo hello world; sleep 1; done"** is the mini script we want to run, that will just print hello world once a second until we stop it. -- **$CONTAINER_ID** the output of the run command will return a container id, we can use in future commands to see what is going on with this process. +- **"while true; do echo hello world; sleep 1; done"** is the mini + script we want to run, that will just print hello world once a + second until we stop it. +- **$CONTAINER_ID** the output of the run command will return a + container id, we can use in future commands to see what is going on + with this process. .. code-block:: bash - docker logs $CONTAINER_ID + sudo docker logs $CONTAINER_ID Check the logs make sure it is working correctly. @@ -40,16 +48,17 @@ Check the logs make sure it is working correctly. .. code-block:: bash - docker attach $CONTAINER_ID + sudo docker attach $CONTAINER_ID Attach to the container to see the results in realtime. -- **"docker attach**" This will allow us to attach to a background process to see what is going on. +- **"docker attach**" This will allow us to attach to a background + process to see what is going on. - **$CONTAINER_ID** The Id of the container we want to attach too. .. code-block:: bash - docker ps + sudo docker ps Check the process list to make sure it is running. @@ -57,7 +66,7 @@ Check the process list to make sure it is running. .. code-block:: bash - docker stop $CONTAINER_ID + sudo docker stop $CONTAINER_ID Stop the container, since we don't need it anymore. @@ -66,7 +75,7 @@ Stop the container, since we don't need it anymore. .. code-block:: bash - docker ps + sudo docker ps Make sure it is really stopped. diff --git a/docs/sources/examples/nodejs_web_app.rst b/docs/sources/examples/nodejs_web_app.rst index 376dc5c28..cb580c43d 100644 --- a/docs/sources/examples/nodejs_web_app.rst +++ b/docs/sources/examples/nodejs_web_app.rst @@ -9,10 +9,11 @@ Node.js Web App .. include:: example_header.inc -The goal of this example is to show you how you can build your own docker images -from a parent image using a ``Dockerfile`` . We will do that by making a simple -Node.js hello world web application running on CentOS. You can get the full -source code at https://github.com/gasi/docker-node-hello. +The goal of this example is to show you how you can build your own +docker images from a parent image using a ``Dockerfile`` . We will do +that by making a simple Node.js hello world web application running on +CentOS. You can get the full source code at +https://github.com/gasi/docker-node-hello. Create Node.js app ++++++++++++++++++ @@ -109,16 +110,17 @@ Install your app dependencies using npm: # Install app dependencies RUN cd /src; npm install -Your app binds to port ``8080`` so you’ll use the ``EXPOSE`` command to have it -mapped by the docker daemon: +Your app binds to port ``8080`` so you’ll use the ``EXPOSE`` command +to have it mapped by the docker daemon: .. code-block:: bash EXPOSE 8080 -Last but not least, define the command to run your app using ``CMD`` which -defines your runtime, i.e. ``node``, and the path to our app, i.e. -``src/index.js`` (see the step where we added the source to the container): +Last but not least, define the command to run your app using ``CMD`` +which defines your runtime, i.e. ``node``, and the path to our app, +i.e. ``src/index.js`` (see the step where we added the source to the +container): .. code-block:: bash @@ -149,19 +151,20 @@ Your ``Dockerfile`` should now look like this: Building your image +++++++++++++++++++ -Go to the directory that has your ``Dockerfile`` and run the following command -to build a docker image. The ``-t`` flag let’s you tag your image so it’s easier -to find later using the ``docker images`` command: +Go to the directory that has your ``Dockerfile`` and run the following +command to build a docker image. The ``-t`` flag let’s you tag your +image so it’s easier to find later using the ``docker images`` +command: .. code-block:: bash - docker build -t /centos-node-hello . + sudo docker build -t /centos-node-hello . Your image will now be listed by docker: .. code-block:: bash - docker images + sudo docker images > # Example > REPOSITORY TAG ID CREATED @@ -177,17 +180,17 @@ container running in the background. Run the image you previously built: .. code-block:: bash - docker run -d /centos-node-hello + sudo docker run -d /centos-node-hello Print the output of your app: .. code-block:: bash # Get container ID - docker ps + sudo docker ps # Print app output - docker logs + sudo docker logs > # Example > Running on http://localhost:8080 @@ -225,8 +228,8 @@ Now you can call your app using ``curl`` (install if needed via: > > Hello World -We hope this tutorial helped you get up and running with Node.js and CentOS on -docker. You can get the full source code at +We hope this tutorial helped you get up and running with Node.js and +CentOS on docker. You can get the full source code at https://github.com/gasi/docker-node-hello. Continue to :ref:`running_redis_service`. diff --git a/docs/sources/examples/postgresql_service.rst b/docs/sources/examples/postgresql_service.rst index 4ed1ca4be..96b19c881 100644 --- a/docs/sources/examples/postgresql_service.rst +++ b/docs/sources/examples/postgresql_service.rst @@ -31,7 +31,7 @@ Run an interactive shell in Docker container. .. code-block:: bash - docker run -i -t ubuntu /bin/bash + sudo docker run -i -t ubuntu /bin/bash Update its dependencies. @@ -60,9 +60,9 @@ Finally, install PostgreSQL 9.2 apt-get -y install postgresql-9.2 postgresql-client-9.2 postgresql-contrib-9.2 -Now, create a PostgreSQL superuser role that can create databases and other roles. -Following Vagrant's convention the role will be named `docker` with `docker` -password assigned to it. +Now, create a PostgreSQL superuser role that can create databases and +other roles. Following Vagrant's convention the role will be named +`docker` with `docker` password assigned to it. .. code-block:: bash @@ -75,27 +75,27 @@ role. sudo -u postgres createdb -O docker docker -Adjust PostgreSQL configuration so that remote connections to the database are -possible. Make sure that inside ``/etc/postgresql/9.2/main/pg_hba.conf`` you have -following line: +Adjust PostgreSQL configuration so that remote connections to the +database are possible. Make sure that inside +``/etc/postgresql/9.2/main/pg_hba.conf`` you have following line: .. code-block:: bash host all all 0.0.0.0/0 md5 -Additionaly, inside ``/etc/postgresql/9.2/main/postgresql.conf`` uncomment -``listen_address`` so it is as follows: +Additionaly, inside ``/etc/postgresql/9.2/main/postgresql.conf`` +uncomment ``listen_address`` so it is as follows: .. code-block:: bash listen_address='*' -*Note:* this PostgreSQL setup is for development only purposes. Refer to -PostgreSQL documentation how to fine-tune these settings so that it is enough -secure. +*Note:* this PostgreSQL setup is for development only purposes. Refer +to PostgreSQL documentation how to fine-tune these settings so that it +is enough secure. -Create an image and assign it a name. ```` is in the Bash prompt; -you can also locate it using ``docker ps -a``. +Create an image and assign it a name. ```` is in the +Bash prompt; you can also locate it using ``docker ps -a``. .. code-block:: bash @@ -105,7 +105,7 @@ Finally, run PostgreSQL server via ``docker``. .. code-block:: bash - CONTAINER=$(docker run -d -p 5432 \ + CONTAINER=$(sudo docker run -d -p 5432 \ -t /postgresql \ /bin/su postgres -c '/usr/lib/postgresql/9.2/bin/postgres \ -D /var/lib/postgresql/9.2/main \ @@ -115,7 +115,7 @@ Connect the PostgreSQL server using ``psql``. .. code-block:: bash - CONTAINER_IP=$(docker inspect $CONTAINER | grep IPAddress | awk '{ print $2 }' | tr -d ',"') + CONTAINER_IP=$(sudo docker inspect $CONTAINER | grep IPAddress | awk '{ print $2 }' | tr -d ',"') psql -h $CONTAINER_IP -p 5432 -d docker -U docker -W As before, create roles or databases if needed. @@ -132,13 +132,13 @@ Additionally, publish there your newly created image on Docker Index. .. code-block:: bash - docker login + sudo docker login Username: [...] .. code-block:: bash - docker push /postgresql + sudo docker push /postgresql PostgreSQL service auto-launch ------------------------------ @@ -149,10 +149,10 @@ container starts. .. code-block:: bash - docker commit /postgresql -run='{"Cmd": \ + sudo docker commit /postgresql -run='{"Cmd": \ ["/bin/su", "postgres", "-c", "/usr/lib/postgresql/9.2/bin/postgres -D \ /var/lib/postgresql/9.2/main -c \ config_file=/etc/postgresql/9.2/main/postgresql.conf"], PortSpecs": ["5432"]} -From now on, just type ``docker run /postgresql`` and PostgreSQL -should automatically start. +From now on, just type ``docker run /postgresql`` and +PostgreSQL should automatically start. diff --git a/docs/sources/examples/python_web_app.rst b/docs/sources/examples/python_web_app.rst index dae46d66d..92cac00d1 100644 --- a/docs/sources/examples/python_web_app.rst +++ b/docs/sources/examples/python_web_app.rst @@ -9,13 +9,16 @@ Python Web App .. include:: example_header.inc -The goal of this example is to show you how you can author your own docker images using a parent image, making changes to it, and then saving the results as a new image. We will do that by making a simple hello flask web application image. +The goal of this example is to show you how you can author your own +docker images using a parent image, making changes to it, and then +saving the results as a new image. We will do that by making a simple +hello flask web application image. **Steps:** .. code-block:: bash - docker pull shykes/pybuilder + sudo docker pull shykes/pybuilder We are downloading the "shykes/pybuilder" docker image @@ -27,52 +30,66 @@ We set a URL variable that points to a tarball of a simple helloflask web app .. code-block:: bash - BUILD_JOB=$(docker run -d -t shykes/pybuilder:latest /usr/local/bin/buildapp $URL) + BUILD_JOB=$(sudo docker run -d -t shykes/pybuilder:latest /usr/local/bin/buildapp $URL) -Inside of the "shykes/pybuilder" image there is a command called buildapp, we are running that command and passing the $URL variable from step 2 to it, and running the whole thing inside of a new container. BUILD_JOB will be set with the new container_id. +Inside of the "shykes/pybuilder" image there is a command called +buildapp, we are running that command and passing the $URL variable +from step 2 to it, and running the whole thing inside of a new +container. BUILD_JOB will be set with the new container_id. .. code-block:: bash - docker attach $BUILD_JOB + sudo docker attach $BUILD_JOB [...] -While this container is running, we can attach to the new container to see what is going on. Ctrl-C to disconnect. +While this container is running, we can attach to the new container to +see what is going on. Ctrl-C to disconnect. .. code-block:: bash - docker ps -a + sudo docker ps -a -List all docker containers. If this container has already finished running, it will still be listed here. +List all docker containers. If this container has already finished +running, it will still be listed here. .. code-block:: bash - BUILD_IMG=$(docker commit $BUILD_JOB _/builds/github.com/shykes/helloflask/master) + BUILD_IMG=$(sudo docker commit $BUILD_JOB _/builds/github.com/shykes/helloflask/master) -Save the changes we just made in the container to a new image called "_/builds/github.com/hykes/helloflask/master" and save the image id in the BUILD_IMG variable name. +Save the changes we just made in the container to a new image called +``_/builds/github.com/hykes/helloflask/master`` and save the image id in +the BUILD_IMG variable name. .. code-block:: bash - WEB_WORKER=$(docker run -d -p 5000 $BUILD_IMG /usr/local/bin/runapp) + WEB_WORKER=$(sudo docker run -d -p 5000 $BUILD_IMG /usr/local/bin/runapp) -- **"docker run -d "** run a command in a new container. We pass "-d" so it runs as a daemon. -- **"-p 5000"** the web app is going to listen on this port, so it must be mapped from the container to the host system. +- **"docker run -d "** run a command in a new container. We pass "-d" + so it runs as a daemon. +- **"-p 5000"** the web app is going to listen on this port, so it + must be mapped from the container to the host system. - **"$BUILD_IMG"** is the image we want to run the command inside of. - **/usr/local/bin/runapp** is the command which starts the web app. -Use the new image we just created and create a new container with network port 5000, and return the container id and store in the WEB_WORKER variable. +Use the new image we just created and create a new container with +network port 5000, and return the container id and store in the +WEB_WORKER variable. .. code-block:: bash - docker logs $WEB_WORKER + sudo docker logs $WEB_WORKER * Running on http://0.0.0.0:5000/ -View the logs for the new container using the WEB_WORKER variable, and if everything worked as planned you should see the line "Running on http://0.0.0.0:5000/" in the log output. +View the logs for the new container using the WEB_WORKER variable, and +if everything worked as planned you should see the line "Running on +http://0.0.0.0:5000/" in the log output. .. code-block:: bash WEB_PORT=$(docker port $WEB_WORKER 5000) -Look up the public-facing port which is NAT-ed. Find the private port used by the container and store it inside of the WEB_PORT variable. +Look up the public-facing port which is NAT-ed. Find the private port +used by the container and store it inside of the WEB_PORT variable. .. code-block:: bash @@ -80,7 +97,8 @@ Look up the public-facing port which is NAT-ed. Find the private port used by th curl http://127.0.0.1:$WEB_PORT Hello world! -Access the web app using curl. If everything worked as planned you should see the line "Hello world!" inside of your console. +Access the web app using curl. If everything worked as planned you +should see the line "Hello world!" inside of your console. **Video:** diff --git a/docs/sources/examples/running_examples.rst b/docs/sources/examples/running_examples.rst index b6d6444aa..6097f29fe 100644 --- a/docs/sources/examples/running_examples.rst +++ b/docs/sources/examples/running_examples.rst @@ -7,16 +7,17 @@ Running the Examples -------------------- -All the examples assume your machine is running the docker daemon. To run the docker daemon in the background, simply type: +All the examples assume your machine is running the docker daemon. To +run the docker daemon in the background, simply type: .. code-block:: bash sudo docker -d & -Now you can run docker in client mode: all commands will be forwarded to the docker daemon, so the client -can run from any account. +Now you can run docker in client mode: by defalt all commands will be +forwarded to the ``docker`` daemon via a protected Unix socket, so you +must run as root. .. code-block:: bash - # now you can run docker commands from any account. - docker help + sudo docker help diff --git a/docs/sources/examples/running_redis_service.rst b/docs/sources/examples/running_redis_service.rst index 4996802e9..2305980de 100644 --- a/docs/sources/examples/running_redis_service.rst +++ b/docs/sources/examples/running_redis_service.rst @@ -16,12 +16,13 @@ Open a docker container .. code-block:: bash - docker run -i -t base /bin/bash + sudo docker run -i -t ubuntu /bin/bash Building your image ------------------- -Update your docker container, install the redis server. Once installed, exit out of docker. +Update your Docker container, install the Redis server. Once +installed, exit out of the Docker container. .. code-block:: bash @@ -45,7 +46,7 @@ container running in the background. Use your snapshot. .. code-block:: bash - docker run -d -p 6379 /redis /usr/bin/redis-server + sudo docker run -d -p 6379 /redis /usr/bin/redis-server Test 1 ++++++ @@ -54,8 +55,8 @@ Connect to the container with the redis-cli. .. code-block:: bash - docker ps # grab the new container id - docker inspect # grab the ipaddress of the container + sudo docker ps # grab the new container id + sudo docker inspect # grab the ipaddress of the container redis-cli -h -p 6379 redis 10.0.3.32:6379> set docker awesome OK @@ -70,8 +71,8 @@ Connect to the host os with the redis-cli. .. code-block:: bash - docker ps # grab the new container id - docker port 6379 # grab the external port + sudo docker ps # grab the new container id + sudo docker port 6379 # grab the external port ip addr show # grab the host ip address redis-cli -h -p redis 192.168.0.1:49153> set docker awesome diff --git a/docs/sources/examples/running_ssh_service.rst b/docs/sources/examples/running_ssh_service.rst index 821ff8465..8effafc82 100644 --- a/docs/sources/examples/running_ssh_service.rst +++ b/docs/sources/examples/running_ssh_service.rst @@ -12,8 +12,16 @@ SSH Daemon Service **Video:** -I've create a little screencast to show how to create a sshd service and connect to it. It is something like 11 -minutes and not entirely smooth, but gives you a good idea. +I've create a little screencast to show how to create a sshd service +and connect to it. It is something like 11 minutes and not entirely +smooth, but gives you a good idea. + +.. note:: + This screencast was created before ``docker`` version 0.5.2, so the + daemon is unprotected and available via a TCP port. When you run + through the same steps in a newer version of ``docker``, you will + need to add ``sudo`` in front of each ``docker`` command in order + to reach the daemon over its protected Unix socket. .. raw:: html @@ -24,7 +32,7 @@ minutes and not entirely smooth, but gives you a good idea. You can also get this sshd container by using :: - docker pull dhrp/sshd + sudo docker pull dhrp/sshd The password is 'screencast' diff --git a/docs/sources/installation/amazon.rst b/docs/sources/installation/amazon.rst index a537274e9..333374f97 100644 --- a/docs/sources/installation/amazon.rst +++ b/docs/sources/installation/amazon.rst @@ -90,7 +90,7 @@ Docker can now be installed on Amazon EC2 with a single vagrant command. Vagrant .. code-block:: bash - docker + sudo docker Continue with the :ref:`hello_world` example. diff --git a/docs/sources/installation/binaries.rst b/docs/sources/installation/binaries.rst index 6d8778775..24de52814 100644 --- a/docs/sources/installation/binaries.rst +++ b/docs/sources/installation/binaries.rst @@ -56,10 +56,10 @@ Run your first container! .. code-block:: bash # check your docker version - ./docker version + sudo ./docker version # run a container and open an interactive shell in the container - ./docker run -i -t ubuntu /bin/bash + sudo ./docker run -i -t ubuntu /bin/bash diff --git a/docs/sources/installation/ubuntulinux.rst b/docs/sources/installation/ubuntulinux.rst index 587c8fe31..d1103544f 100644 --- a/docs/sources/installation/ubuntulinux.rst +++ b/docs/sources/installation/ubuntulinux.rst @@ -76,7 +76,7 @@ Verify it worked .. code-block:: bash # download the base 'ubuntu' container and run bash inside it while setting up an interactive shell - docker run -i -t ubuntu /bin/bash + sudo docker run -i -t ubuntu /bin/bash # type 'exit' to exit @@ -138,7 +138,7 @@ Verify it worked .. code-block:: bash # download the base 'ubuntu' container and run bash inside it while setting up an interactive shell - docker run -i -t ubuntu /bin/bash + sudo docker run -i -t ubuntu /bin/bash # type exit to exit diff --git a/docs/sources/installation/vagrant.rst b/docs/sources/installation/vagrant.rst index 24a1e9135..28b2a4e22 100644 --- a/docs/sources/installation/vagrant.rst +++ b/docs/sources/installation/vagrant.rst @@ -63,7 +63,7 @@ Now you are in the VM, run docker .. code-block:: bash - docker + sudo docker Continue with the :ref:`hello_world` example. diff --git a/docs/sources/use/basics.rst b/docs/sources/use/basics.rst index a716ab7fa..78f1bf967 100644 --- a/docs/sources/use/basics.rst +++ b/docs/sources/use/basics.rst @@ -9,11 +9,13 @@ The Basics Starting Docker --------------- -If you have used one of the quick install paths', Docker may have been installed with upstart, Ubuntu's -system for starting processes at boot time. You should be able to run ``docker help`` and get output. +If you have used one of the quick install paths', Docker may have been +installed with upstart, Ubuntu's system for starting processes at boot +time. You should be able to run ``sudo docker help`` and get output. -If you get ``docker: command not found`` or something like ``/var/lib/docker/repositories: permission denied`` -you will need to specify the path to it and manually start it. +If you get ``docker: command not found`` or something like +``/var/lib/docker/repositories: permission denied`` you will need to +specify the path to it and manually start it. .. code-block:: bash @@ -27,45 +29,73 @@ Running an interactive shell .. code-block:: bash # Download an ubuntu image - docker pull ubuntu + sudo docker pull ubuntu # Run an interactive shell in the ubuntu image, # allocate a tty, attach stdin and stdout - docker run -i -t ubuntu /bin/bash + sudo docker run -i -t ubuntu /bin/bash -Bind Docker to another host/port or a unix socket +Why ``sudo``? +------------- + +The ``docker`` daemon always runs as root, and since ``docker`` +version 0.5.2, ``docker`` binds to a Unix socket instead of a TCP +port. By default that Unix socket is owned by the user *root*, and so, +by default, you can access it with ``sudo``. + +Starting in version 0.5.3, if you create a Unix group called *docker* +and add users to it, then the ``docker`` daemon will make the +ownership of the Unix socket read/writable by the *docker* group when +the daemon starts. The ``docker`` daemon must always run as root, but +if you run the ``docker`` client as a user in the *docker* group then +you don't need to add ``sudo`` to all the client commands. + +Bind Docker to another host/port or a Unix socket ------------------------------------------------- -With -H it is possible to make the Docker daemon to listen on a specific ip and port. By default, it will listen on 127.0.0.1:4243 to allow only local connections but you can set it to 0.0.0.0:4243 or a specific host ip to give access to everybody. +.. DANGER:: Changing the default ``docker`` daemon binding to a TCP + port or Unix *docker* user group will increase your security risks + by allowing non-root users to potentially gain *root* access on the + host (`e.g. #1369 + `_). Make sure you + control access to ``docker``. -Similarly, the Docker client can use -H to connect to a custom port. +With -H it is possible to make the Docker daemon to listen on a +specific ip and port. By default, it will listen on +``unix:///var/run/docker.sock`` to allow only local connections by the +*root* user. You *could* set it to 0.0.0.0:4243 or a specific host ip to +give access to everybody, but that is **not recommended** because then +it is trivial for someone to gain root access to the host where the +daemon is running. + +Similarly, the Docker client can use ``-H`` to connect to a custom port. + +``-H`` accepts host and port assignment in the following format: +``tcp://[host][:port]`` or ``unix://path`` --H accepts host and port assignment in the following format: tcp://[host][:port] or unix://path For example: -* tcp://host -> tcp connection on host:4243 -* tcp://host:port -> tcp connection on host:port -* tcp://:port -> tcp connection on 127.0.0.1:port -* unix://path/to/socket -> unix socket located at path/to/socket +* ``tcp://host:4243`` -> tcp connection on host:4243 +* ``unix://path/to/socket`` -> unix socket located at ``path/to/socket`` .. code-block:: bash # Run docker in daemon mode sudo /docker -H 0.0.0.0:5555 -d & # Download an ubuntu image - docker -H :5555 pull ubuntu + sudo docker -H :5555 pull ubuntu -You can use multiple -H, for example, if you want to listen -on both tcp and a unix socket +You can use multiple ``-H``, for example, if you want to listen on +both TCP and a Unix socket .. code-block:: bash # Run docker in daemon mode sudo /docker -H tcp://127.0.0.1:4243 -H unix:///var/run/docker.sock -d & - # Download an ubuntu image - docker pull ubuntu - # OR - docker -H unix:///var/run/docker.sock pull ubuntu + # Download an ubuntu image, use default Unix socket + sudo docker pull ubuntu + # OR use the TCP port + sudo docker -H tcp://127.0.0.1:4243 pull ubuntu Starting a long-running worker process -------------------------------------- @@ -73,13 +103,13 @@ Starting a long-running worker process .. code-block:: bash # Start a very useful long-running process - JOB=$(docker run -d ubuntu /bin/sh -c "while true; do echo Hello world; sleep 1; done") + JOB=$(sudo docker run -d ubuntu /bin/sh -c "while true; do echo Hello world; sleep 1; done") # Collect the output of the job so far - docker logs $JOB + sudo docker logs $JOB # Kill the job - docker kill $JOB + sudo docker kill $JOB Listing all running containers @@ -87,7 +117,7 @@ Listing all running containers .. code-block:: bash - docker ps + sudo docker ps Expose a service on a TCP port ------------------------------ @@ -95,10 +125,10 @@ Expose a service on a TCP port .. code-block:: bash # Expose port 4444 of this container, and tell netcat to listen on it - JOB=$(docker run -d -p 4444 ubuntu /bin/nc -l -p 4444) + JOB=$(sudo docker run -d -p 4444 ubuntu /bin/nc -l -p 4444) # Which public port is NATed to my container? - PORT=$(docker port $JOB 4444) + PORT=$(sudo docker port $JOB 4444) # Connect to the public port via the host's public address # Please note that because of how routing works connecting to localhost or 127.0.0.1 $PORT will not work. @@ -107,7 +137,7 @@ Expose a service on a TCP port echo hello world | nc $IP $PORT # Verify that the network connection worked - echo "Daemon received: $(docker logs $JOB)" + echo "Daemon received: $(sudo docker logs $JOB)" Committing (saving) a container state @@ -115,21 +145,23 @@ Committing (saving) a container state Save your containers state to a container image, so the state can be re-used. -When you commit your container only the differences between the image the container was created from -and the current state of the container will be stored (as a diff). See which images you already have -using ``docker images`` +When you commit your container only the differences between the image +the container was created from and the current state of the container +will be stored (as a diff). See which images you already have using +``sudo docker images`` .. code-block:: bash # Commit your container to a new named image - docker commit + sudo docker commit # List your containers - docker images + sudo docker images You now have a image state from which you can create new instances. -Read more about :ref:`working_with_the_repository` or continue to the complete :ref:`cli` +Read more about :ref:`working_with_the_repository` or continue to the +complete :ref:`cli` diff --git a/docs/sources/use/builder.rst b/docs/sources/use/builder.rst index 293ad3206..85d9642e4 100644 --- a/docs/sources/use/builder.rst +++ b/docs/sources/use/builder.rst @@ -25,12 +25,12 @@ describe the steps to assemble the image. Then call ``docker build`` with the path of your source repository as argument: - ``docker build .`` + ``sudo docker build .`` You can specify a repository and tag at which to save the new image if the build succeeds: - ``docker build -t shykes/myapp .`` + ``sudo docker build -t shykes/myapp .`` Docker will run your steps one-by-one, committing the result if necessary, before finally outputting the ID of your new image. diff --git a/docs/sources/use/port_redirection.rst b/docs/sources/use/port_redirection.rst index 5cf848f9e..e16a27c0e 100644 --- a/docs/sources/use/port_redirection.rst +++ b/docs/sources/use/port_redirection.rst @@ -6,20 +6,23 @@ Port redirection ================ -Docker can redirect public tcp ports to your container, so it can be reached over the network. -Port redirection is done on ``docker run`` using the -p flag. +Docker can redirect public TCP ports to your container, so it can be +reached over the network. Port redirection is done on ``docker run`` +using the -p flag. -A port redirect is specified as PUBLIC:PRIVATE, where tcp port PUBLIC will be redirected to -tcp port PRIVATE. As a special case, the public port can be omitted, in which case a random -public port will be allocated. +A port redirect is specified as *PUBLIC:PRIVATE*, where TCP port +*PUBLIC* will be redirected to TCP port *PRIVATE*. As a special case, +the public port can be omitted, in which case a random public port +will be allocated. .. code-block:: bash # A random PUBLIC port is redirected to PRIVATE port 80 on the container - docker run -p 80 + sudo docker run -p 80 # PUBLIC port 80 is redirected to PRIVATE port 80 - docker run -p 80:80 + sudo docker run -p 80:80 -Default port redirects can be built into a container with the EXPOSE build command. +Default port redirects can be built into a container with the +``EXPOSE`` build command. diff --git a/docs/sources/use/puppet.rst b/docs/sources/use/puppet.rst index b89d95d8f..94de76c30 100644 --- a/docs/sources/use/puppet.rst +++ b/docs/sources/use/puppet.rst @@ -9,28 +9,32 @@ Using Puppet .. note:: - Please note this is a community contributed installation path. The only 'official' installation is using the - :ref:`ubuntu_linux` installation path. This version may sometimes be out of date. + Please note this is a community contributed installation path. The + only 'official' installation is using the :ref:`ubuntu_linux` + installation path. This version may sometimes be out of date. Requirements ------------ -To use this guide you'll need a working installation of Puppet from `Puppetlabs `_ . +To use this guide you'll need a working installation of Puppet from +`Puppetlabs `_ . The module also currently uses the official PPA so only works with Ubuntu. Installation ------------ -The module is available on the `Puppet Forge `_ -and can be installed using the built-in module tool. +The module is available on the `Puppet Forge +`_ and can be installed +using the built-in module tool. .. code-block:: bash puppet module install garethr/docker -It can also be found on `GitHub `_ -if you would rather download the source. +It can also be found on `GitHub +`_ if you would rather +download the source. Usage ----- diff --git a/docs/sources/use/workingwithrepository.rst b/docs/sources/use/workingwithrepository.rst index b1ed6fc63..1cb4c9aa9 100644 --- a/docs/sources/use/workingwithrepository.rst +++ b/docs/sources/use/workingwithrepository.rst @@ -57,10 +57,10 @@ address of the registry's host, like this: # Tag to create a repository with the full registry location. # The location (e.g. localhost.localdomain:5000) becomes # a permanent part of the repository name - docker tag 0u812deadbeef localhost.localdomain:5000/repo_name + sudo docker tag 0u812deadbeef localhost.localdomain:5000/repo_name # Push the new repository to its home location on localhost - docker push localhost.localdomain:5000/repo_name + sudo docker push localhost.localdomain:5000/repo_name Once a repository has your registry's host name as part of the tag, you can push and pull it like any other repository, but it will @@ -75,14 +75,14 @@ Search by name, namespace or description .. code-block:: bash - docker search + sudo docker search Download them simply by their name .. code-block:: bash - docker pull + sudo docker pull Very similarly you can search for and browse the index online on @@ -96,7 +96,7 @@ You can create a user on the central Docker Index online, or by running .. code-block:: bash - docker login + sudo docker login This will prompt you for a username, which will become a public namespace for your public repositories. @@ -115,7 +115,7 @@ your container to an image within your username namespace. .. code-block:: bash # for example docker commit $CONTAINER_ID dhrp/kickassapp - docker commit / + sudo docker commit / Pushing a container to its repository @@ -129,4 +129,4 @@ Now you can commit this image to the repository .. code-block:: bash # for example docker push dhrp/kickassapp - docker push / + sudo docker push / From 7f9ba14b18e171589a82e8dd3bd084ece3405f83 Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Wed, 14 Aug 2013 23:43:43 +0000 Subject: [PATCH 43/55] Add imagename to LogEvent tests --- api_test.go | 4 ++-- server_test.go | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/api_test.go b/api_test.go index fb065bb27..fc7eeed71 100644 --- a/api_test.go +++ b/api_test.go @@ -97,8 +97,8 @@ func TestGetEvents(t *testing.T) { listeners: make(map[string]chan utils.JSONMessage), } - srv.LogEvent("fakeaction", "fakeid") - srv.LogEvent("fakeaction2", "fakeid") + srv.LogEvent("fakeaction", "fakeid", "fakeimage") + srv.LogEvent("fakeaction2", "fakeid", "fakeimage") req, err := http.NewRequest("GET", "/events?since=1", nil) if err != nil { diff --git a/server_test.go b/server_test.go index b7ffbb7e6..bcf8009f8 100644 --- a/server_test.go +++ b/server_test.go @@ -317,23 +317,23 @@ func TestLogEvent(t *testing.T) { listeners: make(map[string]chan utils.JSONMessage), } - srv.LogEvent("fakeaction", "fakeid") + srv.LogEvent("fakeaction", "fakeid", "fakeimage") listener := make(chan utils.JSONMessage) srv.Lock() srv.listeners["test"] = listener srv.Unlock() - srv.LogEvent("fakeaction2", "fakeid") + srv.LogEvent("fakeaction2", "fakeid", "fakeimage") if len(srv.events) != 2 { t.Fatalf("Expected 2 events, found %d", len(srv.events)) } go func() { time.Sleep(200 * time.Millisecond) - srv.LogEvent("fakeaction3", "fakeid") + srv.LogEvent("fakeaction3", "fakeid", "fakeimage") time.Sleep(200 * time.Millisecond) - srv.LogEvent("fakeaction4", "fakeid") + srv.LogEvent("fakeaction4", "fakeid", "fakeimage") }() setTimeout(t, "Listening for events timed out", 2*time.Second, func() { From d7979ef2d0044dc7def9238f0a1aed909f0590bb Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Thu, 15 Aug 2013 11:42:40 +0000 Subject: [PATCH 44/55] hot fix display in parallel pull and go fmt --- registry/registry.go | 1 - registry/registry_mock_test.go | 2 +- utils/utils.go | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/registry/registry.go b/registry/registry.go index ba62b3465..ab13000b3 100644 --- a/registry/registry.go +++ b/registry/registry.go @@ -162,7 +162,6 @@ func (r *Registry) GetRemoteHistory(imgID, registry string, token []string) ([]s // Check if an image exists in the Registry func (r *Registry) LookupRemoteImage(imgID, registry string, token []string) bool { - req, err := r.reqFactory.NewRequest("GET", registry+"images/"+imgID+"/json", nil) if err != nil { return false diff --git a/registry/registry_mock_test.go b/registry/registry_mock_test.go index e75231551..6eb94b63c 100644 --- a/registry/registry_mock_test.go +++ b/registry/registry_mock_test.go @@ -343,4 +343,4 @@ func TestWait(t *testing.T) { <-c } -//*/ \ No newline at end of file +//*/ diff --git a/utils/utils.go b/utils/utils.go index 497d7f4e4..6a5beb8e4 100644 --- a/utils/utils.go +++ b/utils/utils.go @@ -645,6 +645,7 @@ func (jm *JSONMessage) Display(out io.Writer) error { } return jm.Error } + fmt.Fprintf(out, "%c[2K\r", 27) if jm.Time != 0 { fmt.Fprintf(out, "[%s] ", time.Unix(jm.Time, 0)) } @@ -655,7 +656,6 @@ func (jm *JSONMessage) Display(out io.Writer) error { fmt.Fprintf(out, "(from %s) ", jm.From) } if jm.Progress != "" { - fmt.Fprintf(out, "%c[2K", 27) fmt.Fprintf(out, "%s %s\r", jm.Status, jm.Progress) } else { fmt.Fprintf(out, "%s\r\n", jm.Status) From 62b45f08278ef283b91cc91761a25f5ceca16136 Mon Sep 17 00:00:00 2001 From: Victor Vieux Date: Thu, 15 Aug 2013 13:44:11 +0000 Subject: [PATCH 45/55] fix can't connect message with socket --- commands.go | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/commands.go b/commands.go index 056bcbfb5..5d8eb90b5 100644 --- a/commands.go +++ b/commands.go @@ -1548,6 +1548,9 @@ func (cli *DockerCli) call(method, path string, data interface{}) ([]byte, int, } dial, err := net.Dial(cli.proto, cli.addr) if err != nil { + if strings.Contains(err.Error(), "connection refused") { + return nil, -1, fmt.Errorf("Can't connect to docker daemon. Is 'docker -d' running on this host?") + } return nil, -1, err } clientconn := httputil.NewClientConn(dial, nil) @@ -1588,6 +1591,9 @@ func (cli *DockerCli) stream(method, path string, in io.Reader, out io.Writer) e } dial, err := net.Dial(cli.proto, cli.addr) if err != nil { + if strings.Contains(err.Error(), "connection refused") { + return fmt.Errorf("Can't connect to docker daemon. Is 'docker -d' running on this host?") + } return err } clientconn := httputil.NewClientConn(dial, nil) @@ -1634,6 +1640,9 @@ func (cli *DockerCli) hijack(method, path string, setRawTerminal bool, in io.Rea dial, err := net.Dial(cli.proto, cli.addr) if err != nil { + if strings.Contains(err.Error(), "connection refused") { + return fmt.Errorf("Can't connect to docker daemon. Is 'docker -d' running on this host?") + } return err } clientconn := httputil.NewClientConn(dial, nil) From bca19a22c50d3ff085c8d7accf35d35e6dde4d6a Mon Sep 17 00:00:00 2001 From: Michael Crosby Date: Thu, 15 Aug 2013 03:58:40 +0000 Subject: [PATCH 46/55] Update readme with dependencies for building Closes #915 --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ed2709158..89767a9cc 100644 --- a/README.md +++ b/README.md @@ -166,8 +166,12 @@ supported. Installing from source ---------------------- -1. Make sure you have a [Go language](http://golang.org/doc/install) -compiler >= 1.1 and [git](http://git-scm.com) installed. +1. Install Dependencies + * [Go language 1.1.x](http://golang.org/doc/install) + * [git](http://git-scm.com) + * [lxc](http://lxc.sourceforge.net) + * [aufs-tools](http://aufs.sourceforge.net) + 2. Checkout the source code ```bash From 2ec141da542ab7563c7104b3a950bc503e4959fb Mon Sep 17 00:00:00 2001 From: Tyler Brock Date: Fri, 16 Aug 2013 13:19:59 -0400 Subject: [PATCH 47/55] Add instructions for creating and using the docker group --- docs/sources/use/basics.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/sources/use/basics.rst b/docs/sources/use/basics.rst index 78f1bf967..106fde22d 100644 --- a/docs/sources/use/basics.rst +++ b/docs/sources/use/basics.rst @@ -50,6 +50,21 @@ the daemon starts. The ``docker`` daemon must always run as root, but if you run the ``docker`` client as a user in the *docker* group then you don't need to add ``sudo`` to all the client commands. +.. code-block:: bash + + # Add the docker group + sudo groupadd docker + + # Add the ubuntu user to the docker group + sudo gpasswd -a ubuntu docker + + # Have the docker group own the docker.sock file + sudo chown root:docker /var/run/docker.sock + + # Restart the docker daemon + sudo service docker restart + + Bind Docker to another host/port or a Unix socket ------------------------------------------------- From 674e5c850374fffa03fb205ae6b623ec069978d9 Mon Sep 17 00:00:00 2001 From: Tyler Brock Date: Fri, 16 Aug 2013 13:29:48 -0400 Subject: [PATCH 48/55] remove extraneous step and stupid whitespace --- docs/sources/use/basics.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/sources/use/basics.rst b/docs/sources/use/basics.rst index 106fde22d..411e1c30d 100644 --- a/docs/sources/use/basics.rst +++ b/docs/sources/use/basics.rst @@ -57,13 +57,9 @@ you don't need to add ``sudo`` to all the client commands. # Add the ubuntu user to the docker group sudo gpasswd -a ubuntu docker - - # Have the docker group own the docker.sock file - sudo chown root:docker /var/run/docker.sock - + # Restart the docker daemon sudo service docker restart - Bind Docker to another host/port or a Unix socket ------------------------------------------------- From 0418702cfc69f3d748c7c8b00da467154944b540 Mon Sep 17 00:00:00 2001 From: shin- Date: Wed, 3 Jul 2013 17:24:43 +0200 Subject: [PATCH 49/55] registry: removing opaqueRequest --- registry/registry.go | 23 +++++++---------------- 1 file changed, 7 insertions(+), 16 deletions(-) diff --git a/registry/registry.go b/registry/registry.go index ab13000b3..759652f07 100644 --- a/registry/registry.go +++ b/registry/registry.go @@ -229,7 +229,8 @@ func (r *Registry) GetRemoteTags(registries []string, repository string, token [ } for _, host := range registries { endpoint := fmt.Sprintf("%srepositories/%s/tags", host, repository) - req, err := r.opaqueRequest("GET", endpoint, nil) + req, err := r.reqFactory.NewRequest("GET", endpoint, nil) + if err != nil { return nil, err } @@ -262,12 +263,11 @@ func (r *Registry) GetRemoteTags(registries []string, repository string, token [ } func (r *Registry) GetRepositoryData(indexEp, remote string) (*RepositoryData, error) { - repositoryTarget := fmt.Sprintf("%srepositories/%s/images", indexEp, remote) utils.Debugf("[registry] Calling GET %s", repositoryTarget) - req, err := r.opaqueRequest("GET", repositoryTarget, nil) + req, err := r.reqFactory.NewRequest("GET", repositoryTarget, nil) if err != nil { return nil, err } @@ -425,22 +425,14 @@ func (r *Registry) PushImageLayerRegistry(imgID string, layer io.Reader, registr return tarsumLayer.Sum(jsonRaw), nil } -func (r *Registry) opaqueRequest(method, urlStr string, body io.Reader) (*http.Request, error) { - req, err := r.reqFactory.NewRequest(method, urlStr, body) - if err != nil { - return nil, err - } - req.URL.Opaque = strings.Replace(urlStr, req.URL.Scheme+":", "", 1) - return req, err -} - // push a tag on the registry. // Remote has the format '/ func (r *Registry) PushRegistryTag(remote, revision, tag, registry string, token []string) error { // "jsonify" the string revision = "\"" + revision + "\"" + path := fmt.Sprintf("repositories/%s/tags/%s", remote, tag) - req, err := r.opaqueRequest("PUT", registry+"repositories/"+remote+"/tags/"+tag, strings.NewReader(revision)) + req, err := r.reqFactory.NewRequest("PUT", registry+path, strings.NewReader(revision)) if err != nil { return err } @@ -479,11 +471,10 @@ func (r *Registry) PushImageJSONIndex(indexEp, remote string, imgList []*ImgData if validate { suffix = "images" } - u := fmt.Sprintf("%srepositories/%s/%s", indexEp, remote, suffix) utils.Debugf("[registry] PUT %s", u) utils.Debugf("Image list pushed to index:\n%s\n", imgListJSON) - req, err := r.opaqueRequest("PUT", u, bytes.NewReader(imgListJSON)) + req, err := r.reqFactory.NewRequest("PUT", u, bytes.NewReader(imgListJSON)) if err != nil { return nil, err } @@ -503,7 +494,7 @@ func (r *Registry) PushImageJSONIndex(indexEp, remote string, imgList []*ImgData // Redirect if necessary for res.StatusCode >= 300 && res.StatusCode < 400 { utils.Debugf("Redirected to %s\n", res.Header.Get("Location")) - req, err = r.opaqueRequest("PUT", res.Header.Get("Location"), bytes.NewReader(imgListJSON)) + req, err = r.reqFactory.NewRequest("PUT", res.Header.Get("Location"), bytes.NewReader(imgListJSON)) if err != nil { return nil, err } From 422d4afdd544656c847ecd4c62a6965d5974eba5 Mon Sep 17 00:00:00 2001 From: Daniel Mizyrycki Date: Fri, 16 Aug 2013 14:44:54 -0700 Subject: [PATCH 50/55] testing, issue #1431: Temporarely disable TestContainerTop from the testsuite --- server_test.go | 1 + 1 file changed, 1 insertion(+) diff --git a/server_test.go b/server_test.go index bcf8009f8..95ebcf245 100644 --- a/server_test.go +++ b/server_test.go @@ -206,6 +206,7 @@ func TestRunWithTooLowMemoryLimit(t *testing.T) { } func TestContainerTop(t *testing.T) { + t.Skip("Fixme. Skipping test for now. Reported error: 'server_test.go:236: Expected 2 processes, found 1.'") runtime := mkRuntime(t) srv := &Server{runtime: runtime} defer nuke(runtime) From 07a887032af78e5014d635f7e1d669d49b50894d Mon Sep 17 00:00:00 2001 From: Evan Phoenix Date: Sat, 17 Aug 2013 20:03:54 -0700 Subject: [PATCH 51/55] Show tag used when image is missing --- commands.go | 7 +++++++ server.go | 8 +++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/commands.go b/commands.go index 056bcbfb5..780ccc1e1 100644 --- a/commands.go +++ b/commands.go @@ -1402,6 +1402,13 @@ func (cli *DockerCli) CmdRun(args ...string) error { body, statusCode, err := cli.call("POST", "/containers/create", config) //if image not found try to pull it if statusCode == 404 { + _, tag := utils.ParseRepositoryTag(config.Image) + if tag == "" { + tag = DEFAULTTAG + } + + fmt.Printf("Unable to find image '%s' (tag: %s) locally\n", config.Image, tag) + v := url.Values{} repos, tag := utils.ParseRepositoryTag(config.Image) v.Set("fromImage", repos) diff --git a/server.go b/server.go index f4e08dcad..561d3c7cf 100644 --- a/server.go +++ b/server.go @@ -828,7 +828,13 @@ func (srv *Server) ContainerCreate(config *Config) (string, error) { container, err := b.Create(config) if err != nil { if srv.runtime.graph.IsNotExist(err) { - return "", fmt.Errorf("No such image: %s", config.Image) + + _, tag := utils.ParseRepositoryTag(config.Image) + if tag == "" { + tag = DEFAULTTAG + } + + return "", fmt.Errorf("No such image: %s (tag: %s)", config.Image, tag) } return "", err } From e6affb1b1ac0a172ce345d14162f6944ec68da4e Mon Sep 17 00:00:00 2001 From: David Calavera Date: Sat, 17 Aug 2013 22:11:34 -0700 Subject: [PATCH 52/55] Sort images by tag name when the creation date is the same. This establishes a strict alphabetical order for tags with the same creation date. --- server.go | 2 +- sorter.go | 10 +++++----- sorter_test.go | 29 ++++++++++++++++++++++++++++- 3 files changed, 34 insertions(+), 7 deletions(-) diff --git a/server.go b/server.go index 5e30dd011..5e019a4c3 100644 --- a/server.go +++ b/server.go @@ -242,7 +242,7 @@ func (srv *Server) Images(all bool, filter string) ([]APIImages, error) { } } - sortImagesByCreation(outs) + sortImagesByCreationAndTag(outs) return outs, nil } diff --git a/sorter.go b/sorter.go index a61be0ef7..a81884148 100644 --- a/sorter.go +++ b/sorter.go @@ -22,15 +22,15 @@ func (s *imageSorter) Less(i, j int) bool { return s.by(&s.images[i], &s.images[j]) } -// Sort []ApiImages by most recent creation date. -func sortImagesByCreation(images []APIImages) { - creation := func(i1, i2 *APIImages) bool { - return i1.Created > i2.Created +// Sort []ApiImages by most recent creation date and tag name. +func sortImagesByCreationAndTag(images []APIImages) { + creationAndTag := func(i1, i2 *APIImages) bool { + return i1.Created > i2.Created || (i1.Created == i2.Created && i2.Tag > i1.Tag) } sorter := &imageSorter{ images: images, - by: creation} + by: creationAndTag} sort.Sort(sorter) } diff --git a/sorter_test.go b/sorter_test.go index 3c4b3b487..5519708ec 100644 --- a/sorter_test.go +++ b/sorter_test.go @@ -4,7 +4,7 @@ import ( "testing" ) -func TestServerListOrderedImages(t *testing.T) { +func TestServerListOrderedImagesByCreationDate(t *testing.T) { runtime := mkRuntime(t) defer nuke(runtime) @@ -28,3 +28,30 @@ func TestServerListOrderedImages(t *testing.T) { t.Error("Expected []APIImges to be ordered by most recent creation date.") } } + +func TestServerListOrderedImagesByCreationDateAndTag(t *testing.T) { + runtime := mkRuntime(t) + defer nuke(runtime) + + archive, err := fakeTar() + if err != nil { + t.Fatal(err) + } + image, err := runtime.graph.Create(archive, nil, "Testing", "", nil) + if err != nil { + t.Fatal(err) + } + + srv := &Server{runtime: runtime} + srv.ContainerTag(image.ID, "repo", "foo", false) + srv.ContainerTag(image.ID, "repo", "bar", false) + + images, err := srv.Images(true, "") + if err != nil { + t.Fatal(err) + } + + if images[0].Created != images[1].Created || images[0].Tag >= images[1].Tag { + t.Error("Expected []APIImges to be ordered by most recent creation date and tag name.") + } +} From 687d27ab575778196ea646b6d3fa61b6c8e512b0 Mon Sep 17 00:00:00 2001 From: Marco Hennings Date: Thu, 15 Aug 2013 20:38:17 +0200 Subject: [PATCH 53/55] Add an option to set the working directory. This makes it possible to simply wrap a command inside a container. This makes it easier to use a container as an unified build environment. Examples: ~/workspace/docker $ docker run -v `pwd`:`pwd` -w `pwd` -i -t ubuntu ls AUTHORS Makefile archive.go changes.go docker [...] docker run -v `pwd`:`pwd` -w `pwd` -i -t ubuntu pwd /home/marco/workspace/docker --- commands_test.go | 63 +++++++++++++++++++++ container.go | 23 ++++++++ docs/sources/api/docker_remote_api_v1.4.rst | 11 +++- docs/sources/commandline/command/run.rst | 20 +++++++ sysinit.go | 11 ++++ 5 files changed, 125 insertions(+), 3 deletions(-) diff --git a/commands_test.go b/commands_test.go index ac30cc73f..db344d704 100644 --- a/commands_test.go +++ b/commands_test.go @@ -90,6 +90,69 @@ func TestRunHostname(t *testing.T) { } +// TestRunWorkdir checks that 'docker run -w' correctly sets a custom working directory +func TestRunWorkdir(t *testing.T) { + stdout, stdoutPipe := io.Pipe() + + cli := NewDockerCli(nil, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr) + defer cleanup(globalRuntime) + + c := make(chan struct{}) + go func() { + defer close(c) + if err := cli.CmdRun("-w", "/foo/bar", unitTestImageID, "pwd"); err != nil { + t.Fatal(err) + } + }() + + setTimeout(t, "Reading command output time out", 2*time.Second, func() { + cmdOutput, err := bufio.NewReader(stdout).ReadString('\n') + if err != nil { + t.Fatal(err) + } + if cmdOutput != "/foo/bar\n" { + t.Fatalf("'pwd' should display '%s', not '%s'", "/foo/bar\n", cmdOutput) + } + }) + + setTimeout(t, "CmdRun timed out", 5*time.Second, func() { + <-c + }) + +} + +// TestRunWorkdirExists checks that 'docker run -w' correctly sets a custom working directory, even if it exists +func TestRunWorkdirExists(t *testing.T) { + stdout, stdoutPipe := io.Pipe() + + cli := NewDockerCli(nil, stdoutPipe, ioutil.Discard, testDaemonProto, testDaemonAddr) + defer cleanup(globalRuntime) + + c := make(chan struct{}) + go func() { + defer close(c) + if err := cli.CmdRun("-w", "/proc", unitTestImageID, "pwd"); err != nil { + t.Fatal(err) + } + }() + + setTimeout(t, "Reading command output time out", 2*time.Second, func() { + cmdOutput, err := bufio.NewReader(stdout).ReadString('\n') + if err != nil { + t.Fatal(err) + } + if cmdOutput != "/proc\n" { + t.Fatalf("'pwd' should display '%s', not '%s'", "/proc\n", cmdOutput) + } + }) + + setTimeout(t, "CmdRun timed out", 5*time.Second, func() { + <-c + }) + +} + + func TestRunExit(t *testing.T) { stdin, stdinPipe := io.Pipe() stdout, stdoutPipe := io.Pipe() diff --git a/container.go b/container.go index 4d38d49fa..472ae3990 100644 --- a/container.go +++ b/container.go @@ -2,6 +2,7 @@ package docker import ( "encoding/json" + "errors" "flag" "fmt" "github.com/dotcloud/docker/term" @@ -76,6 +77,7 @@ type Config struct { Image string // Name of the image as it was passed by the operator (eg. could be symbolic) Volumes map[string]struct{} VolumesFrom string + WorkingDir string Entrypoint []string NetworkDisabled bool Privileged bool @@ -92,6 +94,10 @@ type BindMap struct { Mode string } +var ( + ErrInvaidWorikingDirectory = errors.New("The working directory is invalid. It needs to be an absolute path.") +) + func ParseRun(args []string, capabilities *Capabilities) (*Config, *HostConfig, *flag.FlagSet, error) { cmd := Subcmd("run", "[OPTIONS] IMAGE [COMMAND] [ARG...]", "Run a command in a new container") if len(args) > 0 && args[0] != "--help" { @@ -100,6 +106,7 @@ func ParseRun(args []string, capabilities *Capabilities) (*Config, *HostConfig, } flHostname := cmd.String("h", "", "Container host name") + flWorkingDir := cmd.String("w", "", "Working directory inside the container") flUser := cmd.String("u", "", "Username or UID") flDetach := cmd.Bool("d", false, "Detached mode: Run container in the background, print new container id") flAttach := NewAttachOpts() @@ -139,6 +146,9 @@ func ParseRun(args []string, capabilities *Capabilities) (*Config, *HostConfig, if *flDetach && len(flAttach) > 0 { return nil, nil, cmd, fmt.Errorf("Conflicting options: -a and -d") } + if *flWorkingDir != "" && !path.IsAbs(*flWorkingDir) { + return nil, nil, cmd, ErrInvaidWorikingDirectory + } // If neither -d or -a are set, attach to everything by default if len(flAttach) == 0 && !*flDetach { if !*flDetach { @@ -197,6 +207,7 @@ func ParseRun(args []string, capabilities *Capabilities) (*Config, *HostConfig, VolumesFrom: *flVolumesFrom, Entrypoint: entrypoint, Privileged: *flPrivileged, + WorkingDir: *flWorkingDir, } hostConfig := &HostConfig{ Binds: binds, @@ -666,6 +677,18 @@ func (container *Container) Start(hostConfig *HostConfig) error { "-e", "container=lxc", "-e", "HOSTNAME="+container.Config.Hostname, ) + if container.Config.WorkingDir != "" { + workingDir := path.Clean(container.Config.WorkingDir) + utils.Debugf("[working dir] working dir is %s", workingDir) + + if err := os.MkdirAll(path.Join(container.RootfsPath(), workingDir), 0755); err != nil { + return nil + } + + params = append(params, + "-w", workingDir, + ) + } for _, elem := range container.Config.Env { params = append(params, "-e", elem) diff --git a/docs/sources/api/docker_remote_api_v1.4.rst b/docs/sources/api/docker_remote_api_v1.4.rst index adb0c1dec..14dbfd7c3 100644 --- a/docs/sources/api/docker_remote_api_v1.4.rst +++ b/docs/sources/api/docker_remote_api_v1.4.rst @@ -129,7 +129,9 @@ Create a container "Dns":null, "Image":"base", "Volumes":{}, - "VolumesFrom":"" + "VolumesFrom":"", + "WorkingDir":"" + } **Example response**: @@ -195,7 +197,9 @@ Inspect a container "Dns": null, "Image": "base", "Volumes": {}, - "VolumesFrom": "" + "VolumesFrom": "", + "WorkingDir":"" + }, "State": { "Running": false, @@ -746,7 +750,8 @@ Inspect an image ,"Dns":null, "Image":"base", "Volumes":null, - "VolumesFrom":"" + "VolumesFrom":"", + "WorkingDir":"" }, "Size": 6824592 } diff --git a/docs/sources/commandline/command/run.rst b/docs/sources/commandline/command/run.rst index 46b206a20..bd78ea473 100644 --- a/docs/sources/commandline/command/run.rst +++ b/docs/sources/commandline/command/run.rst @@ -29,6 +29,7 @@ -v=[]: Create a bind mount with: [host-dir]:[container-dir]:[rw|ro]. If "host-dir" is missing, then docker creates a new volume. -volumes-from="": Mount all volumes from the given container. -entrypoint="": Overwrite the default entrypoint set by the image. + -w="": Working directory inside the container Examples @@ -62,3 +63,22 @@ cgroup controller. In other words, the container can then do almost everything that the host can do. This flag exists to allow special use-cases, like running Docker within Docker. +.. code-block:: bash + + docker run -w /path/to/dir/ -i -t ubuntu pwd + +The ``-w`` lets the command beeing executed inside directory given, +here /path/to/dir/. If the path does not exists it is created inside the +container. + +.. code-block:: bash + + docker run -v `pwd`:`pwd` -w `pwd` -i -t ubuntu pwd + +The ``-v`` flag mounts the current working directory into the container. +The ``-w`` lets the command beeing executed inside the current +working directory, by changeing into the directory to the value +returned by ``pwd``. So this combination executes the command +using the container, but inside the current working directory. + + diff --git a/sysinit.go b/sysinit.go index fb36cd254..aa5d2b2a1 100644 --- a/sysinit.go +++ b/sysinit.go @@ -22,6 +22,15 @@ func setupNetworking(gw string) { } } +// Setup working directory +func setupWorkingDirectory(workdir string) { + if workdir == "" { + return + } + syscall.Chdir(workdir) +} + + // Takes care of dropping privileges to the desired user func changeUser(u string) { if u == "" { @@ -83,6 +92,7 @@ func SysInit() { } var u = flag.String("u", "", "username or uid") var gw = flag.String("g", "", "gateway address") + var workdir = flag.String("w", "", "workdir") var flEnv ListOpts flag.Var(&flEnv, "e", "Set environment variables") @@ -91,6 +101,7 @@ func SysInit() { cleanupEnv(flEnv) setupNetworking(*gw) + setupWorkingDirectory(*workdir) changeUser(*u) executeProgram(flag.Arg(0), flag.Args()) } From 319988336ceed4428de0e1e55685f8a0ed48a7bd Mon Sep 17 00:00:00 2001 From: Marco Hennings Date: Sun, 18 Aug 2013 20:30:19 +0200 Subject: [PATCH 54/55] Add workdir support for the Buildfile For consistency the Buildfile should have the option to set the working directory. Of course that is one option more to the buildfile, so please tell me if we really want this to happen. --- buildfile.go | 5 +++++ docs/sources/use/builder.rst | 8 ++++++++ utils.go | 3 +++ 3 files changed, 16 insertions(+) diff --git a/buildfile.go b/buildfile.go index 5a2662646..0666ba438 100644 --- a/buildfile.go +++ b/buildfile.go @@ -222,6 +222,11 @@ func (b *buildFile) CmdEntrypoint(args string) error { return nil } +func (b *buildFile) CmdWorkdir(workdir string) error { + b.config.WorkingDir = workdir + return b.commit("", b.config.Cmd, fmt.Sprintf("WORKDIR %v", workdir)) +} + func (b *buildFile) CmdVolume(args string) error { if args == "" { return fmt.Errorf("Volume cannot be empty") diff --git a/docs/sources/use/builder.rst b/docs/sources/use/builder.rst index 85d9642e4..de765a546 100644 --- a/docs/sources/use/builder.rst +++ b/docs/sources/use/builder.rst @@ -205,6 +205,14 @@ to the entrypoint. The ``VOLUME`` instruction will add one or more new volumes to any container created from the image. +3.10 WORKDIR +-------------- + + ``WORKDIR /path/to/workdir`` + +The ``WORKDIR`` instruction sets the working directory in which +the command given by ``CMD`` is executed. + 4. Dockerfile Examples ====================== diff --git a/utils.go b/utils.go index 2264caefc..b8f264fdb 100644 --- a/utils.go +++ b/utils.go @@ -132,6 +132,9 @@ func MergeConfig(userConf, imageConf *Config) { if userConf.Entrypoint == nil || len(userConf.Entrypoint) == 0 { userConf.Entrypoint = imageConf.Entrypoint } + if userConf.WorkingDir == "" { + userConf.WorkingDir = imageConf.WorkingDir + } if userConf.VolumesFrom == "" { userConf.VolumesFrom = imageConf.VolumesFrom } From 83acd37161ed7149843546a779a95fdaf3e2458f Mon Sep 17 00:00:00 2001 From: elmendalerenda Date: Mon, 19 Aug 2013 14:20:25 +0100 Subject: [PATCH 55/55] fixed postgresql conf setting small typo, changed listen_address to listen_addresses --- docs/sources/examples/postgresql_service.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sources/examples/postgresql_service.rst b/docs/sources/examples/postgresql_service.rst index 96b19c881..27543ec5a 100644 --- a/docs/sources/examples/postgresql_service.rst +++ b/docs/sources/examples/postgresql_service.rst @@ -84,11 +84,11 @@ database are possible. Make sure that inside host all all 0.0.0.0/0 md5 Additionaly, inside ``/etc/postgresql/9.2/main/postgresql.conf`` -uncomment ``listen_address`` so it is as follows: +uncomment ``listen_addresses`` so it is as follows: .. code-block:: bash - listen_address='*' + listen_addresses='*' *Note:* this PostgreSQL setup is for development only purposes. Refer to PostgreSQL documentation how to fine-tune these settings so that it