Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gatling/gatling.io-doc/llms.txt

Use this file to discover all available pages before exploring further.

Gatling Enterprise Edition provides a set of official infrastructure-as-code (IaC) resources to automate the deployment of your Control Plane and private locations. Instead of manually provisioning cloud resources and configuring containers, you can bootstrap your entire load-testing infrastructure from a single declarative configuration. Official Terraform modules are available for AWS, Azure, and GCP, and a Helm chart covers Kubernetes and OpenShift.
Infrastructure-as-code resources are only available on Gatling Enterprise paid plans. You must have a valid organization with Private Locations activated and a Control Plane token before using these resources.
The IaC resources are provided as bootstrapping references. Fork and adapt them to match your organization’s security, networking, and naming conventions before using them in production.

​
Prerequisites

Before deploying any IaC resource, ensure you have:
  1. Control Plane token — generated from the Private Locations section of the Gatling Enterprise UI and stored in a supported secret manager.
  2. Cloud account / cluster — administrative permissions for your target environment (AWS account, Azure subscription, GCP project, or Kubernetes/OpenShift cluster).
  3. IaC tools — the toolchain required for your chosen approach:
    • Terraform + the relevant cloud CLI (AWS CLI, az, gcloud)
    • Helm + kubectl for Kubernetes/OpenShift

​
Helm chart for Kubernetes and OpenShift

The Helm chart deploys the Control Plane container as a Kubernetes Deployment along with the required Role, ServiceAccount, and RoleBinding. This grants the Control Plane the ability to spawn batch Job objects that create one or more pods as load generators with defined resource limits and requests. Helm chart versions are published to the Gatling Helm registry at https://helm.gatling.io.
1

Add the Gatling Helm repository

helm repo add gatling https://helm.gatling.io
helm repo update
2

Review the values file

The chart’s values.yaml exposes three configuration sections:
SectionPurpose
controlPlaneToken reference, image version, resource limits for the Control Plane container
privateLocationsLocation IDs, instance configuration, and provider settings
privatePackage (optional)S3, Azure Blob, GCP Cloud Storage, or volume backend for private packages
3

Install the chart

Follow the complete installation steps in the GitHub repository.

​
Terraform for AWS

The AWS Terraform module deploys the Control Plane container on Elastic Container Service (ECS) using Fargate and creates the necessary IAM roles and policies to allow the Control Plane to spawn EC2 instances as load generators inside your VPC. Optionally, it can configure an S3 bucket for private package storage.

Terraform Registry

gatling/control-plane/aws

GitHub Repository

Source and sample configuration
Quick start: 
module "gatling_control_plane" {
  source  = "gatling/control-plane/aws"

  # See https://github.com/gatling/terraform-aws-control-plane/blob/main/example/main.tf
  # for the full sample configuration
}
See the sample configuration for all required and optional variables.

​
Terraform for Azure

The Azure Terraform module deploys the Control Plane container on a Container App using a Container App Environment, mounts an existing Azure Storage Account as a volume for configuration, and creates the necessary role assignments to let the Control Plane spawn Azure Virtual Machine load generators. Optionally supports storing private packages in an existing Azure Storage Account.

Terraform Registry

gatling/control-plane/azure

GitHub Repository

Source and sample configuration
Quick start: 
module "gatling_control_plane" {
  source  = "gatling/control-plane/azure"

  # See https://github.com/gatling/terraform-azure-control-plane/blob/main/example/main.tf
  # for the full sample configuration
}

​
Terraform for GCP

The GCP Terraform module deploys the Control Plane on Cloud Run (or a Compute Engine VM), mounts an existing GCP storage bucket as a volume, and creates the necessary IAM role assignments to allow the Control Plane to spawn Compute Engine VM load generators in your project. Optionally supports storing private packages in GCP Cloud Storage.

Terraform Registry

gatling/control-plane/gcp

GitHub Repository

Source and sample configuration
Quick start: 
module "gatling_control_plane" {
  source  = "gatling/control-plane/gcp"

  # See https://github.com/gatling/terraform-gcp-control-plane/blob/main/example/main.tf
  # for the full sample configuration
}

​
Summary of available resources

PlatformToolModule / Chart
Kubernetes / OpenShiftHelmgatling/control-plane at helm.gatling.io
AWS (ECS + EC2)Terraformgatling/control-plane/aws
Azure (Container Apps + VMs)Terraformgatling/control-plane/azure
GCP (Cloud Run + Compute Engine)Terraformgatling/control-plane/gcp
All modules accept the Control Plane token as a reference to a secret in your cloud provider’s secret manager. Never embed the token directly in your Terraform state or Helm values files.

Build docs developers (and LLMs) love

Get started for freeTalk to us