From 03cea0ef23595ec711fc6e702e249f3561afa36a Mon Sep 17 00:00:00 2001 From: Darren Shepherd Date: Fri, 13 Mar 2015 09:38:41 -0700 Subject: [PATCH] Docs changes for labels based on feedback Signed-off-by: Darren Shepherd --- .../reference/api/docker_remote_api_v1.17.md | 17 ----------------- .../reference/api/docker_remote_api_v1.18.md | 17 +++++++++++++++++ docs/sources/reference/commandline/cli.md | 8 ++++---- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/sources/reference/api/docker_remote_api_v1.17.md b/docs/sources/reference/api/docker_remote_api_v1.17.md index d82faffe98..96887559c2 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.17.md +++ b/docs/sources/reference/api/docker_remote_api_v1.17.md @@ -129,11 +129,6 @@ Create a container ], "Entrypoint": "", "Image": "ubuntu", - "Labels": { - "com.example.vendor": "Acme", - "com.example.license": "GPL", - "com.example.version": "1.0" - }, "Volumes": { "/tmp": {} }, @@ -194,8 +189,6 @@ Json Parameters: - **OpenStdin** - Boolean value, opens stdin, - **StdinOnce** - Boolean value, close stdin after the 1 attached client disconnects. - **Env** - A list of environment variables in the form of `VAR=value` -- **Labels** - A map of labels and their values that will be added to the - container. It should be specified in the form `{"name":"value"[,"name2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entrypoint for the container a a string or an array of strings @@ -305,11 +298,6 @@ Return low-level information on the container `id` "ExposedPorts": null, "Hostname": "ba033ac44011", "Image": "ubuntu", - "Labels": { - "com.example.vendor": "Acme", - "com.example.license": "GPL", - "com.example.version": "1.0" - }, "MacAddress": "", "Memory": 0, "MemorySwap": 0, @@ -1181,11 +1169,6 @@ Return low-level information on the image `name` "Cmd": ["/bin/bash"], "Dns": null, "Image": "ubuntu", - "Labels": { - "com.example.vendor": "Acme", - "com.example.license": "GPL", - "com.example.version": "1.0" - }, "Volumes": null, "VolumesFrom": "", "WorkingDir": "" diff --git a/docs/sources/reference/api/docker_remote_api_v1.18.md b/docs/sources/reference/api/docker_remote_api_v1.18.md index 46351ed85c..fe6b59298d 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.18.md +++ b/docs/sources/reference/api/docker_remote_api_v1.18.md @@ -129,6 +129,11 @@ Create a container ], "Entrypoint": "", "Image": "ubuntu", + "Labels": { + "com.example.vendor": "Acme", + "com.example.license": "GPL", + "com.example.version": "1.0" + }, "Volumes": { "/tmp": {} }, @@ -190,6 +195,8 @@ Json Parameters: - **OpenStdin** - Boolean value, opens stdin, - **StdinOnce** - Boolean value, close stdin after the 1 attached client disconnects. - **Env** - A list of environment variables in the form of `VAR=value` +- **Labels** - A map of labels and their values that will be added to the + container. It should be specified in the form `{"name":"value"[,"name2":"value2"]}` - **Cmd** - Command to run specified as a string or an array of strings. - **Entrypoint** - Set the entrypoint for the container a a string or an array of strings @@ -302,6 +309,11 @@ Return low-level information on the container `id` "ExposedPorts": null, "Hostname": "ba033ac44011", "Image": "ubuntu", + "Labels": { + "com.example.vendor": "Acme", + "com.example.license": "GPL", + "com.example.version": "1.0" + }, "MacAddress": "", "Memory": 0, "MemorySwap": 0, @@ -1186,6 +1198,11 @@ Return low-level information on the image `name` "Cmd": ["/bin/bash"], "Dns": null, "Image": "ubuntu", + "Labels": { + "com.example.vendor": "Acme", + "com.example.license": "GPL", + "com.example.version": "1.0" + }, "Volumes": null, "VolumesFrom": "", "WorkingDir": "" diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index 79dbb6c8f5..284aefa12b 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -1840,21 +1840,21 @@ An example of a file passed with `--env-file` This will create and run a new container with the container name being `console`. - $ sudo docker run -l my-label --env com.example.foo=bar ubuntu bash + $ sudo docker run -l my-label --label com.example.foo=bar ubuntu bash This sets two labels on the container. Label "my-label" doesn't have a value specified and will default to "" (empty string) for its value. Both `-l` and -`--env` can be repeated to add more labels. Label names are unique; if the same +`--label` can be repeated to add more labels. Label names are unique; if the same label is specified multiple times, latter values overwrite the previous value. Labels can also be loaded from a line delimited file of labels using the `--label-file` flag. The example below will load labels from a file named `labels` in the current directory; - $ sudo docker run --env-file ./labels ubuntu bash + $ sudo docker run --label-file ./labels ubuntu bash The format of the labels-file is similar to that used for loading environment -variables (see `--env-file` above). An example of a file passed with `--env-file`; +variables (see `--label-file` above). An example of a file passed with `--label-file`; $ cat ./labels com.example.label1="a label"