Commit graph

600 commits

Author SHA1 Message Date
Vincent Demeester
3d28cdd2f5 Merge pull request #25308 from thaJeztah/join-token-refactor
Improve swarm join-token instructions
2016-08-02 18:57:37 +02:00
Vincent Demeester
50c08f0f09 Merge pull request #25330 from yongtang/docs-service-create-update-user
Update docs in `docker service create/update` for flag `--user`
2016-08-02 17:58:39 +02:00
Sebastiaan van Stijn
ebebd41769
Improve swarm join-token instructions
this change improves the instructions for
swarm join-token and swarm init;

- only print the join-token command for workers
  instead of for both managers and workers, to
  prevent users from copying the wrong command.
  An extra line is added to explain how to obtain
  the manager token.
- print a message that a token was rotated
  sucesfully if '--rotate' is used.
- add some extra white-space before / after
  the join commands, to make copy/pasting
  easier.

this change also does some refactoring of join-token;

- move flagname-constants together with other constants
- use variables for selected role ("worker" / "manager")
  to prevent checking for them multiple times, and to
  keep the "worker" / "manager" sting centralized
- add an extra blank line after "join-token" instructions
  this makes it easier to copy, and cleans up the
  code a tiny bit

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-08-02 16:44:02 +02:00
Yong Tang
80a3755a8f Update docs in docker service create/update for flag --user
In `docker service create/update`, flag `--user` actually supports
`uid:gid` (same as `docker run`). However, this is not reflected
in the help and documentation yet.

This fix updates docs in `docker service create/update` to change
the description to `Username or UID (format: <name|uid>[:<group|gid>])`.

The help message output has also been updated.

This fix is related to 25304.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
2016-08-02 07:01:16 -07:00
Qiang Huang
59069ba29a Fix kernel memory updating docs
Specify that kernel memory updating limitation only applies
on kernel version older than 4.6.

Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2016-08-02 13:36:58 +08:00
allencloud
6c5988ed8c update command description in CLI
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-07-31 00:06:18 +08:00
Charles Smith
ee355e017d Merge pull request #25182 from sfsmithcha/clarify_join_token
Author Merge add advertise address, clarify join token

CI errors expected.
2016-07-29 16:10:20 -07:00
Charles Smith
1e7219d40f add advertise address, clarify join token
Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-07-29 15:45:34 -07:00
Sebastiaan van Stijn
498cd17427 Merge pull request #24535 from thaJeztah/minor-docs-fixup
docs: cleanup docker update docs
2016-07-29 02:53:01 +02:00
Sebastiaan van Stijn
f0230049f0
Update usage of "Swarm" for consistency
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-27 23:31:55 +02:00
Sebastiaan van Stijn
1a7d339d36 Merge pull request #24816 from stevvooe/service-ps-over-tasks
cli: `docker service|node|stack ps` instead of tasks
2016-07-27 23:13:28 +02:00
Michael Crosby
297745b1cd Merge pull request #24760 from anusha-ragunathan/plugin-events
Make daemon events listen for plugin lifecycle events.
2016-07-27 13:36:49 -07:00
Stephen J Day
0aa4e1e689
cli: docker service|node|stack ps instead of tasks
Rather than conflict with the unexposed task model, change the names of
the object-oriented task display to `docker <object> ps`. The command
works identically to `docker service tasks`. This change is superficial.

This provides a more sensical docker experience while not trampling on
the task model that may be introduced as a top-level command at a later
date.

The following is an example of the display using `docker service ps`
with a service named `condescending_cori`:

```
$ docker service ps condescending_cori
ID                         NAME                  SERVICE             IMAGE   LAST STATE              DESIRED STATE  NODE
e2cd9vqb62qjk38lw65uoffd2  condescending_cori.1  condescending_cori  alpine  Running 13 minutes ago  Running        6c6d232a5d0e
```

The following shows the output for the node on which the command is
running:

