summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/swarm_join_token.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/commandline/swarm_join_token.md')
-rw-r--r--docs/reference/commandline/swarm_join_token.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/reference/commandline/swarm_join_token.md b/docs/reference/commandline/swarm_join_token.md
index d731f028ba..60f5622072 100644
--- a/docs/reference/commandline/swarm_join_token.md
+++ b/docs/reference/commandline/swarm_join_token.md
@@ -26,12 +26,16 @@ Options:
--rotate Rotate join token
```
+## Description
+
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](swarm_join.md). Nodes use the join token only when they join the
swarm.
+## Examples
+
You can view or rotate the join tokens using `swarm join-token`.
As a convenience, you can pass `worker` or `manager` as an argument to
@@ -100,6 +104,6 @@ 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.
-## Related information
+## Related commands
* [swarm join](swarm_join.md)