2016-06-13 22:57:19 -04:00
|
|
|
<!--[metadata]>
|
|
|
|
+++
|
|
|
|
title = "swarm join"
|
|
|
|
description = "The swarm join command description and usage"
|
|
|
|
keywords = ["swarm, join"]
|
2016-06-20 07:54:53 -04:00
|
|
|
advisory = "rc"
|
2016-06-13 22:57:19 -04:00
|
|
|
[menu.main]
|
|
|
|
parent = "smn_cli"
|
|
|
|
+++
|
|
|
|
<![end-metadata]-->
|
|
|
|
|
|
|
|
# swarm join
|
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
```markdown
|
|
|
|
Usage: docker swarm join [OPTIONS] HOST:PORT
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2016-07-20 14:15:08 -04:00
|
|
|
Join a swarm as a node and/or manager
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Options:
|
|
|
|
--help Print usage
|
|
|
|
--listen-addr value Listen address (default 0.0.0.0:2377)
|
2016-07-20 14:15:08 -04:00
|
|
|
--token string Token for entry into the swarm
|
2016-07-07 14:43:18 -04:00
|
|
|
```
|
2016-06-13 22:57:19 -04:00
|
|
|
|
2016-07-20 14:15:08 -04:00
|
|
|
Join a node to a swarm. The node joins as a manager node or worker node based upon the token you
|
|
|
|
pass with the `--token` flag. If you pass a manager token, the node joins as a manager. If you
|
|
|
|
pass a worker token, the node joins as a worker.
|
2016-06-13 22:57:19 -04:00
|
|
|
|
|
|
|
### Join a node to swarm as a manager
|
|
|
|
|
2016-07-20 14:15:08 -04:00
|
|
|
The example below demonstrates joining a manager node using a manager token.
|
|
|
|
|
2016-06-13 22:57:19 -04:00
|
|
|
```bash
|
2016-07-20 14:15:08 -04:00
|
|
|
$ docker swarm join --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2 --listen-addr 192.168.99.122:2377 192.168.99.121:2377
|
|
|
|
This node joined a swarm as a manager.
|
2016-06-13 22:57:19 -04:00
|
|
|
$ docker node ls
|
2016-07-20 14:15:08 -04:00
|
|
|
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
|
|
|
|
dkp8vy1dq1kxleu9g4u78tlag * manager2 Ready Active Reachable
|
|
|
|
dvfxp4zseq4s0rih1selh0d20 manager1 Ready Active Leader
|
2016-06-13 22:57:19 -04:00
|
|
|
```
|
|
|
|
|
2016-07-20 14:15:08 -04:00
|
|
|
A cluster should only have 3-7 managers at most, because a majority of managers must be available
|
|
|
|
for the cluster to function. Nodes that aren't meant to participate in this management quorum
|
|
|
|
should join as workers instead. Managers should be stable hosts that have static IP addresses.
|
|
|
|
|
2016-06-13 22:57:19 -04:00
|
|
|
### Join a node to swarm as a worker
|
|
|
|
|
2016-07-20 14:15:08 -04:00
|
|
|
The example below demonstrates joining a worker node using a worker token.
|
|
|
|
|
2016-06-13 22:57:19 -04:00
|
|
|
```bash
|
2016-07-20 14:15:08 -04:00
|
|
|
$ docker swarm join --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx --listen-addr 192.168.99.123:2377 192.168.99.121:2377
|
|
|
|
This node joined a swarm as a worker.
|
2016-06-13 22:57:19 -04:00
|
|
|
$ docker node ls
|
2016-07-20 14:15:08 -04:00
|
|
|
ID HOSTNAME STATUS AVAILABILITY MANAGER STATUS
|
|
|
|
7ln70fl22uw2dvjn2ft53m3q5 worker2 Ready Active
|
|
|
|
dkp8vy1dq1kxleu9g4u78tlag worker1 Ready Active Reachable
|
|
|
|
dvfxp4zseq4s0rih1selh0d20 * manager1 Ready Active Leader
|
2016-06-13 22:57:19 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
### `--listen-addr value`
|
|
|
|
|
2016-07-20 14:15:08 -04:00
|
|
|
The node listens for inbound swarm manager traffic on this IP:PORT
|
2016-07-07 14:43:18 -04:00
|
|
|
|
2016-07-20 14:15:08 -04:00
|
|
|
### `--token string`
|
2016-06-13 22:57:19 -04:00
|
|
|
|
|
|
|
Secret value required for nodes to join the swarm
|
|
|
|
|
|
|
|
|
|
|
|
## Related information
|
|
|
|
|
|
|
|
* [swarm init](swarm_init.md)
|
|
|
|
* [swarm leave](swarm_leave.md)
|
|
|
|
* [swarm update](swarm_update.md)
|