Commit Graph

417 Commits

Author SHA1 Message Date
4304688cd7 Fix a few code rendering errors in docs
Signed-off-by: ChristoperBiscardi <chris@docker.com>
Upstream-commit: 50caf393cb
Component: cli
2017-06-02 00:06:49 +00:00
91fa2d600e filter events by container name,id or partial id
Addresses #10645

Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
Upstream-commit: d174e92779
Component: cli
2017-06-02 00:06:49 +00:00
8397f0209d Set default restart policy name to 'no' Closes #10874
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: 688dc5977b
Component: cli
2017-06-02 00:06:49 +00:00
46e22930ae Fix docker start help message
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: a9394281b4
Component: cli
2017-06-02 00:06:48 +00:00
4ffbcead4d Add support for 'docker cp' to write to stdout
Closes #10805

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 30240ffc53
Component: cli
2017-06-02 00:06:48 +00:00
0f5cfa4975 fix to cpu.shares documentation by @hqhq
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 5f274ccd57
Component: cli
2017-06-02 00:06:48 +00:00
512a13d62b docs: fix cpu.shares part in man pages
The original description has some mistakes and lack of many useful
information, I rewrite them to make it accurate and complete.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Upstream-commit: ef5874f0a9
Component: cli
2017-06-02 00:06:48 +00:00
54ef332e9a Docs: add restart-policies to 'Run reference'
This moves some information on restart-policies from
the "command line" page to "run reference".

Also fixes some minor typos and adds a "NOTE"
about --rm and --restart not allowed to be combined.

Also removes inline CSS styles from tables,
which will be styled by the stylesheet, and fixes
some minor MarkDown errors (`<` -> &lt;)

depends on https://github.com/docker/docs-base/pull/1

resolves #11069

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 99a47ff600
Component: cli
2017-06-02 00:06:48 +00:00
d6cbeaf542 Tell users about how VOLUME initializes the new mount point/volume
Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: d69dea3c44
Component: cli
2017-06-02 00:06:48 +00:00
237e7669a6 docker info display http/https_proxy setting
Signed-off-by: Zhang Wentao <zhangwentao234@huawei.com>
Upstream-commit: 93b07b4a63
Component: cli
2017-06-02 00:06:48 +00:00
805c1892c0 Add cors header flag and leave boolean flag not changed
Deprecate api-enable-cors

Update docs & man files

Signed-off-by: harry zhang <resouer@163.com>
Upstream-commit: 92b48f975a
Component: cli
2017-06-02 00:06:48 +00:00
0c176b600d Fix 'docker ps --help' so the options don't span more than one line
and add a testcase to catch this in the future.

While in there I also:
- removed extra periods from the few options that had them (new test)
- made the --filter option consistent across all command

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 71a1c33533
Component: cli
2017-06-02 00:06:48 +00:00
d780896594 Allow setting ulimits for containers
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: d20a7f0d85
Component: cli
2017-06-02 00:06:48 +00:00
af66fddb35 Support dockerfile and Dockerfile
Closes #10807

Adds support for `dockerfile` ONLY when `Dockerfile` can't be found.
If we're building from a Dockerfile via stdin/URL then always download
it a `Dockerfile` and ignore the -f flag.

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 9574a12bad
Component: cli
2017-06-02 00:06:48 +00:00
ba91e1ac06 Notes should be indented
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 8ac0e4d95e
Component: cli
2017-06-02 00:06:48 +00:00
20da3725ba Update cli.md
Use `-it` combination in example instead of `-ti`, because this is how it used everywhere in examples.

Update dockerfile_best-practices.md

Fix typo in command name

Signed-off-by: Dmitry Gusev <dmitry.gusev@gmail.com>
Upstream-commit: aadc671cf0
Component: cli
2017-06-02 00:06:48 +00:00
d3e248b539 Correct --add-host documentation regarding host IP address retrieval
Fixes: 10855

The example was actually incorrect for many situations, and also, now
that we have IPv6 we should not that the example is for IPv4 and note
how to find IPv6 addresses.  Also, the device they want to connect to
could be the bridge, or main ethernet device, or some other device
name, so note that as well.

Docker-DCO-1.1-Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com> (github: estesp)
Upstream-commit: 3004c90b51
Component: cli
2017-06-02 00:06:48 +00:00
0ebeff7671 Implements stats for lxc driver
Implements stats and fixes stats test.

