docker swarm join-token
Estimated reading time: 4 minutes
Manage join tokens
Swarm This command works with the Swarm orchestrator.
$ docker swarm join-token [OPTIONS] (worker|manager)
Join tokens are secrets that allow a node to join the swarm. There are two
different join tokens available, one for the worker role and one for the manager
role. You pass the token using the
--token flag when you run
swarm join. Nodes use the join token only when they join the
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 in the documentation.
For example uses of this command, refer to the examples section below.
||Only display token|
||Rotate join token|
You can view or rotate the join tokens using
As a convenience, you can pass
manager as an argument to
join-token to print the full
docker swarm join command to join a new node to
$ docker swarm join-token worker To add a worker to this swarm, run the following command: docker swarm join \ --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-1awxwuwd3z9j1z3puu7rcgdbx \ 172.17.0.2:2377 $ docker swarm join-token manager To add a manager to this swarm, run the following command: docker swarm join \ --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-7p73s1dx5in4tatdymyhg9hu2 \ 172.17.0.2:2377
--rotate flag to generate a new join token for the specified role:
$ docker swarm join-token --rotate worker Successfully rotated worker join token. To add a worker to this swarm, run the following command: docker swarm join \ --token SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t \ 172.17.0.2:2377
--rotate, only the new token will be valid for joining with the specified role.
--quiet) flag only prints the token:
$ docker swarm join-token -q worker SWMTKN-1-3pu6hszjas19xyp7ghgosyx9k8atbfcr8p2is99znpy26u2lkl-b30ljddcqhef9b9v4rs7mel7t
Because tokens allow new nodes to join the swarm, you should keep them secret. Be particularly careful with manager tokens since they allow new manager nodes to join the swarm. A rogue manager has the potential to disrupt the operation of your swarm.
Rotate your swarm’s join token if a token gets checked-in to version control, stolen, or a node is compromised. You may also want to periodically rotate the token to ensure any unknown token leaks do not allow a rogue node to join the swarm.
To rotate the join token and print the newly generated token, run
docker swarm join-token --rotate and pass the role:
Rotating a join-token means that no new nodes will be able to join the swarm using the old token. Rotation does not affect existing nodes in the swarm because the join token is only used for authorizing new nodes joining the swarm.
Only print the token. Do not print a complete command for joining.
|docker swarm||Manage Swarm|
|docker swarm ca||Display and rotate the root CA|
|docker swarm init||Initialize a swarm|
|docker swarm join||Join a swarm as a node and/or manager|
|docker swarm join-token||Manage join tokens|
|docker swarm leave||Leave the swarm|
|docker swarm unlock||Unlock swarm|
|docker swarm unlock-key||Manage the unlock key|
|docker swarm update||Update the swarm|