Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/st-tech/gatling-operator

Automating distributed Gatling load testing using Kubernetes operator
https://github.com/st-tech/gatling-operator

gatling k8s-operator

Last synced: 2 days ago
JSON representation

Automating distributed Gatling load testing using Kubernetes operator

Host: GitHub
URL: https://github.com/st-tech/gatling-operator
Owner: st-tech
License: mit
Created: 2021-10-05T11:17:10.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-04-12T09:50:24.000Z (7 months ago)
Last Synced: 2024-04-12T16:55:50.076Z (7 months ago)
Topics: gatling, k8s-operator
Language: Go
Homepage:
Size: 768 KB
Stars: 64
Watchers: 16
Forks: 18
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-gatling - gatling-operator - Automating distributed Gatling load testing using Kubernetes operator. (Distributed Testing)

README

# Gatling Operator

[![Go Report Card](https://goreportcard.com/badge/github.com/st-tech/gatling-operator)](https://goreportcard.com/report/github.com/st-tech/gatling-operator) [![CI](https://github.com/st-tech/gatling-operator/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/st-tech/gatling-operator/actions/workflows/ci.yml) [![daily vulnerability scan](https://github.com/st-tech/gatling-operator/actions/workflows/daily-vul-scan.yml/badge.svg?branch=main)](https://github.com/st-tech/gatling-operator/actions/workflows/daily-vul-scan.yml) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/st-tech/gatling-operator)

[Gatling](https://gatling.io/) is an open source load testing tool that allows to analyze and measure the performance of a variety of services. [Gatling Operator](https://github.com/st-tech/gatling-operator) is a Kubernetes Operator for running automated distributed Gatling load testing.

## How Gatling Operator works

The desired state of a distributed Gatling load testing is described through a Kubernetes custom resource (`Gatling CR` in figure below). Based on Gatling CR, actions in the lifecycle of distributed Gatling load testing such as running load testing, generating reports, sending notification message, and cleaning up the resources are executed by relevant custom controller (`Gatling Controller` in figure below).

![](assets/gatling-operator-arch.svg)

## Features

- Allows Gatling load testing scenario, resources, Gatling configurations files to be added in 3 ways:
- Bundle them with Gatling runtime packages in a Gatling container
- Run the simulations through build tool plugin (e.g. `gradle gatlingRun`) in a Docker container
- Add them as multi-line definition in Gatling CR
- Scaling Gatling load testing
- Horizontal scaling: number of pods running in parallel during a load testing can be configured
- Vertical scaling: CPU and RAM resource allocation for Gatling runner Pod can be configured
- Allows Gatling load testing to start running at a specific time
- By default, the Gatling load testing starts running as soon as the runner Pod's init container gets ready. By specifying the start time, the Gatling load testing waits to start running until the specified time
- Gatling Pod attributions
- Gatling runtime container image
- [rclone](https://rclone.org/) container image
- CPU and RAM resource allocation request and limit
- `Affinity` (such as Node affinity) and `Tolerations` to be used by the scheduler to decide where a pod can be placed in the cluster
- `Service accounts` for Pods
- Reports
- Automated generating aggregated Gatling HTML reports and storing them to Cloud Storages such as `Amazon S3`, `Google Cloud Storage`, `Azure Blob Storage`. via [rclone](https://rclone.org/)
- Allows credentials info for accessing the remote storage to be specified via Secret resource
- Notification
- Automated posting webhook message and sending Gatling load testing result via notification providers such as `Slack`
- Allows webhook URL info to be specified via Secret resource
- Automated cleaning up Gatling resources

## Requirements

- Kubernetes: version >= 1.18

> note: the versions below 1.18 might work but are not tested

## Quick Start

- [Quick Start Guide](docs/quickstart-guide.md)

## Documentations

- [Architecture](docs/architecture.md)
- [Gatling CRD Reference](docs/api.md)
- [User Guide](docs/user-guide.md)
- [How to build Gatling Operator](docs/build-guide.md)

## Contributing

Please make a GitHub issue or pull request to help us build the operator.

## Changelog

Please see the [list of releases](https://github.com/st-tech/gatling-operator/releases) for information on changes between releases.