Merge pull request #673 from londoncalling/swarm-heartbeat-option

clarify syntax on swarm heartbeat for create machine command
This commit is contained in:
Victoria Bialas 2016-11-21 12:12:20 -08:00 committed by GitHub
commit 94412b7a84
1 changed files with 3 additions and 4 deletions

View File

@ -207,8 +207,7 @@ you can use Machine to specify how the created Swarm master should be
configured. There is a `--swarm-strategy` flag, which you can use to specify configured. There is a `--swarm-strategy` flag, which you can use to specify
the [scheduling strategy](/swarm/scheduler/strategy.md) the [scheduling strategy](/swarm/scheduler/strategy.md)
which Docker Swarm should use (Machine defaults to the `spread` strategy). which Docker Swarm should use (Machine defaults to the `spread` strategy).
There is also a general purpose `--swarm-opt` option which works similar to how There is also a general purpose `--swarm-opt` option which works similar to the aforementioned `--engine-opt` option, except that it specifies options
the aforementioned `--engine-opt` option does, except that it specifies options
for the `swarm manage` command (used to boot a master node) instead of the base for the `swarm manage` command (used to boot a master node) instead of the base
command. You can use this to configure features that power users might be command. You can use this to configure features that power users might be
interested in, such as configuring the heartbeat interval or Swarm's willingness interested in, such as configuring the heartbeat interval or Swarm's willingness
@ -228,7 +227,7 @@ $ docker-machine create -d virtualbox \
--swarm-master \ --swarm-master \
--swarm-discovery token://<token> \ --swarm-discovery token://<token> \
--swarm-strategy binpack \ --swarm-strategy binpack \
--swarm-opt heartbeat=5 \ --swarm-opt heartbeat=5s \
upbeat upbeat
``` ```
@ -246,4 +245,4 @@ check" which is specified at the driver level.
If this pre-create check succeeds, Docker Machine will proceed with the creation If this pre-create check succeeds, Docker Machine will proceed with the creation
as normal. If the pre-create check fails, the Docker Machine process will exit as normal. If the pre-create check fails, the Docker Machine process will exit
with status code 3 to indicate that the source of the non-zero exit was the with status code 3 to indicate that the source of the non-zero exit was the
pre-create check failing. pre-create check failing.