Commit Graph

385 Commits

Author SHA1 Message Date
b0dc49bd20 Update --update-parallelism docs
Update documentation to account for the changes in #24952.

docs/swarm/swarm-tutorial/rolling-update.md doesn't need any changes,
but the CLI reference pages should show the current help text.
drain-node.md no longer needs to specify --update-parallelism 1 in its
example.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: 012fa2fd1b
Component: cli
2017-06-02 00:10:02 +00:00
153b86e778 Remove "secrets" leftovers from docs
f5e1f6f6880391a5a3399023cf93a3c48502e57d replaced "secrets"
with "join tokens", which also removed the "auto-accept"
policy.

This removes some remaining references to those features.

Note that there are other references, but those
are already addressed in another pull request.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 2a87a358d4
Component: cli
2017-06-02 00:10:02 +00:00
a677374f33 Append --registry-auth with with
`--with-registry-auth` is more explicit.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 2f9e9bcbaa
Component: cli
2017-06-02 00:10:02 +00:00
e128f0ccd5 Replace secrets with join tokens
Implement the proposal from
https://github.com/docker/docker/issues/24430#issuecomment-233100121

Removes acceptance policy and secret in favor of an automatically
generated join token that combines the secret, CA hash, and
manager/worker role into a single opaque string.

Adds a docker swarm join-token subcommand to inspect and rotate the
tokens.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: acf0bc4b9a
Component: cli
2017-06-02 00:10:02 +00:00
9fcee1694f docs: improve formatting and highlighting of docker ps reference
this improves the formatting, and code-highlighting
of the `docker ps` reference page, and wraps sentences
to 80 chars

also adds single quotes around the formatting
example for labels.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 458ff79b0d
Component: cli
2017-06-02 00:10:01 +00:00
5882e1e770 Send registry auth token for service deploy
Signed-off-by: Nishant Totla <nishanttotla@gmail.com>
Upstream-commit: 49f4d8c083
Component: cli
2017-06-02 00:10:01 +00:00
f68a53fc11 docs: fix copy/pasta error
Looks like I copied from the line below, not
from the output :)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 99bf996fdf
Component: cli
2017-06-02 00:10:01 +00:00
9ef6997418 docs: add code-hints to builder page
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 7a206d8667
Component: cli
2017-06-02 00:10:01 +00:00
b76715195d Add missing --log-driver and --log-opt docs
Adds documentation for "--log-driver" and "--log-opt"
for services.

Also updated the API docs to include the new
options, and generated a more complete JSON
example.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: c8dd8fe523
Component: cli
2017-06-02 00:10:01 +00:00
2c7da5e3f9 docs: update reference docs for plugins
the output/response slightly changed in
340964db1c8f161a2ad156023eb47dcc93bf804b,
and `:latest` is no longer required for
various actions.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 338cf2edd8
Component: cli
2017-06-02 00:10:01 +00:00
6119ded502 docs: add initial reference for "stack services"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 77f90b24c9
Component: cli
2017-06-02 00:10:01 +00:00
a3bce52171 Rename --bundle to --file
This renames the '--bundle' flag for docker (stack) deploy
to be consistent with 'docker build'.

Note that there's no shorthand '-f' added for now,
because this may be confusing on 'docker stack config',
which also takes a file, and for which we may want to
have a '--format' flag in future.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: b2d71bfbe1
Component: cli
2017-06-02 00:10:01 +00:00
28c1cdf296 fix duplicated usage in docs
this removes a copy/pasta whoopsie on my side,
introduced in de64324109d2694b1525e62b5c0072267282a36c

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 27584ec78a
Component: cli
2017-06-02 00:10:01 +00:00
88bdaca178 add ref docs for node label
Signed-off-by: Charles Smith <charles.smith@docker.com>
Upstream-commit: 59b234a119
Component: cli
2017-06-02 00:10:01 +00:00
cf739dd8ae Add documentation for stack commands
Also removes the `-f` flags of bundle to follow the single-letter flags
evaluation.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: ad98aba1b6
Component: cli
2017-06-02 00:10:01 +00:00
0d39fe49af Support node label update.
Signed-off-by: Dong Chen <dongluo.chen@docker.com>
Upstream-commit: ab696a54ef
Component: cli
2017-06-02 00:07:51 +00:00
c6248ce73e Improve flag help consistency, and update docs
This adds the `--live-restore` option to the documentation.

Also synched usage description in the documentation
with the actual description, and re-phrased some
flag descriptions to be a bit more consistent.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 77e4100d00
Component: cli
2017-06-02 00:07:51 +00:00
0a2537fe3e better command docker network create -h output
Signed-off-by: allencloud <allen.sun@daocloud.io>
Upstream-commit: eb0a4426e2
Component: cli
2017-06-02 00:07:51 +00:00
25a52f75a6 Fix aufs docs
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Upstream-commit: 28a1369b30
Component: cli
2017-06-02 00:07:51 +00:00
a7e6ee6b34 docs: correct the placement constraints docker service example
- the constraint expression needs to be quoted
- add an actual redis container to run so the command line works