Signed-off-by: Abin Shahab <ashahab@altiscale.com> (github: ashahab-altiscale)
Upstream-commit: 91b4e8ad56
Component: cli
2017-06-02 00:06:47 +00:00
81765c1180 pass --change changes to the import job
Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: 99ef14ddab
Component: cli
2017-06-02 00:06:47 +00:00
699ee445ac add docs for commit --change
Docker-DCO-1.1-Signed-off-by: Daniel, Dao Quang Minh <dqminh89@gmail.com> (github: dqminh)

Docker-DCO-1.1-Signed-off-by: Dan Walsh <dwalsh@redhat.com> (github: rhatdan)
Upstream-commit: 6042a6f9a4
Component: cli
2017-06-02 00:06:47 +00:00
1b5e543305 a little re-writing
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 10560b0a8f
Component: cli
2017-06-02 00:06:47 +00:00
ea73b522bd cli: Add server OS/Arch info to 'version' cmd
Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
Upstream-commit: b67b89f4cd
Component: cli
2017-06-02 00:06:47 +00:00
c047794822 Remove CLI doc entry related to API-only function
Closes #10278

Signed-off-by: Brian Goff <cpuguy83@gmail.com>
Upstream-commit: 209f3889e0
Component: cli
2017-06-02 00:06:47 +00:00
b5d06e072c Fixes #10457-Pause-and-unpause-accept-multi-containers
Applied multi parameters to pause and unpause.
Created a new test file dedicated for pause commands.
Created a new utility function to get a slice of paused containers.
Updated documentation

Signed-off-by: André Martins <martins@noironetworks.com>
Upstream-commit: d73a9d48f5
Component: cli
2017-06-02 00:06:47 +00:00
9ba45bbe34 Group published and exposed ports by contiguous ranges
Signed-off-by: Colm Hally <colmhally@gmail.com>
Upstream-commit: 6ecd6bb069
Component: cli
2017-06-02 00:06:47 +00:00
b8f84c577a add logpath to docker inspect.
Signed-off-by: Bradley Cicenas <bradley.cicenas@gmail.com>
Upstream-commit: f99a52dc6c
Component: cli
2017-06-02 00:06:47 +00:00
7719cf0e1f Shorten help messages for docker cmd flags
In order to fit printed messages to fit 80 chars,
rewording messages for `-H` and `--tls` flags.

Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
Upstream-commit: ee1b138b2b
Component: cli
2017-06-02 00:06:47 +00:00
28ebc7e0f5 Fix 'docker stats' help message
Closes #10771

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: f91ddd939f
Component: cli
2017-06-02 00:06:47 +00:00
432a9fc0f7 Removes the feature to pull all image aliases.
It didn't work on v2 anyways. And an image with a lot of aliases was slow to
fetch.

Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <princess@docker.com> (github: jfrazelle)
Upstream-commit: 16b4b98c34
Component: cli
2017-06-02 00:06:47 +00:00
8a8f9ad087 Use newer help out for 'docker' and 'docker run'
Closes #10828

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 3820b31267
Component: cli
2017-06-02 00:06:47 +00:00
e8160e6d23 Update docs for HTTP_PROXY
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 8c6610787a
Component: cli
2017-06-02 00:06:46 +00:00
2859cab687 Documentation on boolean flags is wrong #10517
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 2202790fcd
Component: cli
2017-06-02 00:06:46 +00:00
f0885a3ea4 Distinguish ENV from setting environment inline
It's ambiguous to say that `ENV` is _functionally equivalent to prefixing the command with `<key>=<value>`_. `ENV` sets the environment for all future commands, but `RUN` can take chained commands like `RUN foo=bar bash -c 'echo $foo' && bash -c 'echo $foo $bar'`. Users with a solid understanding of `exec` may grok this without confusion, but less experienced users may need this distinction.

Signed-off-by: Michael A. Smith <msmith3@ebay.com>

Improve Environment Handling Descriptions

- Link `ENV` and `Environment Replacement`
- Improve side-effects of `ENV` text
- Rearrange avoiding side effects text

