Commit Graph

26 Commits

Author SHA1 Message Date
c16c5f3db8 Fix repo references in docs
Since CLI was moved to a separate repo, these references are incorrect.
Fixed with the help of sed script, verified manually.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
Upstream-commit: 6d85a4f5f8
Component: cli
2017-07-28 10:32:42 -07:00
eee5a1ca7f Document the swarm root CA rotation CLI command.
Signed-off-by: Ying Li <ying.li@docker.com>
Upstream-commit: e1cd83f28a
Component: cli
2017-06-02 00:11:05 +00:00
020523b38b 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: ddadd3db49
Component: cli
2017-06-02 00:10:53 +00:00
34f384e6dd Add the link for swarm reference document
Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
Upstream-commit: 9d27f13dd8
Component: cli
2017-06-02 00:10:46 +00:00
09cfe3454c docs: fix description of docker swarm update --help
Signed-off-by: Kei Ohmura <ohmura.kei@gmail.com>
Upstream-commit: 967a6bf70d
Component: cli
2017-06-02 00:10:44 +00:00
547c076109 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: 0e93a16289
Component: cli
2017-06-02 00:10:37 +00:00
1ce351cb56 Document autolock/unlock/unlock-key
Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
Upstream-commit: d9b0fa75c1
Component: cli
2017-06-02 00:10:36 +00:00
f57706bf47 Fixes #24083 : Improving cli help for flags with duration option
Signed-off-by: milindchawre <milindchawre@gmail.com>
Upstream-commit: 7d90a06417
Component: cli
2017-06-02 00:10:35 +00:00
3cfa043d6e 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: 49b6be893c
Component: cli
2017-06-02 00:10:34 +00:00
35146fe359 fix frontmatter keywords value type (string, instead of []string) in /docs/reference
Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
Upstream-commit: 572c6bb89a
Component: cli
2017-06-02 00:10:31 +00:00
118bce70c4 Sync docker/docker refs with files mistakenly edited in docker.github.io repo
Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: 7f36c3a1a0
Component: cli
2017-06-02 00:10:26 +00:00
fbc93c2df5 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: 2845676cc2
Component: cli
2017-06-02 00:10:24 +00:00
75a2b43b32 fix typo, change sample cert expiry value
Signed-off-by: Charles Smith <charles.smith@docker.com>
Upstream-commit: 86315be2f0
Component: cli
2017-06-02 00:10:04 +00:00
cfa2b10762 Update usage of "Swarm" for consistency
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: ddc2f8b05a
Component: cli
2017-06-02 00:10:03 +00:00
e48cec13d7 Remove release-candidate advisories
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Upstream-commit: 00a430d255
Component: cli
2017-06-02 00:10:03 +00:00
bbb2a8ceeb Update swarm init task-history-limit docs
Signed-off-by: Vincent Demeester <vincent@sbr.pm>
Upstream-commit: 871366c8b4
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
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
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
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
50e82af126 update docker swarm cli
Signed-off-by: Charles Smith <charles.smith@docker.com>
Upstream-commit: 87591ae9b7
Component: cli
2017-06-02 00:07:45 +00:00
5357e9b84b Add the advisory=rc metadata
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Upstream-commit: b6bfe363f8
Component: cli
2017-06-02 00:07:45 +00:00
16d2ae21bb 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: 7b22dbd02a
Component: cli
2017-06-02 00:07:45 +00:00
51b169e361 Add cert-expiry to swarm update
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Upstream-commit: 308888a8c6
Component: cli
2017-06-02 00:07:44 +00:00
8ba9627310 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: 96150d3faa
Component: cli
2017-06-02 00:07:44 +00:00
15cc239caf CLI docs
Signed-off-by: Amit Shukla <amit.shukla@docker.com>
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
Upstream-commit: 593ee1e29d
Component: cli
2017-06-02 00:07:43 +00:00