Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jthomperoo/locust-pod-autoscaler
Latency based Kubernetes autoscaler.
https://github.com/jthomperoo/locust-pod-autoscaler
apache2 autoscaler autoscaling cpa custom-pod-autoscaler invokust kubernetes locust locustio python
Last synced: 29 days ago
JSON representation
Latency based Kubernetes autoscaler.
- Host: GitHub
- URL: https://github.com/jthomperoo/locust-pod-autoscaler
- Owner: jthomperoo
- License: apache-2.0
- Created: 2020-01-30T18:26:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-25T23:20:01.000Z (over 3 years ago)
- Last Synced: 2024-04-22T14:53:13.549Z (8 months ago)
- Topics: apache2, autoscaler, autoscaling, cpa, custom-pod-autoscaler, invokust, kubernetes, locust, locustio, python
- Language: Python
- Size: 33.2 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/jthomperoo/locust-pod-autoscaler/actions)
[](https://codecov.io/gh/jthomperoo/locust-pod-autoscaler)
[](https://locust-pod-autoscaler.readthedocs.io/en/latest)
[](http://www.apache.org/licenses/LICENSE-2.0.html)
# Locust Pod Autoscaler
This is the Locust Pod Autoscaler, a Kubernetes Custom Pod Autoscaler that uses latency to scale.
This is project is built using the [Custom Pod Autoscaler Framework](https://custom-pod-autoscaler.readthedocs.io/en/latest).
## What is it?
This is a [Custom Pod Autoscaler](https://custom-pod-autoscaler.readthedocs.io/en/latest) for Kubernetes, powered by [Locust](https://locust.io/) to run load tests to retrieve latency statistics.
This autoscaler allows you to write your own Locust tests to load test your Kubernetes applications, then provides simple configuration for scaling based on the results of these. For example an autoscaler could be created that gathers latency statistics every minute for a REST API, if the average latency goes above `50ms` then the application should be scaled up.
## How does it work?
The autoscaler works by running Locust tests you create in Python, then gathering the statistics from these before comparing with configured target latencies.
Accompanying this upscaling based on latency is the idea of a *decay*, which can be configured as part of the autoscaler. The decay works by waiting for a number of runs of the autoscaler in which the number of replicas hasn't changed, and reducing the replica count by a configured amount. This allows flexiblity in conservatively or aggressively downscaling, and if it downscales too far the autoscaler will scale back up again based on latency tests.
See the [example](example), [getting started guide](https://locust-pod-autoscaler.readthedocs.io/en/latest/user-guide/getting-started), or [the wiki](https://locust-pod-autoscaler.readthedocs.io/en/latest/) for further information.
## Getting started
Check out [this getting started guide for a quick start for developers](https://locust-pod-autoscaler.readthedocs.io/en/latest/user-guide/getting-started).
## More information
See the [wiki for more information, such as guides and references](https://locust-pod-autoscaler.readthedocs.io/en/latest/).
## Developing this project
### Environment
Developing this project requires these dependencies:
* [Python](https://www.python.org/downloads/release/python-360/) == `3.6.x`
Python development dependencies can be installed with:
```bash
pip install -r requirements-dev.txt
```
Project dependencies can be installed with:
```bash
pip install -r requirements.txt
```
To view docs locally, requires:
* [mkdocs](https://www.mkdocs.org/)
### Commands
* `make` - builds the Docker image
* `make lint` - lints the code.
* `make unittest` - runs the unit tests.
* `make doc` - hosts the documentation locally, at `127.0.0.1:8000`.