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
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
---
|
|
title: "swarm update"
|
|
description: "The swarm update command description and usage"
|
|
keywords: "swarm, update"
|
|
---
|
|
|
|
<!-- This file is maintained within the docker/docker Github
|
|
repository at https://github.com/docker/docker/. Make all
|
|
pull requests against that repo. If you see this file in
|
|
another repository, consider it read-only there, as it will
|
|
periodically be overwritten by the definitive file. Pull
|
|
requests which include edits to this file in other repositories
|
|
will be rejected.
|
|
-->
|
|
|
|
# swarm update
|
|
|
|
```markdown
|
|
Usage: docker swarm update [OPTIONS]
|
|
|
|
Update the swarm
|
|
|
|
Options:
|
|
--cert-expiry duration Validity period for node certificates (default 2160h0m0s)
|
|
--dispatcher-heartbeat duration Dispatcher heartbeat period (default 5s)
|
|
--external-ca value Specifications of one or more certificate signing endpoints
|
|
--help Print usage
|
|
--max-snapshots int Number of additional Raft snapshots to retain
|
|
--snapshot-interval int Number of log entries between Raft snapshots
|
|
--task-history-limit int Task history retention limit (default 5)
|
|
```
|
|
|
|
Updates a swarm with new parameter values. This command must target a manager node.
|
|
|
|
|
|
```bash
|
|
$ docker swarm update --cert-expiry 720h
|
|
```
|
|
|
|
## Related information
|
|
|
|
* [swarm init](swarm_init.md)
|
|
* [swarm join](swarm_join.md)
|
|
* [swarm leave](swarm_leave.md)
|