mirror of https://github.com/docker/cli.git
Multiple fixes to the cli.md document.
*. Fixed headings so the side menu will now be consistent. Some sections had H3s that were displaying and others did not leaving the left menu very mismatched. * Fixed several spelling errors. * Re-formatted several long lines and badly laid out paragraphs. * Fixed several double backticks. * Added backticks to several outputs and variables. * Removed two issues that are no longer valid. * Removed several double spaces and extra lines. Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
This commit is contained in:
James Turnbull
Tibor Vass
parent
410719e6df
commit
a62d8740bf
|
|
@ -88,7 +88,6 @@ expect an integer, and they can only be specified once.
|
|||
--tlsverify=false Use TLS and verify the remote (daemon: verify client, client: verify daemon)
|
||||
-v, --version=false Print version information and quit
|
||||
|
||||
|
||||
Options with [] may be specified multiple times.
|
||||
|
||||
The Docker daemon is the persistent process that manages containers.
|
||||
|
|
@ -163,7 +162,7 @@ To stop a container, use `docker stop`.
|
|||
|
||||
To kill the container, use `docker kill`.
|
||||
|
||||
### Examples:
|
||||
#### Examples
|
||||
|
||||
$ ID=$(sudo docker run -d ubuntu /usr/bin/top -b)
|
||||
$ sudo docker attach $ID
|
||||
|
|
@ -231,11 +230,12 @@ Exclusion patterns match files or directories relative to `PATH` that
|
|||
will be excluded from the context. Globbing is done using Go's
|
||||
[filepath.Match](http://golang.org/pkg/path/filepath#Match) rules.
|
||||
|
||||
Please note that `.dockerignore` files in other subdirectories are considered as
|
||||
normal files. Filepaths in .dockerignore are absolute with the current directory
|
||||
as the root. Wildcards are allowed but the search is not recursive.
|
||||
Please note that `.dockerignore` files in other subdirectories are
|
||||
considered as normal files. Filepaths in .dockerignore are absolute with
|
||||
the current directory as the root. Wildcards are allowed but the search
|
||||
is not recursive.
|
||||
|
||||
### Example .dockerignore file
|
||||
#### Example .dockerignore file
|
||||
*/temp*
|
||||
*/*/temp*
|
||||
temp?
|
||||
|
|
@ -256,7 +256,7 @@ See also:
|
|||
|
||||
[*Dockerfile Reference*](/reference/builder).
|
||||
|
||||
### Examples:
|
||||
#### Examples
|
||||
|
||||
$ sudo docker build .
|
||||
Uploading context 10240 bytes
|
||||
|
|
@ -381,7 +381,7 @@ 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
|
||||
#### Commit an existing container
|
||||
|
||||
$ sudo docker ps
|
||||
ID IMAGE COMMAND CREATED STATUS PORTS
|
||||
|
|
@ -457,7 +457,7 @@ container at any point.
|
|||
This is useful when you want to set up a container configuration ahead
|
||||
of time so that it is ready to start when you need it.
|
||||
|
||||
### Example:
|
||||
#### Example
|
||||
|
||||
$ sudo docker create -t -i fedora bash
|
||||
6d8af538ec541dd581ebc2a24153a28329acb5268abe5ef868c1f1a261221752
|
||||
|
|
@ -511,7 +511,7 @@ and Docker images will report:
|
|||
|
||||
untag, delete
|
||||
|
||||
### Examples
|
||||
#### Examples
|
||||
|
||||
You'll need two shells for this example.
|
||||
|
||||
|
|
@ -559,7 +559,7 @@ The `docker exec` command runs a new command in a running container.
|
|||
|
||||
The `docker exec` command will typically be used after `docker run` or `docker start`.
|
||||
|
||||
### Examples:
|
||||
#### Examples
|
||||
|
||||
$ sudo docker run --name ubuntu_bash --rm -i -t ubuntu bash
|
||||
|
||||
|
|
@ -623,7 +623,7 @@ decrease disk usage, and speed up `docker build` by
|
|||
allowing each step to be cached. These intermediate layers are not shown
|
||||
by default.
|
||||
|
||||
### Listing the most recently created images
|
||||
#### Listing the most recently created images
|
||||
|
||||
$ sudo docker images | head
|
||||
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
|
||||
|
|
@ -637,7 +637,7 @@ by default.
|
|||
tryout latest 2629d1fa0b81 23 hours ago 131.5 MB
|
||||
<none> <none> 5ed6274db6ce 24 hours ago 1.089 GB
|
||||
|
||||
### Listing the full length image IDs
|
||||
#### Listing the full length image IDs
|
||||
|
||||
$ sudo docker images --no-trunc | head
|
||||
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE
|
||||
|
|
@ -651,7 +651,7 @@ by default.
|
|||
tryout latest 2629d1fa0b81b222fca63371ca16cbf6a0772d07759ff80e8d1369b926940074 23 hours ago 131.5 MB
|
||||
<none> <none> 5ed6274db6ceb2397844896966ea239290555e74ef307030ebb01ff91b1914df 24 hours ago 1.089 GB
|
||||
|
||||
### Filtering
|
||||
#### Filtering
|
||||
|
||||
The filtering flag (`-f` or `--filter`) format is of "key=value". If there are more
|
||||
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
|
||||
|
|
@ -659,7 +659,7 @@ than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "b
|
|||
Current filters:
|
||||
* dangling (boolean - true or false)
|
||||
|
||||
#### untagged images
|
||||
##### Untagged images
|
||||
|
||||
$ sudo docker images --filter "dangling=true"
|
||||
|
||||
|
|
@ -673,7 +673,7 @@ Current filters:
|
|||
|
||||
This will display untagged images, that are the leaves of the images tree (not
|
||||
intermediary layers). These images occur when a new build of an image takes the
|
||||
repo:tag away from the IMAGE ID, leaving it untagged. A warning will be issued
|
||||
`repo:tag` away from the image ID, leaving it untagged. A warning will be issued
|
||||
if trying to remove an image when a container is presently using it.
|
||||
By having this flag it allows for batch cleanup.
|
||||
|
||||
|
|
@ -690,7 +690,6 @@ Ready for use by `docker rmi ...`, like:
|
|||
|
||||
NOTE: Docker will warn you if any containers exist that are using these untagged images.
|
||||
|
||||
|
||||
## import
|
||||
|
||||
Usage: docker import URL|- [REPOSITORY[:TAG]]
|
||||
|
|
@ -702,7 +701,7 @@ URLs must start with `http` and point to a single file archive (.tar,
|
|||
you would like to import from a local directory or archive, you can use
|
||||
the `-` parameter to take the data from `STDIN`.
|
||||
|
||||
### Examples
|
||||
#### Examples
|
||||
|
||||
**Import from a remote location:**
|
||||
|
||||
|
|
@ -750,7 +749,7 @@ For example:
|
|||
Username: svendowideit
|
||||
Registry: [https://index.docker.io/v1/]
|
||||
|
||||
The global `-D` option tells all `docker` comands to output debug information.
|
||||
The global `-D` option tells all `docker` commands to output debug information.
|
||||
|
||||
When sending issue reports, please use `docker version` and `docker -D info` to
|
||||
ensure we know how your setup is configured.
|
||||
|
|
@ -769,9 +768,9 @@ specified, the given template will be executed for each result.
|
|||
Go's [text/template](http://golang.org/pkg/text/template/) package
|
||||
describes all the details of the format.
|
||||
|
||||
### Examples
|
||||
#### Examples
|
||||
|
||||
**Get an instance'sIP Address:**
|
||||
**Get an instance's IP address:**
|
||||
|
||||
For the most part, you can pick out any field from the JSON in a fairly
|
||||
straightforward manner.
|
||||
|
|
@ -787,25 +786,22 @@ output:
|
|||
|
||||
**Find a Specific Port Mapping:**
|
||||
|
||||
The `.Field` syntax doesn't work when the field name
|
||||
begins with a number, but the template language's `index`
|
||||
function does. The `.NetworkSettings.Ports`
|
||||
section contains a map of the internal port mappings to a list
|
||||
of external address/port objects, so to grab just the numeric public
|
||||
port, you use `index` to find the specific port map,
|
||||
and then `index` 0 contains first object inside of
|
||||
that. Then we ask for the `HostPort` field to get
|
||||
the public address.
|
||||
The `.Field` syntax doesn't work when the field name begins with a
|
||||
number, but the template language's `index` function does. The
|
||||
`.NetworkSettings.Ports` section contains a map of the internal port
|
||||
mappings to a list of external address/port objects, so to grab just the
|
||||
numeric public port, you use `index` to find the specific port map, and
|
||||
then `index` 0 contains the first object inside of that. Then we ask for
|
||||
the `HostPort` field to get the public address.
|
||||
|
||||
$ sudo docker inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID
|
||||
|
||||
**Get config:**
|
||||
|
||||
The `.Field` syntax doesn't work when the field
|
||||
contains JSON data, but the template language's custom `json`
|
||||
function does. The `.config` section
|
||||
contains complex json object, so to grab it as JSON, you use
|
||||
`json` to convert config object into JSON
|
||||
The `.Field` syntax doesn't work when the field contains JSON data, but
|
||||
the template language's custom `json` function does. The `.config`
|
||||
section contains complex JSON object, so to grab it as JSON, you use
|
||||
`json` to convert the configuration object into JSON.
|
||||
|
||||
$ sudo docker inspect --format='{{json .config}}' $INSTANCE_ID
|
||||
|
||||
|
|
@ -856,8 +852,8 @@ Restores both images and tags.
|
|||
-p, --password="" Password
|
||||
-u, --username="" Username
|
||||
|
||||
If you want to login to a self-hosted registry you can
|
||||
specify this by adding the server name.
|
||||
If you want to login to a self-hosted registry you can specify this by
|
||||
adding the server name.
|
||||
|
||||
example:
|
||||
$ sudo docker login localhost:8080
|
||||
|
|
@ -961,16 +957,15 @@ Running `docker ps` showing 2 linked containers.
|
|||
`docker ps` will show only running containers by default. To see all containers:
|
||||
`docker ps -a`
|
||||
|
||||
### Filtering
|
||||
#### Filtering
|
||||
|
||||
The filtering flag (-f or --filter) format is a "key=value" pair. If there is more
|
||||
The filtering flag (`-f` or `--filter)` format is a `key=value` pair. If there is more
|
||||
than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`)
|
||||
|
||||
Current filters:
|
||||
* exited (int - the code of exited containers. Only useful with '--all')
|
||||
|
||||
|
||||
#### Successfully exited containers
|
||||
##### Successfully exited containers
|
||||
|
||||
$ sudo docker ps -a --filter 'exited=0'
|
||||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
||||
|
|
@ -997,7 +992,7 @@ can `pull` and try without needing to define and configure your own.
|
|||
It is also possible to manually specify the path of a registry to pull from.
|
||||
For example, if you have set up a local registry, you can specify its path to
|
||||
pull from it. A repository path is similar to a URL, but does not contain
|
||||
a protocol specifier (https://, for example).
|
||||
a protocol specifier (`https://`, for example).
|
||||
|
||||
To download a particular image, or set of images (i.e., a repository),
|
||||
use `docker pull`:
|
||||
|
|
@ -1044,13 +1039,7 @@ registry or to a self-hosted one.
|
|||
-l, --link=false Remove the specified link and not the underlying container
|
||||
-v, --volumes=false Remove the volumes associated with the container
|
||||
|
||||
### Known Issues (rm)
|
||||
|
||||
- [Issue 197](https://github.com/docker/docker/issues/197) indicates
|
||||
that `docker kill` may leave directories behind
|
||||
and make it difficult to remove the container.
|
||||
|
||||
### Examples:
|
||||
#### Examples
|
||||
|
||||
$ sudo docker rm /redis
|
||||
/redis
|
||||
|
|
@ -1061,21 +1050,19 @@ This will remove the container referenced under the link
|
|||
$ sudo docker rm --link /webapp/redis
|
||||
/webapp/redis
|
||||
|
||||
This will remove the underlying link between `/webapp`
|
||||
and the `/redis` containers removing all
|
||||
network communication.
|
||||
This will remove the underlying link between `/webapp` and the `/redis`
|
||||
containers removing all network communication.
|
||||
|
||||
$ sudo docker rm --force redis
|
||||
redis
|
||||
|
||||
The main process inside the container referenced under the link `/redis` will receive
|
||||
SIGKILL, then the container will be removed.
|
||||
`SIGKILL`, then the container will be removed.
|
||||
|
||||
|
||||
This command will delete all stopped containers. The command
|
||||
`docker ps -a -q` will return all existing container
|
||||
IDs and pass them to the `rm` command which will
|
||||
delete them. Any running containers will not be deleted.
|
||||
This command will delete all stopped containers. The command `docker ps
|
||||
-a -q` will return all existing container IDs and pass them to the `rm`
|
||||
command which will delete them. Any running containers will not be
|
||||
deleted.
|
||||
|
||||
## rmi
|
||||
|
||||
|
|
@ -1086,9 +1073,9 @@ delete them. Any running containers will not be deleted.
|
|||
-f, --force=false Force removal of the image
|
||||
--no-prune=false Do not delete untagged parents
|
||||
|
||||
### Removing tagged images
|
||||
#### Removing tagged images
|
||||
|
||||
Images can be removed either by their short or long ID`s, or their image
|
||||
Images can be removed either by their short or long IDs, or their image
|
||||
names. If an image has more than one name, each of them needs to be
|
||||
removed before the image is removed.
|
||||
|
||||
|
|
@ -1174,14 +1161,7 @@ See the [Docker User Guide](/userguide/dockerlinks/) for more detailed
|
|||
information about the `--expose`, `-p`, `-P` and `--link` parameters,
|
||||
and linking containers.
|
||||
|
||||
### Known Issues (run –volumes-from)
|
||||
|
||||
- [Issue 2702](https://github.com/docker/docker/issues/2702):
|
||||
"lxc-start: Permission denied - failed to mount" could indicate a
|
||||
permissions problem with AppArmor. Please see the issue for a
|
||||
workaround.
|
||||
|
||||
### Examples:
|
||||
#### Examples
|
||||
|
||||
$ sudo docker run --cidfile /tmp/docker_test.cid ubuntu echo "test"
|
||||
|
||||
|
|
@ -1234,7 +1214,7 @@ folder before starting your container.
|
|||
By bind-mounting the docker unix socket and statically linked docker
|
||||
binary (such as that provided by [https://get.docker.com](
|
||||
https://get.docker.com)), you give the container the full access to create and
|
||||
manipulate the host's docker daemon.
|
||||
manipulate the host's Docker daemon.
|
||||
|
||||
$ sudo docker run -p 127.0.0.1:80:8080 ubuntu bash
|
||||
|
||||
|
|
@ -1254,7 +1234,7 @@ ports in Docker.
|
|||
This sets environmental variables in the container. For illustration all three
|
||||
flags are shown here. Where `-e`, `--env` take an environment variable and
|
||||
value, or if no "=" is provided, then that variable's current value is passed
|
||||
through (i.e. $MYVAR1 from the host is set to $MYVAR1 in the container). All
|
||||
through (i.e. `$MYVAR1` from the host is set to `$MYVAR1` in the container). All
|
||||
three flags, `-e`, `--env` and `--env-file` can be repeated.
|
||||
|
||||
Regardless of the order of these three flags, the `--env-file` are processed
|
||||
|
|
@ -1267,7 +1247,7 @@ override variables as needed.
|
|||
TEST_FOO=This is a test
|
||||
|
||||
The `--env-file` flag takes a filename as an argument and expects each line
|
||||
to be in the VAR=VAL format, mimicking the argument passed to `--env`. Comment
|
||||
to be in the `VAR=VAL` format, mimicking the argument passed to `--env`. Comment
|
||||
lines need only be prefixed with `#`
|
||||
|
||||
An example of a file passed with `--env-file`
|
||||
|
|
@ -1339,14 +1319,13 @@ retrieve the container's ID once the container has finished running.
|
|||
brw-rw---- 1 root disk 8, 3 Feb 9 16:05 /dev/sdd
|
||||
crw-rw-rw- 1 root root 1, 5 Feb 9 16:05 /dev/nulo
|
||||
|
||||
It is often necessary to directly expose devices to a container. ``--device``
|
||||
It is often necessary to directly expose devices to a container. The `--device`
|
||||
option enables that. For example, a specific block storage device or loop
|
||||
device or audio device can be added to an otherwise unprivileged container
|
||||
(without the ``--privileged`` flag) and have the application directly access it.
|
||||
(without the `--privileged` flag) and have the application directly access it.
|
||||
|
||||
** Security note: **
|
||||
|
||||
``--device`` cannot be safely used with ephemeral devices. Block devices that may be removed should not be added to untrusted containers with ``--device``!
|
||||
**Note:**
|
||||
> `--device` cannot be safely used with ephemeral devices. Block devices that may be removed should not be added to untrusted containers with `--device`.
|
||||
|
||||
**A complete example:**
|
||||
|
||||
|
|
@ -1356,7 +1335,7 @@ device or audio device can be added to an otherwise unprivileged container
|
|||
$ sudo docker run -d -p 1443:443 --dns=10.0.0.1 --dns-search=dev.org -v /var/log/httpd --volumes-from static --link riak --link app -h www.sven.dev.org --name web webserver
|
||||
$ sudo docker run -t -i --rm --volumes-from web -w /var/log/httpd busybox tail -f access.log
|
||||
|
||||
This example shows 5 containers that might be set up to test a web
|
||||
This example shows five containers that might be set up to test a web
|
||||
application change:
|
||||
|
||||
1. Start a pre-prepared volume image `static-web-files` (in the background)
|
||||
|
|
@ -1390,8 +1369,9 @@ how a container should or should not be restarted on exit.
|
|||
|
||||
** always ** - Always restart the container reguardless of the exit status.
|
||||
|
||||
You can also specify the maximum amount of times Docker will try to restart the
|
||||
container when using the ** on-failure ** policy. The default is that Docker will try forever to restart the container.
|
||||
You can also specify the maximum amount of times Docker will try to
|
||||
restart the container when using the ** on-failure ** policy. The
|
||||
default is that Docker will try forever to restart the container.
|
||||
|
||||
$ sudo docker run --restart=always redis
|
||||
|
||||
|
|
@ -1400,10 +1380,11 @@ the container exits, Docker will restart it.
|
|||
|
||||
$ sudo docker run --restart=on-failure:10 redis
|
||||
|
||||
This will run the `redis` container with a restart policy of ** on-failure ** and a
|
||||
maximum restart count of 10. If the `redis` container exits with a non-zero exit
|
||||
status more than 10 times in a row Docker will abort trying to restart the container.
|
||||
Providing a maximum restart limit is only valid for the ** on-failure ** policy.
|
||||
This will run the `redis` container with a restart policy of **
|
||||
on-failure ** and a maximum restart count of 10. If the `redis`
|
||||
container exits with a non-zero exit status more than 10 times in a row
|
||||
Docker will abort trying to restart the container. Providing a maximum
|
||||
restart limit is only valid for the ** on-failure ** policy.
|
||||
|
||||
## save
|
||||
|
||||
|
|
@ -1414,10 +1395,10 @@ Providing a maximum restart limit is only valid for the ** on-failure ** policy.
|
|||
-o, --output="" Write to a file, instead of STDOUT
|
||||
|
||||
Produces a tarred repository to the standard output stream.
|
||||
Contains all parent layers, and all tags + versions, or specified repo:tag, for
|
||||
Contains all parent layers, and all tags + versions, or specified `repo:tag`, for
|
||||
each argument provided.
|
||||
|
||||
It is used to create a backup that can then be used with ``docker load``
|
||||
It is used to create a backup that can then be used with `docker load`
|
||||
|
||||
$ sudo docker save busybox > busybox.tar
|
||||
$ ls -sh busybox.tar
|
||||
|
|
@ -1454,8 +1435,8 @@ more details on finding shared images from the command line.
|
|||
|
||||
Restart a stopped container
|
||||
|
||||
-a, --attach=false Attach container's STDOUT and STDERR and forward all signals to the process
|
||||
-i, --interactive=false Attach container's STDIN
|
||||
-a, --attach=false Attach container's `STDOUT` and `STDERR` and forward all signals to the process
|
||||
-i, --interactive=false Attach container's `STDIN`
|
||||
|
||||
When run on a container that has already been started,
|
||||
takes no action and succeeds unconditionally.
|
||||
|
|
@ -1464,12 +1445,12 @@ takes no action and succeeds unconditionally.
|
|||
|
||||
Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
|
||||
|
||||
Stop a running container by sending SIGTERM and then SIGKILL after a grace period
|
||||
Stop a running container by sending `SIGTERM` and then `SIGKILL` after a grace period
|
||||
|
||||
-t, --time=10 Number of seconds to wait for the container to stop before killing it. Default is 10 seconds.
|
||||
|
||||
The main process inside the container will receive SIGTERM, and after a
|
||||
grace period, SIGKILL
|
||||
The main process inside the container will receive `SIGTERM`, and after a
|
||||
grace period, `SIGKILL`.
|
||||
|
||||
## tag
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue