From 17abfc3ddc79592753289a8556a343e276fb15b5 Mon Sep 17 00:00:00 2001 From: Dan Walsh Date: Thu, 5 Feb 2015 12:26:05 +0100 Subject: [PATCH] pass --change changes to the import job Docker-DCO-1.1-Signed-off-by: Dan Walsh (github: rhatdan) --- api/client/commands.go | 12 ++++++--- api/server/server.go | 3 ++- builder/job.go | 7 ++--- docs/man/docker-commit.1.md | 13 ++++----- docs/man/docker-import.1.md | 11 ++++++++ docs/sources/reference/commandline/cli.md | 22 ++++++++++++--- graph/import.go | 33 ++++++++++++++++++----- integration-cli/docker_cli_commit_test.go | 8 ++++-- 8 files changed, 84 insertions(+), 25 deletions(-) diff --git a/api/client/commands.go b/api/client/commands.go index f25b6bbb43..2419132911 100644 --- a/api/client/commands.go +++ b/api/client/commands.go @@ -1156,6 +1156,8 @@ func (cli *DockerCli) CmdKill(args ...string) error { func (cli *DockerCli) CmdImport(args ...string) error { cmd := cli.Subcmd("import", "URL|- [REPOSITORY[:TAG]]", "Create an empty filesystem image and import the contents of the\ntarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then\noptionally tag it.", true) + flChanges := opts.NewListOpts(nil) + cmd.Var(&flChanges, []string{"c", "-change"}, "Apply Dockerfile instruction to the created image.") cmd.Require(flag.Min, 1) utils.ParseFlags(cmd, args, true) @@ -1168,7 +1170,9 @@ func (cli *DockerCli) CmdImport(args ...string) error { v.Set("fromSrc", src) v.Set("repo", repository) - + for _, change := range flChanges.GetAll() { + v.Add("changes", change) + } if cmd.NArg() == 3 { fmt.Fprintf(cli.err, "[DEPRECATED] The format 'URL|- [REPOSITORY [TAG]]' has been deprecated. Please use URL|- [REPOSITORY[:TAG]]\n") v.Set("tag", cmd.Arg(2)) @@ -1703,7 +1707,7 @@ func (cli *DockerCli) CmdCommit(args ...string) error { flComment := cmd.String([]string{"m", "-message"}, "", "Commit message") flAuthor := cmd.String([]string{"a", "#author", "-author"}, "", "Author (e.g., \"John Hannibal Smith \")") flChanges := opts.NewListOpts(nil) - cmd.Var(&flChanges, []string{"c", "-change"}, "Apply a modification before committing the image") + cmd.Var(&flChanges, []string{"c", "-change"}, "Apply Dockerfile instruction to the created image.") // FIXME: --run is deprecated, it will be replaced with inline Dockerfile commands. flConfig := cmd.String([]string{"#run", "#-run"}, "", "This option is deprecated and will be removed in a future version in favor of inline Dockerfile-compatible commands") cmd.Require(flag.Max, 2) @@ -1728,7 +1732,9 @@ func (cli *DockerCli) CmdCommit(args ...string) error { v.Set("tag", tag) v.Set("comment", *flComment) v.Set("author", *flAuthor) - v.Set("changes", strings.Join(flChanges.GetAll(), "\n")) + for _, change := range flChanges.GetAll() { + v.Add("changes", change) + } if *flPause != true { v.Set("pause", "0") diff --git a/api/server/server.go b/api/server/server.go index ef6951c691..9407b2397d 100644 --- a/api/server/server.go +++ b/api/server/server.go @@ -518,7 +518,7 @@ func postCommit(eng *engine.Engine, version version.Version, w http.ResponseWrit job.Setenv("tag", r.Form.Get("tag")) job.Setenv("author", r.Form.Get("author")) job.Setenv("comment", r.Form.Get("comment")) - job.Setenv("changes", r.Form.Get("changes")) + job.SetenvList("changes", r.Form["changes"]) job.SetenvSubEnv("config", &config) job.Stdout.Add(stdoutBuffer) @@ -571,6 +571,7 @@ func postImagesCreate(eng *engine.Engine, version version.Version, w http.Respon } job = eng.Job("import", r.Form.Get("fromSrc"), repo, tag) job.Stdin.Add(r.Body) + job.SetenvList("changes", r.Form["changes"]) } if version.GreaterThan("1.0") { diff --git a/builder/job.go b/builder/job.go index 2e43547735..559335298e 100644 --- a/builder/job.go +++ b/builder/job.go @@ -7,6 +7,7 @@ import ( "io/ioutil" "os" "os/exec" + "strings" "github.com/docker/docker/api" "github.com/docker/docker/builder/parser" @@ -21,7 +22,7 @@ import ( "github.com/docker/docker/utils" ) -// whitelist of commands allowed for a commit +// whitelist of commands allowed for a commit/import var validCommitCommands = map[string]bool{ "entrypoint": true, "cmd": true, @@ -162,7 +163,7 @@ func (b *BuilderJob) CmdBuildConfig(job *engine.Job) engine.Status { } var ( - changes = job.Getenv("changes") + changes = job.GetenvList("changes") newConfig runconfig.Config ) @@ -170,7 +171,7 @@ func (b *BuilderJob) CmdBuildConfig(job *engine.Job) engine.Status { return job.Error(err) } - ast, err := parser.Parse(bytes.NewBufferString(changes)) + ast, err := parser.Parse(bytes.NewBufferString(strings.Join(changes, "\n"))) if err != nil { return job.Error(err) } diff --git a/docs/man/docker-commit.1.md b/docs/man/docker-commit.1.md index 384d5ef697..663dfdc68f 100644 --- a/docs/man/docker-commit.1.md +++ b/docs/man/docker-commit.1.md @@ -21,7 +21,8 @@ Using an existing container's name or ID you can create a new image. Author (e.g., "John Hannibal Smith ") **-c** , **--change**=[] - Apply a modification in Dockerfile format before committing the image. + Apply specified Dockerfile instructions while committing the image + Supported Dockerfile instructions: CMD, ENTRYPOINT, ENV, EXPOSE, ONBUILD, USER, VOLUME, WORKDIR **--help** Print usage statement @@ -42,11 +43,11 @@ create a new image run docker ps to find the container's ID and then run: # docker commit -m="Added Apache to Fedora base image" \ -a="A D Ministrator" 98bd7fc99854 fedora/fedora_httpd:20 -## Modify configuration settings before committing the image -An existing container was created without the necessary environment variable -DEBUG set to "true". To create a new image based on the container with a -correct DEBUG environment variable, run docker ps to find the container's ID -and then run +## Apply specified Dockerfile instructions while committing the image +If an existing container was created without the DEBUG environment +variable set to "true", you can create a new image based on that +container by first getting the container's ID with docker ps and +then running: # docker commit -c="ENV DEBUG true" 98bd7fc99854 debug-image diff --git a/docs/man/docker-import.1.md b/docs/man/docker-import.1.md index 974288c721..d948dec68c 100644 --- a/docs/man/docker-import.1.md +++ b/docs/man/docker-import.1.md @@ -6,9 +6,15 @@ docker-import - Create an empty filesystem image and import the contents of the # SYNOPSIS **docker import** +[**-c**|**--change**[= []**]] [**--help**] URL|- [REPOSITORY[:TAG]] +# OPTIONS +**-c**, **--change**=[] + Apply specified Dockerfile instructions while importing the image + Supported Dockerfile instructions: CMD, ENTRYPOINT, ENV, EXPOSE, ONBUILD, USER, VOLUME, WORKDIR + # DESCRIPTION Create a new filesystem image from the contents of a tarball (`.tar`, `.tar.gz`, `.tgz`, `.bzip`, `.tar.xz`, `.txz`) into it, then optionally tag it. @@ -39,6 +45,11 @@ Import to docker via pipe and stdin: # tar -c . | docker import - exampleimagedir +## Apply specified Dockerfile instructions while importing the image +This example sets the docker image ENV variable DEBUG to true by default. + + # tar -c . | docker import -c="ENV DEBUG true" - exampleimagedir + # HISTORY April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work. diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index a1d73c9b5a..1b4a650357 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -694,7 +694,7 @@ you refer to it on the command line. Create a new image from a container's changes -a, --author="" Author (e.g., "John Hannibal Smith ") - -c, --change=[] Apply a modification in Dockerfile format before committing the image + -c, --change=[] Apply specified Dockerfile instructions while committing the image -m, --message="" Commit message -p, --pause=true Pause container during commit @@ -709,7 +709,12 @@ while the image is committed. This reduces the likelihood of encountering data corruption during the process of creating the commit. If this behavior is undesired, set the 'p' option to false. -#### Commit an existing container +The `--change` option will apply `Dockerfile` instructions to the image +that is created. +Supported `Dockerfile` instructions: `CMD`, `ENTRYPOINT`, `ENV`, `EXPOSE`, +`ONBUILD`, `USER`, `VOLUME`, `WORKDIR` + +#### Commit a container $ sudo docker ps ID IMAGE COMMAND CREATED STATUS PORTS @@ -721,7 +726,7 @@ If this behavior is undesired, set the 'p' option to false. REPOSITORY TAG ID CREATED VIRTUAL SIZE SvenDowideit/testimage version3 f5283438590d 16 seconds ago 335.7 MB -#### Commit an existing container with new configurations +#### Commit a container with new configurations $ sudo docker ps ID IMAGE COMMAND CREATED STATUS PORTS @@ -1151,11 +1156,18 @@ NOTE: Docker will warn you if any containers exist that are using these untagged tarball (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) into it, then optionally tag it. + -c, --change=[] Apply specified Dockerfile instructions while importing the image + URLs must start with `http` and point to a single file archive (.tar, .tar.gz, .tgz, .bzip, .tar.xz, or .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 `STDIN`. +The `--change` option will apply `Dockerfile` instructions to the image +that is created. +Supported `Dockerfile` instructions: `CMD`, `ENTRYPOINT`, `ENV`, `EXPOSE`, +`ONBUILD`, `USER`, `VOLUME`, `WORKDIR` + #### Examples **Import from a remote location:** @@ -1174,6 +1186,10 @@ Import to docker via pipe and `STDIN`. $ sudo tar -c . | sudo docker import - exampleimagedir +**Import from a local directory with new configurations:** + + $ sudo tar -c . | sudo docker import --change "ENV DEBUG true" - 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 the sudo command) when you diff --git a/graph/import.go b/graph/import.go index a8e8e04b5b..41f4b4f3f1 100644 --- a/graph/import.go +++ b/graph/import.go @@ -1,12 +1,15 @@ package graph import ( + "bytes" + "encoding/json" "net/http" "net/url" log "github.com/Sirupsen/logrus" "github.com/docker/docker/engine" "github.com/docker/docker/pkg/archive" + "github.com/docker/docker/runconfig" "github.com/docker/docker/utils" ) @@ -15,12 +18,14 @@ func (s *TagStore) CmdImport(job *engine.Job) engine.Status { return job.Errorf("Usage: %s SRC REPO [TAG]", job.Name) } var ( - src = job.Args[0] - repo = job.Args[1] - tag string - sf = utils.NewStreamFormatter(job.GetenvBool("json")) - archive archive.ArchiveReader - resp *http.Response + src = job.Args[0] + repo = job.Args[1] + tag string + sf = utils.NewStreamFormatter(job.GetenvBool("json")) + archive archive.ArchiveReader + resp *http.Response + stdoutBuffer = bytes.NewBuffer(nil) + newConfig runconfig.Config ) if len(job.Args) > 2 { tag = job.Args[2] @@ -47,7 +52,21 @@ func (s *TagStore) CmdImport(job *engine.Job) engine.Status { defer progressReader.Close() archive = progressReader } - img, err := s.graph.Create(archive, "", "", "Imported from "+src, "", nil, nil) + + buildConfigJob := job.Eng.Job("build_config") + buildConfigJob.Stdout.Add(stdoutBuffer) + buildConfigJob.Setenv("changes", job.Getenv("changes")) + // FIXME this should be remove when we remove deprecated config param + buildConfigJob.Setenv("config", job.Getenv("config")) + + if err := buildConfigJob.Run(); err != nil { + return job.Error(err) + } + if err := json.NewDecoder(stdoutBuffer).Decode(&newConfig); err != nil { + return job.Error(err) + } + + img, err := s.graph.Create(archive, "", "", "Imported from "+src, "", nil, &newConfig) if err != nil { return job.Error(err) } diff --git a/integration-cli/docker_cli_commit_test.go b/integration-cli/docker_cli_commit_test.go index 95a34b9169..b8bc7bdfc7 100644 --- a/integration-cli/docker_cli_commit_test.go +++ b/integration-cli/docker_cli_commit_test.go @@ -205,9 +205,13 @@ func TestCommitWithHostBindMount(t *testing.T) { func TestCommitChange(t *testing.T) { defer deleteAllContainers() - cmd(t, "run", "--name", "test", "busybox", "true") - cmd := exec.Command(dockerBinary, "commit", + cmd := exec.Command(dockerBinary, "run", "--name", "test", "busybox", "true") + if _, err := runCommand(cmd); err != nil { + t.Fatal(err) + } + + cmd = exec.Command(dockerBinary, "commit", "--change", "EXPOSE 8080", "--change", "ENV DEBUG true", "test", "test-commit")