From 9fc8028c987ac560ceb3b29eb609d77a82abdacc Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Mon, 2 Jun 2014 14:48:58 -0400 Subject: [PATCH] Changed all references from Trusted Builds to Automated Builds * Updated docker images output * Deprecated docker images -t/--trusted option and replace with --automated * Changed *trusted variables to *automated * Changed added support for is_automated alongside deprecated is_trusted * Updated man pages, docs and completion * Updated API documentation Docker-DCO-1.1-Signed-off-by: James Turnbull (github: jamtur01) --- api/client/commands.go | 9 +++++---- contrib/completion/bash/docker | 2 +- contrib/completion/fish/docker.fish | 2 +- contrib/man/md/docker-search.1.md | 16 ++++++++-------- docs/sources/docker-io/builds.md | 11 +++++------ docs/sources/docker-io/repos.md | 2 +- docs/sources/examples/mongodb.md | 2 +- docs/sources/reference/api/docker_remote_api.md | 3 +++ .../reference/api/docker_remote_api_v1.12.md | 6 +++--- docs/sources/reference/commandline/cli.md | 2 +- docs/sources/userguide/dockerimages.md | 10 ++++++---- docs/sources/userguide/index.md | 2 +- 12 files changed, 36 insertions(+), 31 deletions(-) diff --git a/api/client/commands.go b/api/client/commands.go index 4f0915ba79..1ad5d7889e 100644 --- a/api/client/commands.go +++ b/api/client/commands.go @@ -1724,7 +1724,8 @@ func (cli *DockerCli) CmdAttach(args ...string) error { func (cli *DockerCli) CmdSearch(args ...string) error { cmd := cli.Subcmd("search", "TERM", "Search the docker index for images") noTrunc := cmd.Bool([]string{"#notrunc", "-no-trunc"}, false, "Don't truncate output") - trusted := cmd.Bool([]string{"t", "#trusted", "-trusted"}, false, "Only show trusted builds") + trusted := cmd.Bool([]string{"#t", "#trusted", "#-trusted"}, false, "Only show trusted builds") + automated := cmd.Bool([]string{"-automated"}, false, "Only show automated builds") stars := cmd.Int([]string{"s", "#stars", "-stars"}, 0, "Only displays with at least xxx stars") if err := cmd.Parse(args); err != nil { return nil @@ -1747,9 +1748,9 @@ func (cli *DockerCli) CmdSearch(args ...string) error { return err } w := tabwriter.NewWriter(cli.out, 10, 1, 3, ' ', 0) - fmt.Fprintf(w, "NAME\tDESCRIPTION\tSTARS\tOFFICIAL\tTRUSTED\n") + fmt.Fprintf(w, "NAME\tDESCRIPTION\tSTARS\tOFFICIAL\tAUTOMATED\n") for _, out := range outs.Data { - if (*trusted && !out.GetBool("is_trusted")) || (*stars > out.GetInt("star_count")) { + if ((*automated || *trusted) && (!out.GetBool("is_trusted") && !out.GetBool("is_automated"))) || (*stars > out.GetInt("star_count")) { continue } desc := strings.Replace(out.Get("description"), "\n", " ", -1) @@ -1763,7 +1764,7 @@ func (cli *DockerCli) CmdSearch(args ...string) error { } fmt.Fprint(w, "\t") - if out.GetBool("is_trusted") { + if out.GetBool("is_automated") || out.GetBool("is_trusted") { fmt.Fprint(w, "[OK]") } fmt.Fprint(w, "\n") diff --git a/contrib/completion/bash/docker b/contrib/completion/bash/docker index e6a191d32b..e2ddd2accf 100755 --- a/contrib/completion/bash/docker +++ b/contrib/completion/bash/docker @@ -539,7 +539,7 @@ _docker_search() case "$cur" in -*) - COMPREPLY=( $( compgen -W "--no-trunc -t --trusted -s --stars" -- "$cur" ) ) + COMPREPLY=( $( compgen -W "--no-trunc --automated -s --stars" -- "$cur" ) ) ;; *) ;; diff --git a/contrib/completion/fish/docker.fish b/contrib/completion/fish/docker.fish index 7ea478d051..a7fd52e312 100644 --- a/contrib/completion/fish/docker.fish +++ b/contrib/completion/fish/docker.fish @@ -229,7 +229,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from save' -a '(__fish_print complete -c docker -f -n '__fish_docker_no_subcommand' -a search -d 'Search for an image in the docker index' complete -c docker -A -f -n '__fish_seen_subcommand_from search' -l no-trunc -d "Don't truncate output" complete -c docker -A -f -n '__fish_seen_subcommand_from search' -s s -l stars -d 'Only displays with at least xxx stars' -complete -c docker -A -f -n '__fish_seen_subcommand_from search' -s t -l trusted -d 'Only show trusted builds' +complete -c docker -A -f -n '__fish_seen_subcommand_from search' -l automated -d 'Only show automated builds' # start complete -c docker -f -n '__fish_docker_no_subcommand' -a start -d 'Start a stopped container' diff --git a/contrib/man/md/docker-search.1.md b/contrib/man/md/docker-search.1.md index fb2c921f8a..945dd34e59 100644 --- a/contrib/man/md/docker-search.1.md +++ b/contrib/man/md/docker-search.1.md @@ -5,7 +5,7 @@ docker-search - Search the docker index for images # SYNOPSIS -**docker search** **--no-trunc**[=*false*] **-t**|**--trusted**[=*false*] +**docker search** **--no-trunc**[=*false*] **--automated**[=*false*] **-s**|**--stars**[=*0*] TERM # DESCRIPTION @@ -13,7 +13,7 @@ docker-search - Search the docker index for images Search an index for an image with that matches the term TERM. The table of images returned displays the name, description (truncated by default), number of stars awarded, whether the image is official, and whether it -is trusted. +is automated. # OPTIONS **--no-trunc**=*true*|*false* @@ -23,8 +23,8 @@ is trusted. Only displays with at least NUM (integer) stars. I.e. only those images ranked >=NUM. -**-t**, **--trusted**=*true*|*false* - When true only show trusted builds. The default is false. +**--automated**=*true*|*false* + When true only show automated builds. The default is false. # EXAMPLE @@ -34,19 +34,19 @@ Search the registry for the term 'fedora' and only display those images ranked 3 or higher: $ sudo docker search -s 3 fedora - NAME DESCRIPTION STARS OFFICIAL TRUSTED + NAME DESCRIPTION STARS OFFICIAL AUTOMATED mattdm/fedora A basic Fedora image corresponding roughly... 50 fedora (Semi) Official Fedora base image. 38 mattdm/fedora-small A small Fedora image on which to build. Co... 8 goldmann/wildfly A WildFly application server running on a ... 3 [OK] -## Search the registry for trusted images +## Search the registry for automated images -Search the registry for the term 'fedora' and only display trusted images +Search the registry for the term 'fedora' and only display automated images ranked 1 or higher: $ sudo docker search -s 1 -t fedora - NAME DESCRIPTION STARS OFFICIAL TRUSTED + NAME DESCRIPTION STARS OFFICIAL AUTOMATED goldmann/wildfly A WildFly application server running on a ... 3 [OK] tutum/fedora-20 Fedora 20 image with SSH access. For the r... 1 [OK] diff --git a/docs/sources/docker-io/builds.md b/docs/sources/docker-io/builds.md index dd18907cf6..c70de4006c 100644 --- a/docs/sources/docker-io/builds.md +++ b/docs/sources/docker-io/builds.md @@ -1,6 +1,6 @@ page_title: Automated Builds on Docker.io page_description: Docker.io Automated Builds -page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker.io, docs, documentation, trusted, builds, trusted builds, automated builds +page_keywords: Docker, docker, registry, accounts, plans, Dockerfile, Docker.io, docs, documentation, trusted, builds, trusted builds, automated, automated builds # Automated Builds on Docker.io ## Automated Builds @@ -101,10 +101,9 @@ to Docker.io. #### Creating an Automated Build -You can [create a Trusted -Build](https://index.docker.io/builds/bitbucket/select/) -from any of your public or private BitBucket repositories with a -`Dockerfile`. +You can [create an Automated +Build](https://index.docker.io/builds/bitbucket/select/) from any of +your public or private BitBucket repositories with a `Dockerfile`. ### The Dockerfile and Automated Builds @@ -162,7 +161,7 @@ payload: "repository":{ "status":"Active", "description":"my docker repo that does cool things", - "is_trusted":false, + "is_automated":false, "full_description":"This is my full description", "repo_url":"https://index.docker.io/u/username/reponame/", "owner":"username", diff --git a/docs/sources/docker-io/repos.md b/docs/sources/docker-io/repos.md index a9bdabd89b..11170182a4 100644 --- a/docs/sources/docker-io/repos.md +++ b/docs/sources/docker-io/repos.md @@ -81,7 +81,7 @@ with a JSON payload similar to the example shown below. "repository":{ "status":"Active", "description":"my docker repo that does cool things", - "is_trusted":false, + "is_automated":false, "full_description":"This is my full description", "repo_url":"https://index.docker.io/u/username/reponame/", "owner":"username", diff --git a/docs/sources/examples/mongodb.md b/docs/sources/examples/mongodb.md index 5b0b7d3e28..17d58e0dbc 100644 --- a/docs/sources/examples/mongodb.md +++ b/docs/sources/examples/mongodb.md @@ -151,4 +151,4 @@ as daemon process(es). - [Linking containers](/userguide/dockerlinks) - [Cross-host linking containers](/articles/ambassador_pattern_linking/) - - [Creating a Trusted Build](/docker-io/builds/#trusted-builds) + - [Creating an Automated Build](/docker-io/builds/#automated-builds) diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md index 64837817e1..355102a707 100644 --- a/docs/sources/reference/api/docker_remote_api.md +++ b/docs/sources/reference/api/docker_remote_api.md @@ -47,6 +47,9 @@ Build now has support for the `forcerm` parameter to always remove containers **New!** All the JSON keys are now in CamelCase +**New!** +Trusted builds are now Automated Builds - `is_trusted` is now `is_automated`. + ## v1.11 ### Full Documentation diff --git a/docs/sources/reference/api/docker_remote_api_v1.12.md b/docs/sources/reference/api/docker_remote_api_v1.12.md index 23afa36bcf..91b273158b 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.12.md +++ b/docs/sources/reference/api/docker_remote_api_v1.12.md @@ -1002,21 +1002,21 @@ Search for an image on [Docker.io](https://index.docker.io). { "description": "", "is_official": false, - "is_trusted": false, + "is_automated": false, "name": "wma55/u1210sshd", "star_count": 0 }, { "description": "", "is_official": false, - "is_trusted": false, + "is_automated": false, "name": "jdswinbank/sshd", "star_count": 0 }, { "description": "", "is_official": false, - "is_trusted": false, + "is_automated": false, "name": "vgauthier/sshd", "star_count": 0 } diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index 829f13b9a6..faa9e2809d 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -1124,7 +1124,7 @@ Search [Docker.io](https://index.docker.io) for images --no-trunc=false Don't truncate output -s, --stars=0 Only displays with at least xxx stars - -t, --trusted=false Only show trusted builds + --automated=false Only show automated builds See [*Find Public Images on Docker.io*]( /userguide/dockerrepos/#find-public-images-on-dockerio) for diff --git a/docs/sources/userguide/dockerimages.md b/docs/sources/userguide/dockerimages.md index 1a69ab9aa6..bd8b0d2c2e 100644 --- a/docs/sources/userguide/dockerimages.md +++ b/docs/sources/userguide/dockerimages.md @@ -116,7 +116,7 @@ by using the `docker search` command to find all the images that contain the term `sinatra`. $ sudo docker search sinatra - NAME DESCRIPTION STARS OFFICIAL TRUSTED + NAME DESCRIPTION STARS OFFICIAL AUTOMATED training/sinatra Sinatra training image 0 [OK] marceldegraaf/sinatra Sinatra test app 0 mattwarren/docker-sinatra-demo 0 [OK] @@ -129,9 +129,11 @@ term `sinatra`. We can see we've returned a lot of images that use the term `sinatra`. We've returned a list of image names, descriptions, Stars (which measure the social popularity of images - if a user likes an image then they can "star" it), and -the Official and Trusted statuses. Official repositories are XXX and Trusted -repositories are [Trusted Build](/userguide/dockerrepos/) that allow you to -validate the source and content of an image. +the Official and Automated build statuses. Official repositories are built and +maintained by the [Stackbrew](https://github.com/dotcloud/stackbrew) project, +and Automated repositories are [Automated Builds]( +/userguide/dockerrepos/#automated-builds) that allow you to validate the source +and content of an image. We've reviewed the images available to use and we decided to use the `training/sinatra` image. So far we've seen two types of images repositories, diff --git a/docs/sources/userguide/index.md b/docs/sources/userguide/index.md index 7f703b6854..7150540433 100644 --- a/docs/sources/userguide/index.md +++ b/docs/sources/userguide/index.md @@ -76,7 +76,7 @@ Go to [Managing Data in Containers](/userguide/dockervolumes). Now we've learned a bit more about how to use Docker we're going to see how to combine Docker with the services available on Docker.io including -Trusted Builds and private repositories. +Automated Builds and private repositories. Go to [Working with Docker.io](/userguide/dockerrepos).