{"id":13646220,"url":"https://github.com/mhausenblas/kboom","last_synced_at":"2026-01-15T01:22:03.765Z","repository":{"id":46133785,"uuid":"181615818","full_name":"mhausenblas/kboom","owner":"mhausenblas","description":"The Kubernetes scale \u0026 soak load tester","archived":true,"fork":false,"pushed_at":"2021-11-11T15:16:51.000Z","size":711,"stargazers_count":307,"open_issues_count":7,"forks_count":23,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-08-15T14:51:59.025Z","etag":null,"topics":["kubernetes","load-testing","performance","scale"],"latest_commit_sha":null,"homepage":null,"language":"Go","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/mhausenblas.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":"2019-04-16T04:40:51.000Z","updated_at":"2025-08-04T19:44:52.000Z","dependencies_parsed_at":"2022-08-26T16:52:19.701Z","dependency_job_id":null,"html_url":"https://github.com/mhausenblas/kboom","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mhausenblas/kboom","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhausenblas%2Fkboom","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhausenblas%2Fkboom/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhausenblas%2Fkboom/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhausenblas%2Fkboom/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mhausenblas","download_url":"https://codeload.github.com/mhausenblas/kboom/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mhausenblas%2Fkboom/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28441031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-15T00:55:22.719Z","status":"ssl_error","status_checked_at":"2026-01-15T00:55:20.945Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["kubernetes","load-testing","performance","scale"],"created_at":"2024-08-02T01:02:50.825Z","updated_at":"2026-01-15T01:22:03.739Z","avatar_url":"https://github.com/mhausenblas.png","language":"Go","funding_links":[],"categories":["Testing","Go","Test"],"sub_categories":["[Jenkins](#jenkins)"],"readme":"# A simple Kubernetes load testing tool\n\n![kboom logo](img/kboom-logo.png)\n\n\n\u003e NOTE: this is WIP and also this is not an official AWS tool. Provided as is and use at your own risk.\n\nThink of `kboom` as the Kubernetes equivalent of [boom](https://github.com/tarekziade/boom), allowing you to create short-term load for scale testing and long-term load for soak testing. Supported load out of the box for scale testing are pods and custom resources via CRDs for soak testing is planned.\n\nCheck out the interactive [demo](https://www.katacoda.com/petermbenjamin/scenarios/kboom).\n\n## Why bother?\n\nI didn't find a usable tool to do Kubernetes-native load testing, for scalability and/or soak purposes. Here's where I can imagine `kboom` might be useful for you:\n\n- You are a cluster admin and want to test how much \"fits\" in the cluster. You use `kboom` for a scale test and see how many pods can be placed and how long it takes.\n- You are a cluster or namespace admin and want to test how long it takes to launch a set number of pods in a new cluster, comparing it with what you already know from an existing cluster.\n- You are developer and want to test your custom controller or operator. You use `kboom` for a long-term soak test of your controller.\n\n## Install\n\nBefore you begin, you will need `kubectl` client version v1.12.0 or higher for [kubectl plugin support](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/).\n\nTo install `kboom`, do the following:\n\n```bash\n$ curl https://raw.githubusercontent.com/mhausenblas/kboom/master/kboom -o kubectl-kboom\n$ chmod +x kubectl-kboom\n$ sudo mv ./kubectl-kboom /usr/local/bin\n```\n\nFrom this point on you can use it as a `kubectl` plugin as in `kubectl kboom`. However, in order for you to generate the load, you'll have to also give it the necessary [permissions](permissions.yaml) (note: you only need to do this once, per cluster):\n\n```bash\n$ kubectl create ns kboom\n$ kubectl apply -f https://raw.githubusercontent.com/mhausenblas/kboom/master/permissions.yaml\n```\n\nNow you're set up and good to go, next up, learn how to use `kboom`.\n\n## Use\n\nHere's how you'd use `kboom` to do some scale testing. The load test is run in-cluster as a [Kubernetes job](https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/) so you do multiple runs and compare outcomes in a straight-forward manner. Note that by default `kboom` assumes there's a namespace `kboom` available and it will run in this namespace. If this namespace doesn't exist, create it with `kubectl create ns kboom` or otherwise use the `--namespace` parameter to overwrite it.\n\nSo, first we use the `generate` command to generate the load, launching 10 pods (that is, using `busybox` containers that just sleep) with a timeout of 14 seconds (that is, if a pod is not running within that time, it's considered a failure):\n\n```bash\n$ kubectl kboom generate --mode=scale:14 --load=pods:10\njob.batch/kboom created\n```\n\nFrom now on you can execute the `results` command as often as you like, you can see the live progress there:\n\n\n```bash\n$ kubectl kboom results\nServer Version: v1.12.6-eks-d69f1b\nRunning a scale test, launching 10 pod(s) with a 14s timeout ...\n\n-------- Results --------\nOverall pods successful: 6 out of 10\nTotal runtime: 14.061988653s\nFastest pod: 9.003997546s\nSlowest pod: 13.003831951s\np50 pods: 12.003529448s\np95 pods: 13.003831951s\n```\n\nWhen you're done, and don't need the results anymore, use `kubectl kboom cleanup` to get rid of the run. Note: should you execute the `cleanup` command too soon for `kboom` to terminate all its test pods, you can use `kubectl delete po -l=generator=kboom` to get rid of all orphaned pods.\n\n## Known issues and plans\n\n- Need to come up with stricter permissions, currently too wide and not following the least privileges principle.\n- Add support for custom resources and soak testing (running for many hours).\n- Add support for other core resources, such as services or deployments.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmhausenblas%2Fkboom","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmhausenblas%2Fkboom","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmhausenblas%2Fkboom/lists"}