summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/swarm_join.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/commandline/swarm_join.md')
-rw-r--r--docs/reference/commandline/swarm_join.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/reference/commandline/swarm_join.md b/docs/reference/commandline/swarm_join.md
index 0cde0d7bcd..d0b6685c45 100644
--- a/docs/reference/commandline/swarm_join.md
+++ b/docs/reference/commandline/swarm_join.md
@@ -27,10 +27,14 @@ Options:
--token string Token for entry into the swarm
```
+## Description
+
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.
+## Examples
+
### Join a node to swarm as a manager
The example below demonstrates joining a manager node using a manager token.
@@ -95,7 +99,7 @@ This flag is generally not necessary when joining an existing swarm.
Secret value required for nodes to join the swarm
-## Related information
+## Related commands
* [swarm init](swarm_init.md)
* [swarm leave](swarm_leave.md)