[{"_1":2,"_169":-5,"_170":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_144":145},"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,"_135":-5,"_136":11,"_137":17,"_138":11,"_139":-5,"_140":11,"_141":-5,"_142":143},"canonicalUrl","https://hub.docker.com/r/richardjkendall/haproxy/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","richardjkendall","reponame","haproxy","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":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2018-11-04T07:11:32.524283Z","description","haproxy + AWS Service Discovery","is_private","last_updated","2022-07-17T08:35:29.249038Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",3459,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","![travis ci](https://api.travis-ci.org/richardjkendall/haproxy.svg?branch=master \"build status\")\r\n\r\n# haproxy + AWS Service Discovery\r\nThis is a Docker image automatically configures haproxy using information retrieved from the AWS Service Discovery API.\r\n\r\nIt is based on the ``haproxy:2.1.1`` base image.\r\n\r\nExposes service on 80/tcp.\r\n\r\nPolls for changes every 60 seconds and reloads haproxy with signal SIGUSR2 each time a new config is detected. This refresh rate is configurable with the ``REFRESH_RATE`` environment variable.\r\n\r\nCurrently only works for services with tasks that use the ``bridge`` networking mode.\r\n\r\nSee this on docker hub here https://hub.docker.com/r/richardjkendall/haproxy/\r\n## Building\r\nClone the repository\r\n\r\n 1. cd to the directory ``cd haproxy``\r\n 2. cd to the cfgmaker directory ``cd cfgmaker``\r\n 3. Install the npm dependencies ``npm install``\r\n 4. cd to the base directory ``cd ..``\r\n 5. Run docker build ``docker build -t haproxy .``\r\n\r\n## Running\r\n### From docker hub\r\n```\r\ndocker run --name= -d -p 80:80 \\\r\n -e AWS_REGION= \\\r\n -e APPLY_MODE=<'on' or 'off' defaults to 'on'> \\\r\n -e NAMESPACE_MAP=`cat jsonfile.json` \\\r\n -e REFRESH_RATE= \\\r\n -e DEFAULT_DOMAIN=\r\n richardjkendall/haproxy\r\n```\r\n\r\n### From local copy of image\r\n```\r\ndocker run --name= -d -p 80:80 \\\r\n -e AWS_REGION= \\\r\n -e APPLY_MODE=<'on' or 'off' defaults to 'on'> \\\r\n -e NAMESPACE_MAP=`cat jsonfile.json` \\\r\n -e REFRESH_RATE= \\\r\n -e DEFAULT_DOMAIN=\r\n haproxy\r\n```\r\n\r\n## Example\r\nIf a container is run with the following environment variables \r\n\r\n|Variable|Value |\r\n|--|--|\r\n| AWS_REGION | ap-southeast-2 |\r\n| APPLY_MODE | on or off |\r\n| NAMESPACE_MAP | ```{...see below...}``` |\r\n| REFRESH_RATE | 30 |\r\n| DEFAULT_DOMAIN | blank.test.com |\r\n| PROM_PASSWD | blah123 |\r\n| STATS_PASSWD | abcdef |\r\n\r\nWhere the JSON in NAMESPACE_MAP is\r\n```json\r\n[\r\n {\r\n \"namespace\": \"cluster\",\r\n \"domainname\": \"test.com\"\r\n \"mode\": \"host\"\r\n }\r\n]\r\n```\r\n\r\nThen the tool will find all the services running in the ``cluster`` namespace in the ``ap-southeast-2`` region and create a rule in the haproxy config to send traffic sent to hosts named ``.test.com`` to the instances configured under that service. This will refresh every ``30`` seconds.\r\n\r\n#### Path based routing\r\n\r\nThe `mode` option can be omitted, and when it is not present 'host' mode is assumed'. Where it is present it can be set to 'host' or 'path'. In path mode the routing rules will be set up to route based on paths for example test.com/.\r\n\r\nWhere path based routing is used, you cannot have services with names which conflict with 'stats' or 'metrics'.\r\n\r\nThe %_PASSWD variables set the following passwords:\r\n\r\n* PROM_PASSWD: sets the password for the Prometheus metrics endpoint. Username is hardcoded to 'stats'\r\n* STATS_PASSWD: sets the password for the HAproxy stats page. Username is hardcoded to 'stats_user'\r\n\r\n### Prometheus Metrics\r\n\r\nTo access the metrics endpoint, hit any endpoint that haproxy is hosting /metrics e.g. www.example.com/metrics and log in with the username 'stats' and the password set in PROM_PASSWD.\r\n\r\n### HAproxy stats page\r\n\r\nTo access the stats page, hit any endpoint the haproxy is hosting /stats e.g. www.example.com/stats and log in with the username 'stats_user' and the password set in STATS_PASSWD.\r\n\r\n### Supported naming conventions\r\nThe script which builds the haproxy config supports two naming conventions\r\n\r\n1. Plain: e.g. service.namespace. In this model it would use 'service' as the service name.\r\n2. Extended: e.g. _service._tcp.namespace. In this model it would use the characters between the first underscore and ._tcp (in this example: service) as the service name\r\n\r\n## Health checks\r\nThe script exposes a server on port 3000 which can be polled to check the health of the container. It will either return:\r\n\r\n200 okay: the container is up and the config has been created successfully\r\n500 server error: the container is up but there has been 3 or more failures to create the config\r\n\r\nThis is built into the docker file HEALTHCHECK command, but this is ignored by ECS, so you'll need to include a healthcheck in the task definition. https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#container_definition_healthcheck\r\n\r\n## AWS Permissions\r\nThe following permissions are needed to allow this image to use the AWS Service Discovery API\r\n\r\n```json\r\n{\r\n \"Version\": \"2012-10-17\",\r\n \"Statement\": [\r\n {\r\n \"Sid\": \"ServiceDiscoveryStmt\",\r\n \"Action\": [\r\n \"servicediscovery:ListInstances\",\r\n \"servicediscovery:ListNamespaces\",\r\n \"servicediscovery:ListServices\"\r\n ],\r\n \"Effect\": \"Allow\",\r\n \"Resource\": \"*\"\r\n }\r\n ]\r\n}\r\n```\r\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",1706146162,"orgData","recentTags",[87,125],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",2368918,"full_size",188958607,"id",39169179,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:f5748e9ee821d26c59e3795513920205fbc8baa637e4ec9cf58b1cb3f26f23cd","features","","last_pulled","2026-09-23T07:29:49.555364543Z","last_pushed","2021-03-01T08:45:24Z","os","linux","os_features","os_version","size","variant","2021-03-01T08:45:23.645406Z","last_updater","last_updater_username","media_type","latest","repository",6241503,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_88":40,"_89":90,"_91":126,"_93":127,"_95":128,"_46":133,"_115":90,"_116":29,"_117":52,"_53":134,"_119":120,"_121":131,"_122":133,"_123":62,"_124":17},189535127,84870392,[129],{"_98":99,"_100":130,"_102":103,"_104":131,"_106":132,"_108":109,"_110":103,"_111":-5,"_112":126,"_59":62,"_113":-5},"sha256:801928055a6826b133f050dfd0d064fa5b7d01749b3d9ba465a7a24ff225f496","2026-09-21T19:12:33.363630346Z","2022-07-17T08:35:30Z","2022-07-17T08:35:29.138442Z","develop","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":146,"_153":154,"_142":167,"_168":11},{"_36":147,"_38":148,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":149,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":150,"_75":11,"_76":152,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":151},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_155":156,"_157":-5,"_158":-5,"_159":160},"count",2,"next","previous","results",[161,164],{"_88":40,"_89":90,"_91":126,"_93":127,"_95":162,"_46":133,"_115":90,"_116":29,"_117":52,"_53":134,"_119":120,"_121":131,"_122":133,"_123":62,"_124":17},[163],{"_98":99,"_100":130,"_102":103,"_104":131,"_106":132,"_108":109,"_110":103,"_111":-5,"_112":126,"_59":62,"_113":-5},{"_88":40,"_89":90,"_91":92,"_93":94,"_95":165,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[166],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

richardjkendall/haproxy

Tags for richardjkendall/haproxy