Signed-off-by: Anil Madhavapeddy <anil@docker.com>
Upstream-commit: d41a63b2c0
Component: cli
2017-06-02 00:07:51 +00:00
c045aaef40 Update service inspect --pretty reference docs
Update the output and fix wrong usage in a tutorial page.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: ee88be2801
Component: cli
2017-06-02 00:07:51 +00:00
552a6bdadf Update service update commandline reference docs
Update with the new remove flags

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: fa29084b31
Component: cli
2017-06-02 00:07:50 +00:00
cd2e200af5 Use spaces, not tabs, to format sample "swarm join" command
Using tabs here seems to cause copy/paste problems in some terminals.
Using spaces is safer.

Fixes #24609

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: 1210363e0f
Component: cli
2017-06-02 00:07:50 +00:00
857bcf3a13 Remove shorthand flags for "mount", "pretty", and "no-resolve"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: c33bc7d99e
Component: cli
2017-06-02 00:07:50 +00:00
6e1ddd3acb Add --oom-score-adjust to daemon
This adds an `--oom-score-adjust` flag to the daemon so that the value
provided can be set for the docker daemon's process.  The default value
for the flag is -500.  This will allow the docker daemon to have a
less chance of being killed before containers do.  The default value for
processes is 0 with a min/max of -1000/1000.

-500 is a good middle ground because it is less than the default for
most processes and still not -1000 which basically means never kill this
process in an OOM condition on the host machine.  The only processes on
my machine that have a score less than -500 are dbus at -900 and sshd
and xfce( my window manager ) at -1000.  I don't think docker should be
set lower, by default, than dbus or sshd so that is why I chose -500.

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
Upstream-commit: e3f04f5d20
Component: cli
2017-06-02 00:07:50 +00:00
34f04d67ef Remove --command flag for service update
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 2e844f5e8d
Component: cli
2017-06-02 00:07:50 +00:00
ec89b7a71d Make labels human readable
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: dd1708d943
Component: cli
2017-06-02 00:07:50 +00:00
5094a98e8e fix the docker run --readonly example. rename '/icanwrite here' to '/icanwrite/here'
Signed-off-by: Mei ChunTao <mei.chuntao@zte.com.cn>
Upstream-commit: 17d3e6264a
Component: cli
2017-06-02 00:07:50 +00:00
d1c6ce2e15 Rename --net to --network
Add a `--network` flag which replaces `--net` without deprecating it
yet. The `--net` flag remains hidden and supported.

Add a `--network-alias` flag which replaces `--net-alias` without deprecating
it yet. The `--net-alias` flag remains hidden and supported.

Signed-off-by: Arnaud Porterie (icecrime) <arnaud.porterie@docker.com>
Upstream-commit: 253a5f4ea2
Component: cli
2017-06-02 00:07:50 +00:00
99f6eee8f1 Add "auto-accept=none" to documentation
The "none" option was not added to the documentation.
This adds an example, and adds additional information
on manually accepting or rejecting a node.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 9958abc17d
Component: cli
2017-06-02 00:07:50 +00:00
c7586ac2d7 Allow option to override kernel check in overlay2
Add option to skip kernel check for older kernels which have been patched to support multiple lower directories in overlayfs.

Fixes #24023

Signed-off-by: Derek McGowan <derek@mcgstyle.net> (github: dmcgowan)
Upstream-commit: 48e659e30c
Component: cli
2017-06-02 00:07:49 +00:00
3e8053bffe Add support for comma-separated --auto-accept syntax.
Signed-off-by: John Harris <john@johnharris.io>
Upstream-commit: 2f3e095768
Component: cli
2017-06-02 00:07:49 +00:00
8a2bb174bf Soften limitation of update kernel memory
Kernel memory is not allowed to be updated if container is
running, it's not actually a precise kernel limitation.

Before kernel version 4.6, kernel memory will not be accounted
until kernel memory limit is set, if a container created with
kernel memory initialized, kernel memory is accounted as soon
as process created in container, so kernel memory limit update
is allowed afterward. If kernel memory is not initialized,
kernel memory consumed by processes in container will not be
accounted, so we can't update the limit because the account
will be wrong.

