[{"_1":2,"_153":-5,"_154":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_132":133},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_123":-5,"_124":11,"_125":17,"_126":11,"_127":-5,"_128":11,"_129":-5,"_130":131},"canonicalUrl","https://hub.docker.com/r/sheldonh/registrator/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","sheldonh","reponame","registrator","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":-5,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2014-09-29T14:40:01.823626Z","description","","is_private","last_updated","2015-11-13T23:18:29.759668Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.distribution.manifest.v1+prettyjws","name","pull_count",347,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Registrator\n\nService registry bridge for Docker\n\nRegistrator automatically register/deregisters services for Docker containers based on published ports and metadata from the container environment. Registrator supports [pluggable service registries](#adding-support-for-other-service-registries), which currently includes [Consul](http://www.consul.io/), [etcd](https://github.com/coreos/etcd) and [SkyDNS 2](https://github.com/skynetservices/skydns/).\n\nBy default, it can register services without any user-defined metadata. This means it works with *any* container, but allows the container author or Docker operator to override/customize the service definitions.\n\n## Starting Registrator\n\nRegistrator assumes the default Docker socket at `file:///var/run/docker.sock` or you can override it with `DOCKER_HOST`. The only mandatory argument is a registry URI, which specifies and configures the registry backend to use.\n\n\t$ registrator \n\nBy default, when registering a service, registrator will assign the service address by attempting to resolve the current hostname. If you would like to force the service address to be a specific address, you can specify the `-ip` argument.\n\nThe consul backend does not support automatic expiry of stale registrations after some TTL. Instead, TTL checks must be configured (see below). For backends that do support TTL expiry, registrator can be started with the `-ttl` and `-ttl-refresh` arguments (both disabled by default).\n\nRegistrator was designed to just be run as a container. You must pass the Docker socket file as a mount to `/tmp/docker.sock`, and it's a good idea to set the hostname to the machine host:\n\n\t$ docker run -d \\\n\t\t-v /var/run/docker.sock:/tmp/docker.sock \\\n\t\t-h $HOSTNAME progrium/registrator \n\n### Registry URIs\n\nThe registry backend to use is defined by a URI. The scheme is the supported registry name, and an address. Registries based on key-value stores like etcd and Zookeeper (not yet supported) can specify a key path to use to prefix service definitions. Registries may also use query params for other options. See also [Adding support for other service registries](#adding-support-for-other-service-registries).\n\n#### Consul Service Catalog (recommended)\n\nTo use the Consul service catalog, specify a Consul URI without a path. If no host is provided, `127.0.0.1:8500` is used. Examples:\n\n\t$ registrator consul://10.0.0.1:8500\n\t$ registrator consul:\n\nThis backend comes with support for specifying service health checks. See [backend specific features](#backend-specific-features).\n\n#### Consul Key-value Store\n\nThe Consul backend also lets you just use the key-value store. This mode is enabled by specifying a path. Consul key-value support does not currently use service attributes/tags. Example URIs:\n\n\t$ registrator consul:///path/to/services\n\t$ registrator consul://192.168.1.100/services\n\nService definitions are stored as:\n\n\t// = :\n\n#### Etcd Key-value Store\n\nEtcd support works similar to Consul key-value. It also currently doesn't support service attributes/tags. If no host is provided, `127.0.0.1:4001` is used. Example URIs:\n\n\t$ registrator etcd:///path/to/services\n\t$ registrator etcd://192.168.1.100/services\n\nService definitions are stored as:\n\n\t// = :\n\n#### SkyDNS 2 backend\n\nSkyDNS 2 support uses an etcd key-value store, writing service definitions in a format compatible with SkyDNS 2. The URI provides an etcd host and a DNS domain name. If no host is provided, `127.0.0.1:4001` is used. The DNS domain name may not be omitted. Example URIs:\n\n\t$ registrator skydns2:///skydns.local\n\t$ registrator skydns2://192.168.1.100/staging.skydns.local\n\nUsing the second example, a service definition for a container with `service-name` \"redis\" and `service-id` \"redis-1\" would be stored in the etcd service at 192.168.1.100:4001 as follows:\n\n\t/skydns/local/skydns/staging// = {\"host\":\"\",\"port\":}\n\nNote that the default `service-id` includes more than the container name (see below). For legal per-container DNS hostnames, specify the `SERVICE_ID` in the environment of the container, e.g.:\n\n\tdocker run -d --name redis-1 -e SERVICE_ID=redis-1 -p 6379:6379 redis\n\n## How it works\n\nServices are registered and deregistered based on container start and die events from Docker. The service definitions are created with information from the container, including user-defined metadata in the container environment.\n\nFor each published port of a container, a `Service` object is created and passed to the `ServiceRegistry` to register. A `Service` object looks like this with defaults explained in the comments:\n\n\ttype Service struct {\n\t\tID string // ::[:udp if udp]\n\t\tName string // [- if >1 published ports]\n\t\tPort int // \n\t\tIP string // || if 0.0.0.0\n\t\tTags []string // empty, or includes 'udp' if udp\n\t\tAttrs map[string]string // any remaining service metadata from environment\n\t}\n\nMost of these (except `IP` and `Port`) can be overridden by container environment metadata variables prefixed with `SERVICE_` or `SERVICE__`. You use a port in the key name to refer to a particular port's service. Metadata variables without a port in the name are used as the default for all services or can be used to conveniently refer to the single exposed service. \n\nAdditional supported metadata in the same format `SERVICE_`.\nIGNORE: Any value for ignore tells registrator to ignore this entire container and all associated ports.\n\nSince metadata is stored as environment variables, the container author can include their own metadata defined in the Dockerfile. The operator will still be able to override these author-defined defaults.\n\n### Single service with defaults\n\n\t$ docker run -d --name redis.0 -p 10000:6379 dockerfile/redis\n\nResults in `Service`:\n\n\t{\n\t\t\"ID\": \"hostname:redis.0:6379\",\n\t\t\"Name\": \"redis\",\n\t\t\"Port\": 10000,\n\t\t\"IP\": \"192.168.1.102\",\n\t\t\"Tags\": [],\n\t\t\"Attrs\": {}\n\t}\n\n### Single service with metadata\n\n\t$ docker run -d --name redis.0 -p 10000:6379 \\\n\t\t-e \"SERVICE_NAME=db\" \\\n\t\t-e \"SERVICE_TAGS=master,backups\" \\\n\t\t-e \"SERVICE_REGION=us2\" dockerfile/redis\n\nResults in `Service`:\n\n\t{\n\t\t\"ID\": \"hostname:redis.0:6379\",\n\t\t\"Name\": \"db\",\n\t\t\"Port\": 10000,\n\t\t\"IP\": \"192.168.1.102\",\n\t\t\"Tags\": [\"master\", \"backups\"],\n\t\t\"Attrs\": {\"region\": \"us2\"}\n\t}\n\nKeep in mind not all of the `Service` object may be used by the registry backend. For example, currently none of them support registering arbitrary attributes. This field is there for future use. \n\n### Multiple services with defaults\n\n\t$ docker run -d --name nginx.0 -p 4443:443 -p 8000:80 progrium/nginx\n\nResults in two `Service` objects:\n\n\t[\n\t\t{\n\t\t\t\"ID\": \"hostname:nginx.0:443\",\n\t\t\t\"Name\": \"nginx-443\",\n\t\t\t\"Port\": 4443,\n\t\t\t\"IP\": \"192.168.1.102\",\n\t\t\t\"Tags\": [],\n\t\t\t\"Attrs\": {},\n\t\t},\n\t\t{\n\t\t\t\"ID\": \"hostname:nginx.0:80\",\n\t\t\t\"Name\": \"nginx-80\",\n\t\t\t\"Port\": 8000,\n\t\t\t\"IP\": \"192.168.1.102\",\n\t\t\t\"Tags\": [],\n\t\t\t\"Attrs\": {}\n\t\t}\n\t]\n\n### Multiple services with metadata\n\n\t$ docker run -d --name nginx.0 -p 4443:443 -p 8000:80 \\\n\t\t-e \"SERVICE_443_NAME=https\" \\\n\t\t-e \"SERVICE_443_ID=https.12345\" \\\n\t\t-e \"SERVICE_443_SNI=enabled\" \\\n\t\t-e \"SERVICE_80_NAME=http\" \\\n\t\t-e \"SERVICE_TAGS=www\" progrium/nginx\n\nResults in two `Service` objects:\n\n\t[\n\t\t{\n\t\t\t\"ID\": \"https.12345\",\n\t\t\t\"Name\": \"https\",\n\t\t\t\"Port\": 4443,\n\t\t\t\"IP\": \"192.168.1.102\",\n\t\t\t\"Tags\": [\"www\"],\n\t\t\t\"Attrs\": {\"sni\": \"enabled\"},\n\t\t},\n\t\t{\n\t\t\t\"ID\": \"hostname:nginx.0:80\",\n\t\t\t\"Name\": \"http\",\n\t\t\t\"Port\": 8000,\n\t\t\t\"IP\": \"192.168.1.102\",\n\t\t\t\"Tags\": [\"www\"],\n\t\t\t\"Attrs\": {}\n\t\t}\n\t]\n\n## Adding support for other service registries\n\nAs you can see by either the Consul or etcd source files, writing a new registry backend is easy. Just follow the example set by those two. It boils down to writing an object that implements this interface:\n\n\ttype ServiceRegistry interface {\n\t\tRegister(service *Service) error\n\t\tDeregister(service *Service) error\n\t}\n\nThen add your constructor (for example `NewZookeeperRegistry`) to the factory function `NewServiceRegistry` in `registrator.go`.\n\n## Backend specific features\n\n### Consul Health Checks\n\nWhen using the Consul's service catalog backend, you can specify a health check associated with a service. Registrator can pull this from your container environment data if provided. Here are some examples:\n\n#### Basic HTTP health check\n\nThis feature is only available when using the `check-http` script that comes with the [progrium/consul](https://github.com/progrium/docker-consul#health-checking-with-docker) container for Consul.\n\n\tSERVICE_80_CHECK_HTTP=/health/endpoint/path\n\tSERVICE_80_CHECK_INTERVAL=15s\n\nIt works for an HTTP service on any port, not just 80. If its the only service, you can also use `SERVICE_CHECK_HTTP`. \n\n#### Run a health check script in the service container\n\nThis feature is only available when using the `check-cmd` script that comes with the [progrium/consul](https://github.com/progrium/docker-consul#health-checking-with-docker) container for Consul.\n\n\tSERVICE_9000_CHECK_CMD=/path/to/check/script\n\nThis runs the command using this service's container image as a separate container attached to the service's network namespace.\n\n#### Run a regular command from the Consul container\n\n\tSERVICE_CHECK_SCRIPT=curl --silent --fail example.com\n\nThe default interval for any non-TTL check is 10s, but you can set it with `_CHECK_INTERVAL`.\n\n#### Register a TTL health check\n\n\tSERVICE_CHECK_TTL=30s\n\nRemember, this means Consul will be expecting a heartbeat ping within that 30 seconds to keep the service marked as healthy.\n\n\n## Todo / Contribution Ideas\n\n * Zookeeper backend\n * discoverd backend\n * Netflix Eureka backend\n * etc...\n\n## Sponsors and Thanks\n\nThis project was made possible by [DigitalOcean](http://digitalocean.com). Big thanks to Michael Crosby for [skydock](https://github.com/crosbymichael/skydock) and the Consul mailing list for inspiration.\n\n## License\n\nBSD\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",4381899,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":98,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":96,"_119":104,"_120":113,"_121":62,"_122":17},"content_type","creator",79639,"digest","sha256:a9cf78f1f60179514960e18abca0e5d553014f944b6a9e8e60e3a1deda347963","full_size",4356737,"id",60944,"images",[99],{"_100":101,"_91":92,"_102":44,"_103":104,"_105":106,"_107":44,"_108":44,"_109":-5,"_110":111,"_59":62,"_112":-5},"architecture","amd64","features","last_pulled","2026-09-23T07:07:55.68103599Z","last_pushed","2015-11-13T23:18:29Z","os","os_features","os_version","size",4356929,"variant","2015-11-13T23:18:32.295694Z","last_updater","last_updater_username","media_type","latest","repository","tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":134,"_141":142,"_130":151,"_152":11},{"_36":135,"_38":136,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":137,"_53":31,"_28":29,"_54":55,"_56":-5,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":138,"_75":17,"_76":140,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":139},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_143":60,"_144":-5,"_145":-5,"_146":147},"count","next","previous","results",[148],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_97":149,"_46":113,"_114":90,"_115":29,"_116":52,"_53":117,"_118":96,"_119":104,"_120":113,"_121":62,"_122":17},[150],{"_100":101,"_91":92,"_102":44,"_103":104,"_105":106,"_107":44,"_108":44,"_109":-5,"_110":111,"_59":62,"_112":-5},[],"canDeleteTags","actionData","errors"]

sheldonh/registrator

Tags for sheldonh/registrator