Skip to content

Latest commit

 

History

History
165 lines (96 loc) · 7.16 KB

api.md

File metadata and controls

165 lines (96 loc) · 7.16 KB

API Reference

Packages

gatling-operator.tech.zozo.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the gatling-operator v1alpha1 API group

Resource Types

CloudStorageSpec

CloudStorageSpec defines Cloud Storage Provider specification.

Appears in:

Field Description
provider string (Required) Provider specifies the cloud provider that will be used. Supported providers: aws, gcp, and azure
bucket string (Required) Storage Bucket Name.
region string (Optional) Region Name.
env EnvVar array (Optional) Environment variables used for connecting to the cloud providers.

Gatling

Gatling is the Schema for the gatlings API

Field Description
apiVersion string gatling-operator.tech.zozo.com/v1alpha1
kind string Gatling
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec GatlingSpec GatlingSpec defines the desired state of Gatling

GatlingSpec

GatlingSpec defines the desired state of Gatling

Appears in:

Field Description
generateReport boolean (Optional) The flag of generating gatling report. Defaults to false
generateLocalReport boolean (Optional) The flag of generating gatling report at each pod
notifyReport boolean (Optional) The flag of notifying gatling report. Defaults to false
cleanupAfterJobDone boolean (Optional) The flag of cleanup gatling resources after the job done. Defaults to false
podSpec PodSpec (Optional) Gatling Pod specification.
cloudStorageSpec CloudStorageSpec (Optional) Cloud Storage Provider specification.
persistentVolume PersistentVolumeSpec (Optional) PersistentVolume specification.
persistentVolumeClaim PersistentVolumeClaimSpec (Optional) PersistentVolumeClaim specification.
notificationServiceSpec NotificationServiceSpec (Optional) Notification Service specification.
testScenarioSpec TestScenarioSpec (Required) Test Scenario specification

NotificationServiceSpec

NotificationServiceSpec defines Notification Service Provider specification.

Appears in:

Field Description
provider string (Required) Provider specifies notification service provider. Supported providers: slack
secretName string (Required) The name of secret in which all key/value sets needed for the notification are stored.

PersistentVolumeClaimSpec

Appears in:

Field Description
name string (Required) The name of the PersistentVolumeClaim.
spec PersistentVolumeClaimSpec (Required) PersistentVolumeClaimSpec is the specification of a persistent volume.

PersistentVolumeSpec

Appears in:

Field Description
name string (Required) The name of the PersistentVolume.
spec PersistentVolumeSpec (Required) PersistentVolumeSpec is the specification of a persistent volume.

PodSpec

PodSpec defines type to configure Gatling Pod specification. For the idea of PodSpec, refer to bitpoke/mysql-operator

Appears in:

Field Description
gatlingImage string (Optional) The image that will be used for Gatling container. Defaults to ghcr.io/st-tech/gatling:latest
rcloneImage string (Optional) The image that will be used for rclone conatiner. Defaults to rclone/rclone:latest
resources ResourceRequirements (Optional) Resources specifies the resource limits of the container.
affinity Affinity (Optional) Affinity specification.
tolerations Toleration array (Optional) Tolerations specification.
serviceAccountName string (Required) ServiceAccountName specification.
volumes Volume array (Optional) volumes specification.
securityContext PodSecurityContext (Optional) SecurityContext specification.
runnerContainerSecurityContext SecurityContext (Optional) RunnerContainerSecurityContext specifies the SecurityContext of the Gatling runner container.

TestScenarioSpec

TestScenarioSpec defines the load testing scenario

Appears in:

Field Description
startTime string (Optional) Test Start time.
parallelism integer (Optional) Number of pods running at the same time. Defaults to 1 (Minimum 1)
simulationsFormat string (Optional) Gatling simulation format, supports bundle and gradle. Defaults to bundle
simulationsDirectoryPath string (Optional) Gatling Resources directory path where simulation files are stored. Defaults to /opt/gatling/user-files/simulations
resourcesDirectoryPath string (Optional) Gatling Simulation directory path where resources are stored. Defaults to /opt/gatling/user-files/resources
resultsDirectoryPath string (Optional) Gatling Results directory path where results are stored. Defaults to /opt/gatling/results
simulationClass string (Required) Simulation Class Name.
simulationData object (keys:string, values:string) (Optional) Simulation Data.
resourceData object (keys:string, values:string) (Optional) Resource Data.
gatlingConf object (keys:string, values:string) (Optional) Gatling Configurations.
env EnvVar array (Optional) Environment variables used for running load testing scenario.
volumeMounts VolumeMount array (Optional) Pod volumes to mount into the container's filesystem.