So update kernel memory of a running container with kernel memory
initialized is allowed, we should soften the limitation by docker.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
Upstream-commit: 670a0b8077
Component: cli
2017-06-02 00:07:49 +00:00
9c6c426595 add constraint to service create ref
Signed-off-by: Charles Smith <charles.smith@docker.com>
Upstream-commit: bf31e188d9
Component: cli
2017-06-02 00:07:49 +00:00
92dde977e4 add iptables=false to docs for multiple daemons
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 59e2c57540
Component: cli
2017-06-02 00:07:49 +00:00
177af81c48 Updates on cli reference documentation
- Update ps with `--last` flag
- Update commands with current output
- Make sure hugo does not detect the wrong language
- Update usage for `tag` command to be more coherent with the other ones

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 3ebe3fe752
Component: cli
2017-06-02 00:07:49 +00:00
29b9ce751d Generate a swarm joining secret if none is specified
The current behavior of `docker swarm init` is to set up a swarm that
has no secret for joining, and does not require manual acceptance for
workers. Since workers may sometimes receive sensitive data such as pull
credentials, it makes sense to harden the defaults.

This change makes `docker swarm init` generate a random secret if none
is provided, and print it to the terminal. This secret will be needed to
join workers or managers to the swarm. In addition to improving access
control to the cluster, this setup removes an avenue for
denial-of-service attacks, since the secret is necessary to even create
an entry in the node list.

`docker swarm init --secret ""` will set up a swarm without a secret,
matching the old behavior. `docker swarm update --secret ""` removes the
automatically generated secret after `docker swarm init`.

Closes #23785

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: e632408a37
Component: cli
2017-06-02 00:07:49 +00:00
ad92fbb392 Use "on-failure" for both containers and services
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: de7c6a8355
Component: cli
2017-06-02 00:07:49 +00:00
c75cd892f1 make docker service --help text for --endpoint-mode more consistent
Previously:

```
      --constraint value             Placement constraints (default [])
      --endpoint-mode string         Endpoint mode(Valid values: vip, dnsrr)
<snip>
      --restart-condition string     Restart when condition is met (none, on_failure, or any)
```

Now:

```
      --constraint value             Placement constraints (default [])
      --endpoint-mode string         Endpoint mode (vip or dnsrr)
<snip>
      --restart-condition string     Restart when condition is met (none, on_failure, or any)
```

Signed-off-by: Anil Madhavapeddy <anil@docker.com>
Upstream-commit: 20859b146b
Component: cli
2017-06-02 00:07:49 +00:00
166ef9b898 Change NAME to HOSTNAME in docs for docker node ls
In #24159, the title field of `docker node ls` has been
changed from NAME to HOSTNAME. However, in the docs the
NAMEs are still used for the output of `docker node ls`.

This fix updates docs so that NAME field is changed to
HOSTNAME for all `docker node ls`.

This fix is related to #24159 and #24090.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
Upstream-commit: cab7139a4b
Component: cli
2017-06-02 00:07:48 +00:00
80567c7095 Fix spelling in comments, strings and documentation
Signed-off-by: Otto Kekäläinen <otto@seravo.fi>
Upstream-commit: 8e2c3efc58
Component: cli
2017-06-02 00:07:48 +00:00
273d3ff4f9 man: add missing --add-runtime
Signed-off-by: Antonio Murdaca <runcom@redhat.com>
Upstream-commit: fac7c67349
Component: cli
2017-06-02 00:07:48 +00:00
2138a28ca7 Fix typo
Signed-off-by: Adolfo Ochagavía <aochagavia92@gmail.com>
Upstream-commit: cbfebbb25a
Component: cli
2017-06-02 00:07:48 +00:00
9132e9d27a fix typo in "readonly" flag in documentation
the flag is named '--read-only', not '--readonly'

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: b4a798e983
Component: cli
2017-06-02 00:07:48 +00:00
688d1a439b Update network_create.md
minor typos and punctuation.

Signed-off-by: Alan Thompson <cloojure@gmail.com>
Upstream-commit: bd67dfdd33
Component: cli
2017-06-02 00:07:47 +00:00
98d6b5e9ba Fix --auto-accept documentation
The --auto-accept documentation currently says that both worker and
manager nodes are automatically accepted by default. Correct it.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: ca0240f9c2
Component: cli
2017-06-02 00:07:47 +00:00
89a2975fe8 add menu.md, make index.md command line reference, update typos/minor errors in cli docs
Signed-off-by: Charles Smith <charles.smith@docker.com>
Upstream-commit: a3b4cd7d99
Component: cli
2017-06-02 00:07:47 +00:00
138f629d25 rename desired_state filter to desired-state
For consistency with other filters (such as
"is-official"), this renames the desired_state
filter to "desired-state".

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: b9505045d9
Component: cli
2017-06-02 00:07:47 +00:00
e37780149a [Docs] clarified local volume driver docs
Signed-off-by: Nico <nicolaka@gmail.com>
Upstream-commit: f68b707d60
Component: cli
2017-06-02 00:07:47 +00:00
f9d84ba5b2 Add documentation for external CA features in API/CLI
Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: 4721039d71
Component: cli
2017-06-02 00:07:47 +00:00