Commit Graph

26 Commits

Author SHA1 Message Date
7196026b57 Standardized formatting of CLI reference commands
Command name should be a H1

Only Description, Examples, and Related Commands should be H2

Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands

Added some examples where relevant

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 52df69f00d966904ba230dc2e3a0646cc52b7688
Component: engine
2017-02-08 16:57:58 -08:00
ecbc8d61e5 Add the link for swarm reference document
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: ee23a8e124ef4801bcd0d044578da8daf63cba6f
Component: engine
2016-12-20 18:09:21 +08:00
ea1061f290 docs: fix description of docker swarm update --help
Signed-off-by: Kei Ohmura <ohmura.kei@gmail.com>
Upstream-commit: 2f0e00f58723cb3e063b49f564173b3768476c99
Component: engine
2016-12-11 21:25:40 +09:00
9ee3779eb4 cli: Change autolock flag description
This change incorporates feedback from @thaJeztah in the PR that added
the autolock flag. It changes the descriptions to be different for
"swarm init" and "swarm update" so that the boolean nature so that the
purpose of the flag in both contexts is clearer.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: 41b84e0994f9ec72990b7f0fc758f602f6241bc6
Component: engine
2016-11-10 12:05:19 -08:00
c4b7cbe0fb Document autolock/unlock/unlock-key
Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: 824db2c4543f912c1fdf392ebbaefa5540bc88a4
Component: engine
2016-11-09 16:12:11 -08:00
3cf5c6ee9d Fixes #24083 : Improving cli help for flags with duration option
Signed-off-by: milindchawre <milindchawre@gmail.com>
Upstream-commit: ecb59a2283be35b2dba2951ed1542afe4e896d8a
Component: engine
2016-11-09 12:17:28 +00:00
f7b4103706 cli: Add options for Raft snapshotting
Add the following options to "swarm init" and "swarm update":

- --max-snapshots: Retain this many old Raft snapshots in addition
  to the latest one

- --snapshot-interval: Number of log entries between Raft snapshots

These options already existed in SwarmKit and the Docker API but were
never exposed in the CLI. I'm adding them here to fix this oversight.

--max-snapshots may be useful for debugging purposes and more
conservative users who want to store rolling backups of old versions of
the Raft state.

--snapshot-interval is most useful for performance tuning. The default
value of 10000 may not be ideal for some setups.

There is also a LogEntriesForSlowFollowers option that is not exposed. I
decided not to expose it along with these others because I don't think
it's generally useful (and I'm not sure what I would call the CLI flag).
But if people want, I can expose it for the sake of completeness.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: 842d11f44cede2d7e9488e54f8ac8de89d8f4cd4
Component: engine
2016-11-08 13:14:01 -08:00
062414bb0e fix frontmatter keywords value type (string, instead of []string) in /docs/reference
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
Upstream-commit: 248c699ec88bb249ce9fd03001d13f29ac0b4b99
Component: engine
2016-11-03 15:48:30 -07:00
b2f3f16f09 Sync docker/docker refs with files mistakenly edited in docker.github.io repo
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 3b36f02c03ec050aa46f9a01cd2d6c60ffd93652
Component: engine
2016-10-20 10:51:30 -07:00
9fe833df60 Convert Markdown frontmatter to YAML
Some frontmatter such as the weights, menu stuff, etc is no longer used
'draft=true' becomes 'published: false'

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: b30609446d212624e3d4ce814c70130b75c552a0
Component: engine
2016-10-14 15:44:55 -07:00
faec4a3727 fix typo, change sample cert expiry value
Signed-off-by: Charles Smith <charles.smith@docker.com>
Upstream-commit: 8e53390b5101ae30a13fc40f2c2a52019f8b4906
Component: engine
2016-08-05 16:51:07 -07:00
aa7e6b8845 Update usage of "Swarm" for consistency
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: f0230049f0afd318217c60ebe486aab3b54538fd
Component: engine
2016-07-27 23:31:55 +02:00
07a9303505 Remove release-candidate advisories
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 053ac127ab0f784bebeda38f29f2d7615d2ffcb8
Component: engine
2016-07-27 11:24:16 +02:00
44cb49a379 Update swarm init task-history-limit docs
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 180f8c61bb1d3f05c21e697147b2f75a44bda485
Component: engine
2016-07-24 11:13:06 +02:00
b141a44de0 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: 2cc5bd33eef038bf5721582e2410ba459bb656e9
Component: engine
2016-07-21 15:23:03 -07:00
d634daae27 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: f4cfc6b9830ed236eb588d6a4dddca7455145e70
Component: engine
2016-07-07 20:43:18 +02:00
9da2bc7d4c Merge pull request #24059 from sfsmithcha/fix_cli_ref_menu
add menu.md, make index.md command line reference, update typos/minor…
Upstream-commit: 691bbeaf4411c56b9f5f19efb54db01c533ab8fc
Component: engine
2016-07-01 10:00:54 -07:00
b4d6f25674 Add documentation for external CA features in API/CLI
Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: fa147591edfb5fe5d5fb8952cdb9bfec1b4ae6c4
Component: engine
2016-06-30 18:08:57 -07:00
14e8a9a9a9 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: f98f596c19cb589569ec89bd12d562d8ddd03843
Component: engine
2016-06-30 14:30:11 -07:00
b6c8db0026 Merge pull request #23696 from sfsmithcha/check_swarm_cli
update docker swarm cli
Upstream-commit: bfff4cce676f12fb092e82b61cc626dfa3944405
Component: engine
2016-06-20 15:40:06 +02:00
aeecaae19f Add the advisory=rc metadata
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: daedbc60d61387cb284b871145b672006da1b6de
Component: engine
2016-06-20 11:54:53 +00:00
122239bbc3 remove "RC" warning from Markdown files
A site-wide banner is going to be used, so we don't need this warning

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 37ee14a99894c78396b51b62f5e979f1d000d321
Component: engine
2016-06-20 00:24:37 -07:00
e82e1cb033 update docker swarm cli
Signed-off-by: Charles Smith <charles.smith@docker.com>
Upstream-commit: 78ebfaff1a426425573c440c24eb0f36ffed4d8c
Component: engine
2016-06-17 15:40:43 -07:00
1c57d98347 Add cert-expiry to swarm update
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Upstream-commit: 7d8d51aa9d0c1737ff7f97a3efac0a2ef0975b56
Component: engine
2016-06-16 18:06:02 -07:00
0b871ed824 Make --dispatcher-heartbeat-period a duration
Make `--dispatcher-heartbeat-period` a duration in `docker swarm
update`, allowing to express the value as "5s", "1h", etc.

Signed-off-by: Arnaud Porterie (icecrime) <arnaud.porterie@docker.com>
Upstream-commit: e6e1fd5d0657c3ab5b15c2984403e4a4e62ca2bb
Component: engine
2016-06-14 18:10:49 -07:00
69f307bc8b CLI docs
Signed-off-by: Amit Shukla <amit.shukla@docker.com>
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Upstream-commit: 9acf97b72a4d5ff7b1bcad36fb19b53775f01596
Component: engine
2016-06-13 22:17:15 -07:00