locust-admin

KO | EN

gitlite — search

#python #hacktoberfest #javascript #java #hacktoberfest2021 #machine-learning #jupyter-notebook #docker #cpp #tailwindcss #typescript #php

★ 14 Open GitHub ↗

GUI and API to parallelizing locust.io loadtests on kubernetes

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## 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](https://raw.githubusercontent.com/mms-gianni/locust-admin/master/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](https://raw.githubusercontent.com/mms-gianni/locust-admin/master/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

locust-admin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README