From 44a527d877faf0ef62bc9b0221f656041833ae66 Mon Sep 17 00:00:00 2001
From: Dave Tucker
Date: Tue, 10 Nov 2015 22:03:52 +0000
Subject: [PATCH] Add required ports for Overlay to docs
Fixes #17709
Signed-off-by: Dave Tucker
---
docs/userguide/networking/dockernetworks.md | 18 ++++++++++++++----
1 file changed, 14 insertions(+), 4 deletions(-)
diff --git a/docs/userguide/networking/dockernetworks.md b/docs/userguide/networking/dockernetworks.md
index 54693e67d4..24825ac601 100644
--- a/docs/userguide/networking/dockernetworks.md
+++ b/docs/userguide/networking/dockernetworks.md
@@ -404,16 +404,26 @@ provision the hosts are with Docker Machine.
![Engine on each host](images/engine_on_net.png)
+You should open the following ports between each of your hosts.
+
+| Protocol | Port | Description |
+|----------|------|-----------------------|
+| udp | 4789 | Data plane (VXLAN) |
+| tcp/udp | 7946 | Control plane |
+
+Your key-value store service may require additional ports.
+Check your vendor's documentation and open any required ports.
+
Once you have several machines provisioned, you can use Docker Swarm to quickly
form them into a swarm which includes a discovery service as well.
To create an overlay network, you configure options on the `daemon` on each
Docker Engine for use with `overlay` network. There are two options to set:
-| Option | Description |
-|----------------------------------|-----------------------------------------------------------|
-| `--cluster-store=PROVIDER://URL` | Describes the location of the KV service. |
-| `--cluster-advertise=HOST_IP` | Advertises containers created by the HOST on the network. |
+| Option | Description |
+|-----------------------------------------------|-------------------------------------------------------------|
+| `--cluster-store=PROVIDER://URL` | Describes the location of the KV service. |
+| `--cluster-advertise=HOST_IP|HOST_IFACE:PORT` | The IP address or interface of the HOST used for clustering |
Create an `overlay` network on one of the machines in the Swarm.