Signed-off-by: Michael A. Smith <msmith3@ebay.com>
Upstream-commit: 95fe3a1a93
Component: cli
2017-06-02 00:06:46 +00:00
d738b0d9c0 Fix example about ps and linked containers
Signed-off-by: Alexander Morozov <lk4d4@docker.com>
Upstream-commit: 74279772e5
Component: cli
2017-06-02 00:06:46 +00:00
d22e4aebf1 update docs for memory and memoryswap
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Upstream-commit: c03b0700a4
Component: cli
2017-06-02 00:06:46 +00:00
5a74dcd37e For now, docker stats appears to be libcontainer only
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: e52b4ad35c
Component: cli
2017-06-02 00:06:46 +00:00
f6eff1aac5 Fix a small spelling error in the dm.blkdiscard docs
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: aa33ee11d0
Component: cli
2017-06-02 00:06:46 +00:00
5b966c6a59 Docker attach documentation didn't make sense to me
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: 89e02d9d88
Component: cli
2017-06-02 00:06:46 +00:00
f0ff9d086e Pretty the help text
This modifies the "docker help" text so that it is no wider than 80 chars
and each description fits on one line. This will also try to use ~ when
possible

Added a test to make sure we don't go over 80 chars again.
Added a test to make sure we use ~

Applied rules/tests to all docker commands - not just main help text

Closes #10214

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 130c0bf094
Component: cli
2017-06-02 00:06:46 +00:00
352ffbf987 Spelling mistake in dockerlinks
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: c995dee4c1
Component: cli
2017-06-02 00:06:46 +00:00
3b006fc8cc docs: change events --since to fit RFC3339Nano
PR6931 changed time format to RFC3339Nano.
But the example in cli.md does not changed.

Signed-off-by: Chen Hanxiao <chenhanxiao@cn.fujitsu.com>
Upstream-commit: 2627488a27
Component: cli
2017-06-02 00:06:46 +00:00
5d0802d112 Fix docs so WORKDIR mentions it works for COPY and ADD too
The docs around COPY/ADD already mentioned that it will do a relative
copy/add based on WORKDIR, so that part is already ok.  Just needed to
tweak the WORKDIR section since w/o mentioning COPY/ADD it can be misleading.

Noticed by @phemmer

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 37fd964edb
Component: cli
2017-06-02 00:06:46 +00:00
ec0d1c6463 Docker run -e FOO should erase FOO if FOO isn't set in client env
See #10141 for more info, but the main point of this is to make sure
that if you do "docker run -e FOO ..." that FOO from the current env
is passed into the container.  This means that if there's a value, its
set.  But it also means that if FOO isn't set then it should be unset in
the container too - even if it has to remove it from the env.  So,
   unset HOSTNAME
   docker run -e HOSTNAME busybox env
should _NOT_ show HOSTNAME in the list at all

Closes #10141

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 642218cefa
Component: cli
2017-06-02 00:06:45 +00:00
3de3e281b4 Update to docker stats documentation
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: 3296ada2ed
Component: cli
2017-06-02 00:06:45 +00:00
1bdb79875f Add documentation for stats feature
Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: 9da6238f41
Component: cli
2017-06-02 00:06:45 +00:00
a556d8bf19 Add docs for --memory-swap.
Docker-DCO-1.1-Signed-off-by: Jessica Frazelle <jess@docker.com> (github: jfrazelle)
Upstream-commit: f870b2c6f5
Component: cli
2017-06-02 00:06:45 +00:00
5dccac542c Update the docs for --link accept container id
Signed-off-by: Lei Jitang <leijitang@huawei.com>
Upstream-commit: ca57d01f87
Component: cli
2017-06-02 00:06:45 +00:00
ef7ce74d6b Add the list of possible values for --log-level to help text
Closes #10034

Signed-off-by: Doug Davis <dug@us.ibm.com>
Upstream-commit: 6f56148726
Component: cli
2017-06-02 00:06:45 +00:00
5e88125007 Document that ENV vars are not automatically updated
Unlike the entries in `/etc/hosts`, environment-variables for linked
containers are not automatically updated if the linked container is
restarted.

This adds a note to the documentation in;
https://docs.docker.com/userguide/dockerlinks/#environment-variables
and
https://docs.docker.com/reference/run/#env-environment-variables

To make users aware that this is the case and recommends them to use
the `/etc/hosts` entries in stead.

I added this change because users were expecting environment variables
to be updated automatically as well (https://github.com/docker/docker/issues/10164).

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 7c63b49df6
Component: cli
2017-06-02 00:06:45 +00:00
b6a4c9fe71 Add documentation for HTTP proxies
Signed-off-by: Arnaud Porterie <arnaud.porterie@docker.com>
Upstream-commit: 4939c04b28
Component: cli
2017-06-02 00:06:45 +00:00