registrator

README

Registrator

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.

Getting Registrator

Get the latest release, master, or any version of Registrator via Docker Hub:

$ docker pull lazylab/registrator:latest

Latest tag always points to the latest release. There is also a :master tag and version tags to pin to specific releases.

Dockerhub

Using Registrator

Consul

$ docker run -d \
    --name=registrator \
    --net=host \
    --volume=/var/run/docker.sock:/tmp/docker.sock \
    lazylab/registrator:latest \
    --debug consul://localhost:8500

Telegram

$ docker run -d \
    --name=registrator \
    --net=host \
    --volume=/var/run/docker.sock:/tmp/docker.sock \
    -e TELEGRAM_BOT_TOKEN={PUT_YOUR_TOKEN_HERE} \
    lazylab/registrator:latest \
    --debug telegram://{PUT_YOUR_CHAT_ID_HERE}

CLI Options

Usage of /bin/registrator:
  /bin/registrator [options] <registry URI>

  -debug=false: Show log message on level debug
  -cleanup=false: Remove dangling services
  -deregister="always": Deregister exited services "always" or "on-success"
  -explicit=false: Only register containers which have SERVICE_NAME label set
  -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

Contributing

Pull requests are welcome! We recommend getting feedback before starting by opening an issue.

License