Service registry bridge for Docker.
Registrator automatically registers and deregisters services for any Docker container by inspecting containers as they come online. Registrator supports pluggable service registries, which currently includes Consul, etcd and SkyDNS 2.
Full documentation available at http://gliderlabs.com/registrator
Get the latest release, master, or any version of Registrator via Docker Hub:
$ docker pull temskiy/registrator:latest
Latest tag always points to the latest release. There is also a :master tag
and version tags to pin to specific releases.
The quickest way to see Registrator in action is our Quickstart tutorial. Otherwise, jump to the Run Reference in the User Guide. Typically, running Registrator looks like this:
$ docker run -d \
--name=registrator \
--net=host \
--volume=/var/run/docker.sock:/tmp/docker.sock \
temskiy/registrator:latest -mode services\
consul://localhost:8500
Usage of /bin/registrator:
/bin/registrator [options] <registry URI>
-cleanup=false: Remove dangling services
-deregister="always": Deregister exited services "always" or "on-success"
-internal=false: Use internal ports instead of published ones
-ip="": IP for ports mapped to the host
-resync=0: Frequency with which services are resynchronized
-retry-attempts=0: Max retry attempts to establish a connection with the backend. Use -1 for infinite retries
-retry-interval=2000: Interval (in millisecond) between retry-attempts.
-tags="": Append tags for all registered services
-ttl=0: TTL for services (default is no expiry)
-ttl-refresh=0: Frequency with which service TTLs are refreshed
-mode=containers: Commonly, containers started as part of swarm services connected to ingress network not registered, because have not published port at host. With "-mode services" thats containers will be registered with name = name of service, IP = node IP and published port(s) = published port(s) of service
Pull requests are welcome! We recommend getting feedback before starting by opening a GitHub issue or discussing in Slack.
Also check out our Developer Guide on Contributing Backends and Staging Releases.
Big thanks to Weave for sponsoring, Michael Crosby for skydock, and the Consul mailing list for inspiration.
For a full list of sponsors, see SPONSORS.
MIT