From 1918ec39879e32e8461e126009d585db5c5f0341 Mon Sep 17 00:00:00 2001 From: Aaron Lehmann Date: Thu, 21 Jul 2016 10:40:19 -0700 Subject: [PATCH] Require listen address and advertise address to be an IP address or an interface name Hostnames are not supported for now because libnetwork can't use them for overlay networking yet. Signed-off-by: Aaron Lehmann --- docs/reference/commandline/swarm_init.md | 8 ++++---- docs/reference/commandline/swarm_join.md | 8 ++++---- man/dockerd.8.md | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/reference/commandline/swarm_init.md b/docs/reference/commandline/swarm_init.md index 8d9687abce..6534cba5de 100644 --- a/docs/reference/commandline/swarm_init.md +++ b/docs/reference/commandline/swarm_init.md @@ -17,13 +17,13 @@ Usage: docker swarm init [OPTIONS] Initialize a swarm Options: - --advertise-addr value Advertised address (format: [:port]) + --advertise-addr value Advertised address (format: [:port]) --cert-expiry duration Validity period for node certificates (default 2160h0m0s) --dispatcher-heartbeat duration Dispatcher heartbeat period (default 5s) --external-ca value Specifications of one or more certificate signing endpoints --force-new-cluster Force create a new cluster from current state. --help Print usage - --listen-addr value Listen address (format: [:port]) + --listen-addr value Listen address (format: [:port]) --task-history-limit int Task history retention limit (default 5) ``` @@ -79,7 +79,7 @@ The node listens for inbound Swarm manager traffic on this address. The default 0.0.0.0:2377. It is also possible to specify a network interface to listen on that interface's address; for example `--listen-addr eth0:2377`. -Specifying a port is optional. If the value is a bare IP address, hostname, or interface +Specifying a port is optional. If the value is a bare IP address or interface name, the default port 2377 will be used. ### `--advertise-addr value` @@ -94,7 +94,7 @@ inter-manager communication and overlay networking. It is also possible to specify a network interface to advertise that interface's address; for example `--advertise-addr eth0:2377`. -Specifying a port is optional. If the value is a bare IP address, hostname, or interface +Specifying a port is optional. If the value is a bare IP address or interface name, the default port 2377 will be used. ### `--task-history-limit` diff --git a/docs/reference/commandline/swarm_join.md b/docs/reference/commandline/swarm_join.md index 42638c09ae..9f5ff1dda8 100644 --- a/docs/reference/commandline/swarm_join.md +++ b/docs/reference/commandline/swarm_join.md @@ -17,9 +17,9 @@ Usage: docker swarm join [OPTIONS] HOST:PORT Join a swarm as a node and/or manager Options: - --advertise-addr value Advertised address (format: [:port]) + --advertise-addr value Advertised address (format: [:port]) --help Print usage - --listen-addr value Listen address + --listen-addr value Listen address (format: [:port) --token string Token for entry into the swarm ``` @@ -64,7 +64,7 @@ If the node is a manager, it will listen for inbound Swarm manager traffic on th address. The default is to listen on 0.0.0.0:2377. It is also possible to specify a network interface to listen on that interface's address; for example `--listen-addr eth0:2377`. -Specifying a port is optional. If the value is a bare IP address, hostname, or interface +Specifying a port is optional. If the value is a bare IP address, or interface name, the default port 2377 will be used. This flag is generally not necessary when joining an existing swarm. @@ -81,7 +81,7 @@ communication and overlay networking. It is also possible to specify a network interface to advertise that interface's address; for example `--advertise-addr eth0:2377`. -Specifying a port is optional. If the value is a bare IP address, hostname, or interface +Specifying a port is optional. If the value is a bare IP address, or interface name, the default port 2377 will be used. This flag is generally not necessary when joining an existing swarm. diff --git a/man/dockerd.8.md b/man/dockerd.8.md index 15e2d9635a..a098a708a3 100644 --- a/man/dockerd.8.md +++ b/man/dockerd.8.md @@ -55,7 +55,7 @@ dockerd - Enable daemon mode [**-s**|**--storage-driver**[=*STORAGE-DRIVER*]] [**--selinux-enabled**] [**--storage-opt**[=*[]*]] -[**--swarm-default-advertise-addr**[=*IP|HOSTNAME|INTERFACE*]] +[**--swarm-default-advertise-addr**[=*IP|INTERFACE*]] [**--tls**] [**--tlscacert**[=*~/.docker/ca.pem*]] [**--tlscert**[=*~/.docker/cert.pem*]] @@ -240,7 +240,7 @@ output otherwise. **--storage-opt**=[] Set storage driver options. See STORAGE DRIVER OPTIONS. -**--swarm-default-advertise-addr**=*IP|HOSTNAME|INTERFACE* +**--swarm-default-advertise-addr**=*IP|INTERFACE* Set default address or interface for swarm to advertise as its externally-reachable address to other cluster members. This can be a hostname, an IP address, or an interface such as `eth0`. A port cannot be specified with this option.