Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/swarm_update.md

46 lines
1.8 KiB
Markdown
Raw Normal View History

CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
# swarm update
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
<!---MARKER_GEN_START-->
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-20 14:15:08 -04:00
Update the swarm
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>
2016-07-07 14:43:18 -04:00
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
### Options
| Name | Type | Default | Description |
|:-------------------------|:--------------|:------------|:------------------------------------------------------------|
chore: regenerate docs Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-07-03 02:29:57 -04:00
| `--autolock` | `bool` | | Change manager autolocking setting (true\|false) |
docs: generate markdown Keep frontmatter for docker, dockerd and index markdown files. Also needs to move cli.md > docker.md before generation and then move it back because cli.md is needed for yaml generation on docs website: https://github.com/docker/cli/pull/3924#discussion_r1059986605 Signed-off-by: Kevin Alvarez <crazy-max@users.noreply.github.com> Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2023-01-06 13:04:05 -05:00
| `--cert-expiry` | `duration` | `2160h0m0s` | Validity period for node certificates (ns\|us\|ms\|s\|m\|h) |
| `--dispatcher-heartbeat` | `duration` | `5s` | Dispatcher heartbeat period (ns\|us\|ms\|s\|m\|h) |
| `--external-ca` | `external-ca` | | Specifications of one or more certificate signing endpoints |
| `--max-snapshots` | `uint64` | `0` | Number of additional Raft snapshots to retain |
| `--snapshot-interval` | `uint64` | `10000` | Number of log entries between Raft snapshots |
| `--task-history-limit` | `int64` | `5` | Task history retention limit |
<!---MARKER_GEN_END-->
CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
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>
2017-02-07 18:42:48 -05:00
## Description
Docs: add note about management commands targeting a manager Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2018-12-23 06:27:52 -05:00
Updates a swarm with new parameter values.
docs: use gh alert syntax for callouts Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-16 05:02:10 -04:00
> [!NOTE]
reference docs: reformat notes Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 11:08:37 -04:00
> This is a cluster management command, and must be executed on a swarm
> manager node. To learn about managers and workers, refer to the
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
> documentation.
CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
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>
2017-02-07 18:42:48 -05:00
## Examples
CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
fix typo, change sample cert expiry value Signed-off-by: Charles Smith <charles.smith@docker.com>
2016-08-05 19:51:07 -04:00
$ docker swarm update --cert-expiry 720h
CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
```
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>
2017-02-07 18:42:48 -05:00
## Related commands
CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
Document the swarm root CA rotation CLI command. Signed-off-by: Ying Li <ying.li@docker.com>
2017-05-10 18:34:56 -04:00
* [swarm ca](swarm_ca.md)
CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
* [swarm init](swarm_init.md)
* [swarm join](swarm_join.md)
reference docs: fix broken links and markdown touch-ups - fix various broken links - fix incorrect anchors - updated links for content that moved, so that no redirect to the new location is needed. - touched-up Markdown; - re-format some JSON output - add blank line betweeen command and command output - format "note" blocks Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 09:43:08 -04:00
* [swarm join-token](swarm_join-token.md)
CLI docs Signed-off-by: Amit Shukla <amit.shukla@docker.com> Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2016-06-13 22:57:19 -04:00
* [swarm leave](swarm_leave.md)
Add the link for swarm reference document Signed-off-by: yuexiao-wang <wang.yuexiao@zte.com.cn>
2016-12-19 12:55:51 -05:00
* [swarm unlock](swarm_unlock.md)
reference docs: fix broken links and markdown touch-ups - fix various broken links - fix incorrect anchors - updated links for content that moved, so that no redirect to the new location is needed. - touched-up Markdown; - re-format some JSON output - add blank line betweeen command and command output - format "note" blocks Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-04-19 09:43:08 -04:00
* [swarm unlock-key](swarm_unlock-key.md)