Skip to content

grafana/k6-operator

data flow

k6 Operator

grafana/k6-operator is a Kubernetes operator for running distributed k6 tests in your cluster. k6 Operator introduces two CRDs:

  • TestRun CRD
  • PrivateLoadZone CRD

The TestRun CRD is a representation of a single k6 test executed once. TestRun supports various configuration options that allow you to adapt to different Kubernetes setups. You can find a description of the more common options here, and the full list of options can be found in the definition itself.

The PrivateLoadZone CRD is a representation of a load zone, which is a k6 term for a set of nodes within a cluster designated to execute k6 test runs. PrivateLoadZone is integrated with Grafana Cloud k6 and requires a Grafana Cloud account. You can find a guide describing how to set up a PrivateLoadZone here, while billing details can be found here.

Installation

Refer to Install k6 Operator for installation instructions.

Documentation

You can find the latest k6 Operator documentation in the Grafana k6 OSS docs.

For additional resources:

Common samples are available in the config/samples and e2e/ folders in this repo, both for the TestRun and PrivateLoadZone CRDs.

Contributing

We are always interested in your feedback! If you encounter problems during the k6 Operator usage, check out the troubleshooting guide. If you have questions on how to use the k6 Operator, you can post them on the Grafana community forum.

Regarding opening issues and development of the k6-operator, please see the contributing guide.