```console
$ docker node ps self
ID                         NAME                  SERVICE             IMAGE   LAST STATE              DESIRED STATE  NODE
b1tpbi43k1ibevg2e94bmqo0s  mad_kalam.1           mad_kalam           apline  Accepted 2 seconds ago  Accepted       6c6d232a5d0e
e2cd9vqb62qjk38lw65uoffd2  condescending_cori.1  condescending_cori  alpine  Running 12 minutes ago  Running        6c6d232a5d0e
4x609m5o0qyn0kgpzvf0ad8x5  furious_davinci.1     furious_davinci     redis   Running 32 minutes ago  Running        6c6d232a5d0e
```

Signed-off-by: Stephen J Day <stephen.day@docker.com>
2016-07-27 11:06:42 -07:00
Sebastiaan van Stijn
053ac127ab
Remove release-candidate advisories
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-27 11:24:16 +02:00
Sebastiaan van Stijn
d8c9fd0af9 Merge pull request #24970 from sfsmithcha/daemonless_containers
add doc for live-restore setting and daemonless containers, fix admin…
2016-07-27 11:00:15 +02:00
Anusha Ragunathan
42abccb841 Make daemon events listen for plugin lifecycle events.
Signed-off-by: Anusha Ragunathan <anusha@docker.com>
2016-07-26 10:51:47 -07:00
Vincent Demeester
4031d70d1b Add container labels to service create/update
Swarm mode makes it possible through the API to set labels to containers
but not through command line. This tries to fix it.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-25 18:57:02 -07:00
Charles Smith
cbd07495a3 add doc for live-restore setting and daemonless containers, fix admin guide menu
Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-07-25 09:29:57 -07:00
Aaron Lehmann
57ae29aa74 Add failure action for rolling updates
This changes the default behavior so that rolling updates will not
proceed once an updated task fails to start, or stops running during the
update. Users can use docker service inspect --pretty servicename to see
the update status, and if it pauses due to a failure, it will explain
that the update is paused, and show the task ID that caused it to pause.
It also shows the time since the update started.

A new --update-on-failure=(pause|continue) flag selects the
behavior. Pause means the update stops once a task fails, continue means
the old behavior of continuing the update anyway.

In the future this will be extended with additional behaviors like
automatic rollback, and flags controlling parameters like how many tasks
need to fail for the update to stop proceeding. This is a minimal
solution for 1.12.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-07-25 08:51:19 -07:00
Aaron Lehmann
fca0b18dcb Require listen address and advertise address to be an IP address or an interface name
Hostnames are not supported for now because libnetwork can't use them
for overlay networking yet.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-07-24 09:23:38 -07:00
Aaron Lehmann
a0ccd0d42f Split advertised address from listen address
There are currently problems with "swarm init" and "swarm join" when an
explicit --listen-addr flag is not provided. swarmkit defaults to
finding the IP address associated with the default route, and in cloud
setups this is often the wrong choice.

Introduce a notion of "advertised address", with the client flag
--advertise-addr, and the daemon flag --swarm-default-advertise-addr to
provide a default. The default listening address is now 0.0.0.0, but a
valid advertised address must be detected or specified.

If no explicit advertised address is specified, error out if there is
more than one usable candidate IP address on the system. This requires a
user to explicitly choose instead of letting swarmkit make the wrong
choice. For the purposes of this autodetection, we ignore certain
interfaces that are unlikely to be relevant (currently docker*).

The user is also required to choose a listen address on swarm init if
they specify an explicit advertise address that is a hostname or an IP
address that's not local to the system. This is a requirement for
overlay networking.

Also support specifying interface names to --listen-addr,
--advertise-addr, and the daemon flag --swarm-default-advertise-addr.
This will fail if the interface has multiple IP addresses (unless it has
a single IPv4 address and a single IPv6 address - then we resolve the
tie in favor of IPv4).

This change also exposes the node's externally-reachable address in
docker info, as requested by #24017.

