Browse code

Add required ports for Overlay to docs

Fixes #17709

Signed-off-by: Dave Tucker <dt@docker.com>
(cherry picked from commit 44a527d877faf0ef62bc9b0221f656041833ae66)

Dave Tucker authored on 2015/11/11 07:03:52
Showing 1 changed files
... ...
@@ -404,16 +404,26 @@ provision the hosts are with Docker Machine.
404 404
 
405 405
 ![Engine on each host](images/engine_on_net.png)
406 406
 
407
+You should open the following ports between each of your hosts.
408
+
409
+| Protocol | Port | Description           |
410
+|----------|------|-----------------------|
411
+| udp      | 4789 | Data plane (VXLAN)    |
412
+| tcp/udp  | 7946 | Control plane         |
413
+
414
+Your key-value store service may require additional ports. 
415
+Check your vendor's documentation and open any required ports.
416
+
407 417
 Once you have several machines provisioned, you can use Docker Swarm to quickly
408 418
 form them into a swarm which includes a discovery service as well.
409 419
 
410 420
 To create an overlay network, you configure options on  the `daemon` on each
411 421
 Docker Engine for use with `overlay` network. There are two options to set:
412 422
 
413
-| Option                           | Description                                               |
414
-|----------------------------------|-----------------------------------------------------------|
415
-| `--cluster-store=PROVIDER://URL` | Describes the location of the KV service.               |
416
-| `--cluster-advertise=HOST_IP`    | Advertises containers created by the HOST on the network. |
423
+| Option                                        | Description                                                 |
424
+|-----------------------------------------------|-------------------------------------------------------------|
425
+| `--cluster-store=PROVIDER://URL`              | Describes the location of the KV service.                   |
426
+| `--cluster-advertise=HOST_IP|HOST_IFACE:PORT` | The IP address or interface of the HOST used for clustering |
417 427
 
418 428
 Create an `overlay` network on one of the machines in the Swarm.
419 429