summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/swarm_init.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/commandline/swarm_init.md')
-rw-r--r--docs/reference/commandline/swarm_init.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/reference/commandline/swarm_init.md b/docs/reference/commandline/swarm_init.md
index 44afc27476..8cba118ff2 100644
--- a/docs/reference/commandline/swarm_init.md
+++ b/docs/reference/commandline/swarm_init.md
@@ -34,9 +34,12 @@ Options:
--task-history-limit int Task history retention limit (default 5)
```
+## Description
+
Initialize a swarm. The docker engine targeted by this command becomes a manager
in the newly created single-node swarm.
+## Examples
```bash
$ docker swarm init --advertise-addr 192.168.99.121
@@ -133,7 +136,7 @@ Snapshots compact the Raft log and allow for more efficient transfer of the
state to new managers. However, there is a performance cost to taking snapshots
frequently.
-## Related information
+## Related commands
* [swarm join](swarm_join.md)
* [swarm leave](swarm_leave.md)