Private packages
Store your simulations' packages privately in your infrastructure, and use them with private locations.
Introduction
Private Locations facilitate running simulations in your dedicated cloud environment. Ensure secure storage of sensitive simulation packages in your private cloud.
The control plane offers a private repository; enable it for confidential package management!
Private packages
A private package is uploaded through the control plane into a private repository. Gatling Enterprise Cloud only receives the Gatling version associated with the package and the names of simulation classes, which helps in simulation configuration
When initiating a Gatling run, the control plane generates a temporary signed link to allow the download of the private package from the load generators.
Infrastructure
Currently, Private Packages support the following underlying storages:
- AWS S3
- GCP Cloud Storage
- Azure Blob Storage
- the Control Plane host filesystem
Control plane server
The control plane with a private repository has a server to manage uploads to the repository, secured by a Gatling Enterprise Cloud API Token with Configure role.
The server is accessible on port 8080 by default when a repository is configured. The following optional server configuration with the default settings is provided for your reference.
control-plane {
repository {
# Upload configuration (optional)
upload {
directory = "/tmp" # (optional, default: /tmp)
}
# Server configuration (optional)
server {
port = 8080 # (optional, default: 8080)
bindAddress = "0.0.0.0" # (optional, default: 0.0.0.0)
# PKCS#12 certificate (optional)
certificate {
path = "/path/to/certificate.p12"
password = ${CERTIFICATE_PASSWORD} # (optional)
}
}
}
}
This configuration includes the following parameters:
- upload.directory: This directory temporarily stores uploaded JAR files. (optional)
- server.port: The port on which the control plane is listening for private package uploads.
- server.bindAddress: The network interface to bind to. The default is
0.0.0.0, which means all available network IPv4 interfaces. - server.certificate: The server P12 certificate for secure connection without SSL reverse proxy. (optional)
Control plane repository
AWS S3
Control plane with private repository needs AWS permissions s3:PutObject, s3:DeleteObject and s3:GetObject on the bucket.
To download a private package, the location requires outbound connection access to https://<bucket>.s3.<region>.amazonaws.com.
Once it is done, add the private repository configuration section in your control plane configuration file:
control-plane {
repository {
# S3 Bucket configuration
type = "aws"
bucket = "bucket-name"
path = "folder/to/upload" # (optional, default: root)
}
}
This configuration includes the following parameters:
- bucket: The name of the bucket where packages are uploaded to on AWS S3.
- path: The path of a folder in AWS S3 bucket. (optional)
GCP Cloud Storage
Control plane with private repository needs GCP service account role with permissions storage.objects.create,
storage.objects.delete and iam.serviceAccounts.signBlob on the bucket.
To download a private package, the location requires outbound connection access to https://storage.googleapis.com/<bucket>.
control-plane {
repository {
# Cloud Storage Bucket configuration
type = "gcp"
bucket = "bucket-name"
path = "folder/to/upload" # (optional, default: root)
}
}
This configuration includes the following parameters:
- bucket: The name of the bucket where packages are uploaded to on GCP Cloud Storage.
- path: The path of a folder in Cloud Storage bucket. (optional)
Azure Blob Storage
Control plane with private repository needs to be associate with Azure storage account role Storage Blob Data Contributor.
For more information, check Authenticate to Azure and authorize access to blob data
To download a private package, the location requires outbound connection access to https://<storage-account>>.blob.core.windows.net/<container>
control-plane {
repository {
# Azure Blob Storage configuration
type = "azure"
storage-account = "storage-account-name"
container = "container-name"
path = "folder/to/upload" # (optional, default: root)
}
}
Filesystem Storage
download-base-url.This option allows the storage of simulations directly on the control-plane filesystem.
repository = {
# Filesystem configuration
type = "filesystem"
# Directory to store your private packages
directory = "/data/gatling-repository"
upload {
# Directory to temporarily store your incoming simulation during the upload process
directory = "/tmp" # (optional, default: /tmp)
}
location {
# URL of your control-plane from your private locations
download-base-url = "http://www.example.com:8080"
}
}
upload.directory configuration, which defaults to /tmp, will be used to temporarily store your incoming simulation during the upload process.
Once the upload is complete, the file will be stored in your configured directory (/data/gatling-repository in the provided example).This configuration includes the following parameters:
- directory: The directory where the simulations will be stored.
- location.download-base-url: The access URL for the control-plane. This URL will be provided to the load-generators so that they can download your simulations.
Usage
After configuration, restart your control plane to start the server.
Creating a private package
To create a private package, use Gatling Plugin deployment commands with control plane URL configured:
Deleting a private package
To delete a private package, delete the package within Gatling Enterprise Cloud. The control plane will receive the order to delete the package on the configured private repository.