https://github.com/mms-gianni/locust-admin

GUI and API to parallelizing locust.io loadtests on kubernetes
https://github.com/mms-gianni/locust-admin

benchmark benchmarking kubernetes load-test load-testing locust locustio performance performance-testing performancetesting

Last synced: about 1 month ago
JSON representation

GUI and API to parallelizing locust.io loadtests on kubernetes

• Host: GitHub
• URL: https://github.com/mms-gianni/locust-admin
• Owner: mms-gianni
• License: mit
• Created: 2021-09-09T15:12:48.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-08-17T12:55:57.000Z (over 1 year ago)
• Last Synced: 2024-08-04T02:07:54.880Z (4 months ago)
• Topics: benchmark, benchmarking, kubernetes, load-test, load-testing, locust, locustio, performance, performance-testing, performancetesting
• Language: JavaScript
• Homepage:
• Size: 1.28 MB
• Stars: 10
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-locust - locust-admin - Dynamically create and manage Locust instances on a Kubernetes cluster. (Tools / Distributed)

README

        

## Locust Swarmadmin

[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/locust-swarmadmin)](https://artifacthub.io/packages/search?repo=locust-swarmadmin)

![Docker Image Version (latest semver)](https://img.shields.io/docker/v/gicara/swarmadmin?color=blue&sort=semver)

[Locust](https://www.locust.io) is an easy to use, scriptable and scalable performance testing tool. But it is not very flexible. Specially when it comes to run multiple different configured loadtests in kubernetes cloud. 

This project solves this problem by adding a additional admin interface and API to dynamically start Locust instances in your kubernetes cluster.

All configurations are stored on your kubernetes cluster. 

API Swagger documentation : https://mms-gianni.github.io/swarmadmin/swagger.html 

![Screenshot](docs/swarmadmin.png) 

## Installation on Kubernetes

The Helm installation is based on [Deliveryhero's](https://github.com/deliveryhero/helm-charts/tree/master/stable/locust) helm charts. (Version 0.20.2)

```

cd k8s/

helm install -f values.yaml locustswarm . -n locustswarm --create-namespace

helm upgrade -f values.yaml locustswarm .

```

The results are exported and stored in Prometheus. They can easily be displayed on a grafana board

https://grafana.com/grafana/dashboards/15109

![Screenshot](docs/grafana.png) 

## Docker container environment variables

For a full list of available environment variables, please visit [.env.example](.env.example)

#### KUBECONFIG_BASE64 

A base64 encoded kubeconfig 

```

export KUBECONFIG_BASE64=$(cat kubeconfig | base64)

```

#### KUBECONFIG_PATH

Fallback if KUBECONFIG_PATH is empty

## Development 

### running a local KiND cluster

```

kind create cluster --config kind.yaml

kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/main/deploy/static/provider/kind/deploy.yaml

kind export kubeconfig --name superlocust --kubeconfig ./kubeconfig

```

Make sure you are using the internal kubeconfig for the ENV variable to configure the helm charts

```

export KUBECONFIG_BASE64=$(kind get kubeconfig --name superlocust --internal | base64)

```

### start on local node

```

cd client && npm run build && cd .. && npm run serve

```

## Possible future features

- [x] ~~Store loadtest results in a database (MongoDB? or Prometheus? https://github.com/siimon/prom-client) or a Prometheus exporter~~

- [ ] ~~Add provision support for other clouds (AWS, Google, Azure, Digital Ocean ... )~~ won't be implemented since it would be to complicated to maintain