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.

Azure DevOps Pipelines can trigger Gatling Enterprise Edition simulations using the official Gatling CI shell script. Because there is no dedicated Azure Pipelines marketplace extension, the integration uses a portable start_simulation.sh script that you commit to your repository and invoke as a Bash pipeline task. The API token and simulation ID are passed as pipeline variables, keeping secrets out of your source code.
This integration is only available on Gatling Enterprise Edition. A complete working example is available at github.com/gatling/azure-devops-demo.

​
Requirements

Before configuring your pipeline, gather the following:

Git repository

A repository connected to Azure DevOps (GitHub, Azure Repos, or another supported provider).

Configured simulation

A simulation set up on Gatling Enterprise Edition. Copy its ID from the Simulations page using Copy Simulation ID to clipboard.

API token

A Gatling Enterprise Edition API token with the Start permission.

Azure agent pool

An Azure DevOps agent pool with agents that have internet access. Note the pool name for use in the pipeline YAML.

​
Preparing the Repository

1

Download the CI Script

Download the CI script ZIP from the Gatling Enterprise CI plugins releases page. Unzip the archive and place start_simulation.sh at the root of your repository.
2

Create the Pipeline File

Create azure-pipelines.yml at the root of your repository with the following content:
trigger: none

pool: AzurePipelinesPool  # Replace with your agent pool name

steps:
  - task: Bash@3
    displayName: Install JQ
    inputs:
      targetType: 'inline'
      # curl is typically pre-installed on Ubuntu agents; jq may not be
      script: 'sudo apt-get update && sudo apt-get -y install jq'

  - task: Bash@3
    displayName: Start simulation
    env:
      GATLING_ENTERPRISE_API_TOKEN: $(GATLING_ENTERPRISE_API_TOKEN)
    inputs:
      filePath: 'start_simulation.sh'
      arguments: $(simulationId)
The CI script requires both curl and jq. Install any missing dependencies in a preliminary step as shown above.
3

Commit and Push

Commit both start_simulation.sh and azure-pipelines.yml to your repository.

​
Creating the Pipeline in Azure DevOps

1

Open New Pipeline

In your Azure DevOps project, click Pipelines in the left menu, then Create Pipeline (or New Pipeline).
2

Connect to Your Repository

On the Connect step, select your repository provider. For GitHub, you may need to authorize the Azure DevOps application to access your repositories.
3

Select the Repository

On the Select step, choose your repository. For organization repositories, use the All repositories filter.
4

Review the Pipeline YAML

Since azure-pipelines.yml already exists, Azure DevOps skips the Configure step and shows the YAML file for review directly.
5

Add Pipeline Variables

Before saving, click New variable and add:
  • GATLING_ENTERPRISE_API_TOKEN — your API token. Enable “Keep this value secret”.
  • simulationId — the ID of the simulation you want to run.
6

Save and Run

Click Save, then Run to start the first execution. You will be redirected to the job summary page.

​
Resolving Permissions Errors

After a job is queued, Azure DevOps may show a Permission needed warning if your pipeline requires approval to access resources. Click the red Permission needed link in the job view and grant the requested permissions to continue.

​
Viewing Run Results

Once the job is running, click Job in the timeline view, then click the Start simulation task to see the real-time Gatling Enterprise Edition console output, including live metrics and the final run summary.

​
Variables Reference

VariableRequiredDescription
GATLING_ENTERPRISE_API_TOKENYesAPI token for authenticating with Gatling Enterprise Edition. Mark as secret.
simulationIdYesThe ID of the simulation to run, passed as an argument to start_simulation.sh.
Always enable “Keep this value secret” for GATLING_ENTERPRISE_API_TOKEN to prevent the token from appearing in job logs or pipeline run summaries.

Build docs developers (and LLMs) love

Get started for freeTalk to us