0ct0pu5/moby
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
moby/docs/reference/api
History
Aaron Lehmann a0ccd0d42f Split advertised address from listen address 
There are currently problems with "swarm init" and "swarm join" when an
explicit --listen-addr flag is not provided. swarmkit defaults to
finding the IP address associated with the default route, and in cloud
setups this is often the wrong choice.

Introduce a notion of "advertised address", with the client flag
--advertise-addr, and the daemon flag --swarm-default-advertise-addr to
provide a default. The default listening address is now 0.0.0.0, but a
valid advertised address must be detected or specified.

If no explicit advertised address is specified, error out if there is
more than one usable candidate IP address on the system. This requires a
user to explicitly choose instead of letting swarmkit make the wrong
choice. For the purposes of this autodetection, we ignore certain
interfaces that are unlikely to be relevant (currently docker*).

The user is also required to choose a listen address on swarm init if
they specify an explicit advertise address that is a hostname or an IP
address that's not local to the system. This is a requirement for
overlay networking.

Also support specifying interface names to --listen-addr,
--advertise-addr, and the daemon flag --swarm-default-advertise-addr.
This will fail if the interface has multiple IP addresses (unless it has
a single IPv4 address and a single IPv6 address - then we resolve the
tie in favor of IPv4).

This change also exposes the node's externally-reachable address in
docker info, as requested by #24017.

Make corresponding API and CLI docs changes.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-07-24 09:23:07 -07:00
..
_static retooling for hugo 2015-06-15 13:19:38 -07:00
images Implemet docker update command 2015-12-28 19:19:26 +08:00
docker-io_api.md Creating Engine specific menu 2016-01-26 15:58:53 -08:00
docker_io_accounts_api.md Creating Engine specific menu 2016-01-26 15:58:53 -08:00
docker_remote_api.md Clarify API behavior when older versions are called. 2016-07-21 16:16:46 +08:00
docker_remote_api_v1.18.md Fix link errors in 'docs/reference/api/docker_remote_api_v***.md' 2016-07-19 02:53:03 +08:00
docker_remote_api_v1.19.md Fix link errors in 'docs/reference/api/docker_remote_api_v***.md' 2016-07-19 02:53:03 +08:00
docker_remote_api_v1.20.md Fix link errors in 'docs/reference/api/docker_remote_api_v***.md' 2016-07-19 02:53:03 +08:00
docker_remote_api_v1.21.md Fix link errors in 'docs/reference/api/docker_remote_api_v***.md' 2016-07-19 02:53:03 +08:00
docker_remote_api_v1.22.md Fix link errors in 'docs/reference/api/docker_remote_api_v***.md' 2016-07-19 02:53:03 +08:00
docker_remote_api_v1.23.md Fix link errors in 'docs/reference/api/docker_remote_api_v***.md' 2016-07-19 02:53:03 +08:00
docker_remote_api_v1.24.md Split advertised address from listen address 2016-07-24 09:23:07 -07:00
docker_remote_api_v1.25.md Split advertised address from listen address 2016-07-24 09:23:07 -07:00
hub_registry_spec.md Creating Engine specific menu 2016-01-26 15:58:53 -08:00
index.md Creating Engine specific menu 2016-01-26 15:58:53 -08:00
README.md Fixes found by docs validation tool 2015-11-23 11:19:38 +10:00
remote_api_client_libraries.md Remove status column from client libraries page 2016-05-31 16:12:14 -07:00

README.md

This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:

  • The remote API by which a docker node can be queried over HTTP
  • The registry API by which a docker node can download and upload images for storage and sharing
  • The index search API by which a docker node can search the public index for images to download
  • The docker.io OAuth and accounts API which 3rd party services can use to access account information