Make corresponding API and CLI docs changes.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-07-24 09:23:07 -07:00
Vincent Demeester
180f8c61bb
Update swarm init task-history-limit docs
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-24 11:13:06 +02:00
Sebastiaan van Stijn
8e8580c680 Merge pull request #24960 from aaronlehmann/update-parallelism-docs
Update --update-parallelism docs
2016-07-23 10:35:34 +02:00
Aaron Lehmann
933ba8d7f7 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>
2016-07-22 19:07:10 -07:00
Sebastiaan van Stijn
987511712f Remove "secrets" leftovers from docs
f5e1f6f688 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>
2016-07-23 01:28:20 +02:00
Vincent Demeester
8426f72107
Append --registry-auth with with
`--with-registry-auth` is more explicit.

Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-22 10:38:56 +02:00
Aaron Lehmann
2cc5bd33ee 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>
2016-07-21 15:23:03 -07:00
Sebastiaan van Stijn
2debfe8435 Merge pull request #24892 from thaJeztah/fix-label-formatting-example
docs: improve formatting and highlighting of docker ps reference
2016-07-21 12:38:45 +02:00
Vincent Demeester
22d020276c Merge pull request #24700 from nishanttotla/pass-registry-auth-on-deploy
Send registry auth token for service deploy
2016-07-21 12:33:33 +02:00
Sebastiaan van Stijn
07ef0a37f8
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>
2016-07-21 12:27:39 +02:00
Sebastiaan van Stijn
ccd0d83344 Merge pull request #24866 from thaJeztah/fix-sloppy-copy-pasta
docs: fix copy/pasta error
2016-07-21 02:02:28 +02:00
Nishant Totla
a26bdd8607
Send registry auth token for service deploy
Signed-off-by: Nishant Totla <nishanttotla@gmail.com>
2016-07-20 16:07:07 -07:00
Sebastiaan van Stijn
8c6c1aaf07 Merge pull request #24842 from thaJeztah/fix-code-highlight
docs: add code-hints to builder page
2016-07-21 00:06:52 +02:00
Sebastiaan van Stijn
83b12c0c11
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>
2016-07-20 23:59:38 +02:00
Sebastiaan van Stijn
eefc17bba1 Merge pull request #24838 from thaJeztah/add-log-options-to-docs
Add missing --log-driver and --log-opt docs
2016-07-20 23:50:10 +02:00
Sebastiaan van Stijn
9d532b5e2d
docs: update reference docs for plugins
the output/response slightly changed in
340964db1c,
and `:latest` is no longer required for
various actions.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-20 23:37:55 +02:00
Sebastiaan van Stijn
f49dc528ed
docs: add initial reference for "stack services"
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-20 18:56:49 +02:00
Arnaud Porterie
b9c4959882 Merge pull request #24841 from thaJeztah/rename-bundle-flag
[RFC] Rename --bundle to --file
2016-07-20 15:50:54 +00:00
Sebastiaan van Stijn
b5503ef0a5
docs: add code-hints to builder page
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-20 16:18:44 +02:00
Sebastiaan van Stijn
06f35262c4
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>
2016-07-20 16:03:27 +02:00
Sebastiaan van Stijn
effbd2b76d
fix duplicated usage in docs
this removes a copy/pasta whoopsie on my side,
introduced in de64324109

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2016-07-20 15:36:02 +02:00
Sebastiaan van Stijn
5ece2a6e0d
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>
2016-07-20 14:55:26 +02:00
Sebastiaan van Stijn
724c69f060 Merge pull request #24507 from sfsmithcha/doc_node_labels
add ref docs for node label
2016-07-20 00:46:51 +02:00
Charles Smith
9594ac97ce add ref docs for node label
Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-07-19 15:41:00 -07:00
Vincent Demeester
10919e8909
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>
2016-07-19 18:32:44 +02:00
Dong Chen
e1165cdfd1 Support node label update.
Signed-off-by: Dong Chen <dongluo.chen@docker.com>
2016-07-18 18:39:52 -07:00
Arnaud Porterie
de64324109 Merge pull request #24705 from thaJeztah/update-flag-descriptions
Improve flag help consistency, and update docs
2016-07-18 16:07:23 +00:00
allencloud
d0081a0f47 better command docker network create -h output
Signed-off-by: allencloud <allen.sun@daocloud.io>
2016-07-16 15:32:17 +08:00
Sebastiaan van Stijn
64a8317a5a 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>
2016-07-16 01:58:01 +02:00
Qiang Huang
92dfbc1e2d Fix aufs docs
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2016-07-15 13:57:38 +08:00