{"id":26164741,"url":"https://github.com/optum/kong-cluster-drain","last_synced_at":"2026-07-14T07:31:56.853Z","repository":{"id":51256084,"uuid":"144073555","full_name":"Optum/kong-cluster-drain","owner":"Optum","description":"Drain and divert your traffic without briging down the LTM and interrupting existing traffic by a switch that allows failing your healthcheck to a datacenter.","archived":false,"fork":false,"pushed_at":"2021-08-04T14:31:43.000Z","size":648,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-10-26T11:42:58.256Z","etag":null,"topics":["api-gateway","kong","optum"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Optum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-08T22:20:20.000Z","updated_at":"2021-08-04T14:31:46.000Z","dependencies_parsed_at":"2022-09-07T01:00:50.144Z","dependency_job_id":null,"html_url":"https://github.com/Optum/kong-cluster-drain","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Optum/kong-cluster-drain","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fkong-cluster-drain","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fkong-cluster-drain/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fkong-cluster-drain/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fkong-cluster-drain/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Optum","download_url":"https://codeload.github.com/Optum/kong-cluster-drain/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fkong-cluster-drain/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35451878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-14T02:00:06.603Z","response_time":114,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-gateway","kong","optum"],"created_at":"2025-03-11T15:40:04.139Z","updated_at":"2026-07-14T07:31:56.836Z","avatar_url":"https://github.com/Optum.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kong Cluster Drain\n## Overview\nDrain and divert your traffic without briging down the LTM and iterrupting existing traffic by a switch that allows failing your healthcheck to a datacenter.\n\n## Explanation:\n\nThis plugin we have used in tandem with our other plugin here:\nhttps://github.com/Optum/kong-splunk-log\n\nBecause you need to have a specific NGINX ENV variable set - \n\nIf not already set, it can be done so as follows:\n```\n$ export SPLUNK_HOST=\"gateway-datacenter.company.com\"\n```\n\n**One last step** is to make the environment variable accessible by an nginx worker. To do this, simply add this line to your _nginx.conf_\n```\nenv SPLUNK_HOST;\n```\n\nOnce done the plugin takes in a 'host' argument that needs to match that of your SPLUNK_HOST environment variable when you intend for this plugin to be active and enabled on top of your healthcheck proxy endpoint in pushing traffic away from your datacenter/cluster.\n\nThe real benefit here is you end up with no traffic downtime because if you cut off your LTM prior to draining your traffic and diverting it you will lose all the active connections/transactions at that moment in time.\n\nFeel free to fork this and use a seperate environment variable of your own if desired! Think of SPLUNK_HOST environment variable as a marker tag for certain Kong Nodes/Clusters in your respective datacenters.\n\n## Supported Kong Releases\nKong \u003e= 1.x\n\n## Installation\nRecommended:\n```\n$ luarocks install kong-cluster-drain\n```\n\nOptional\n```\n$ git clone https://github.com/Optum/kong-cluster-drain\n$ cd /path/to/kong/plugins/kong-cluster-drain\n$ luarocks make *.rockspec\n```\n\n## Maintainers\n[jeremyjpj0916](https://github.com/jeremyjpj0916)  \n[rsbrisci](https://github.com/rsbrisci)  \n\nFeel free to open issues, or refer to our Contribution Guidelines if you have any questions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptum%2Fkong-cluster-drain","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foptum%2Fkong-cluster-drain","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptum%2Fkong-cluster-drain/lists"}