Release: AWS CloudFormation templates for Private Locations & Packages

.github/workflows/aws-cloudformation-deploy.yaml

@@ -0,0 +1,37 @@
+name: AWS CloudFormation Deploy
+
+on:
+    push:
+      branches:
+        - main
+      paths:
+        - 'aws/cloudformation/**'
+    pull_request:
+      branches:
+        - main
+      paths:
+        - 'aws/cloudformation/**'
+
+jobs:
+  package-and-upload:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up AWS CLI
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.SE_CF_AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.SE_CF_AWS_SECRET_ACCESS_KEY }}
+          aws-region: eu-west-3
+
+      - name: Deploy to S3
+        run: |
+          if [[ "${{ github.event_name }}" == "pull_request" ]]; then
+            S3_BUCKET="dev-${{ vars.SE_CF_S3_BUCKET }}"
+          else
+            S3_BUCKET=${{ vars.SE_CF_S3_BUCKET }}
+          fi
+          aws s3 sync aws/cloudformation/templates s3://$S3_BUCKET --exclude ".git/*" --delete

aws/cloudformation/samples/private-location-package/README.md

@@ -0,0 +1,127 @@
+# Gatling Enterprise Private Locations & Packages CloudFormation Template
+
+This CloudFormation template sets up Gatling Enterprise Private Locations and Packages infrastructure on AWS. It contains nested stacks for the "Private Package", "Location" and "Control Plane" components, which provide network configurations and runtime environment settings for Gatling's Private Locations.
+
+## Prerequisites
+
+Before deploying, ensure you have:
+- A [Gatling Enterprise account](https://auth.gatling.io) with Private Locations enabled.
+- A control plane [token](https://docs.gatling.io/reference/install/cloud/private-locations/introduction/#token).
+- Proper AWS credentials configured.
+
+## Template Structure
+
+The main components in this CloudFormation template are:
+1. **Location**: Specifies the private location for Gatling load generators.
+2. **Control Plane**: Manages configurations, networking, and security for Gatling's control plane.
+
+### Parameters
+
+- **BaseTemplateURL** (required): The root URL for locating the CloudFormation templates. (Use Gatling's official distribution: https://cloudformation-enterprise-templates.s3.eu-west-3.amazonaws.com)
+
+### Resources
+
+#### Location Stack
+
+The Private Package stack defines a secure S3 bucket where private packages are stored.
+
+```sh
+PrivatePackage:
+  Type: AWS::CloudFormation::Stack
+  Properties:
+    TemplateURL: !Sub "${BaseTemplateURL}/private-package/template.yaml"
+    Parameters:
+      Bucket: bucket-name
+```
+
+- `Bucket` (required): Name of the S3 bucket used to store private packages.
+- `Path`: The path within the S3 bucket.
+- `Port`: The server port. (default: 8080)
+- `BindAddress`: The server bind address. (default: 0.0.0.0)
+- `CertPath`: The path to the certificate file. Leave empty if not provided.
+- `CertPassword`: The password for the certificate. Leave empty if not provided.
+
+#### Location Stack
+
+The Location stack defines the private locations where load generators will operate.
+
+```sh
+Location:
+  Type: AWS::CloudFormation::Stack
+  Properties:
+  TemplateURL: !Sub "${BaseTemplateURL}/location/template.yaml"
+  Parameters:
+    Id: "prl_aws"
+    Region: "eu-west-3"
+    SubnetIDs: "subnet-a,subnet-b"
+    SecurityGroupIDs: "sg-id"
+    #Engine: "classic"
+    #InstanceType: "c7i.xlarge"
+```
+
+- `Id`: Identifier for the location. Default is `"prl_aws"`.
+- `Description`: Description of the location.
+- `Region`: AWS region for deployment, specified as `"eu-west-1"`.
+- `SubnetIDs`: string JSON array of subnet IDs (e.g., `"[\"subnet-a\",\"subnet-b\"]"`).
+- `SecurityGroupIDs`: string JSON array of security group IDs to control network access (e.g., `"[\"sg-id\"]"`).
+- `ElasticIPs`: string JSON array of elastic IPs assigned to your location.
+- `InstanceType`: Instance type of the location.
+- `Spot`: Flag to enable spot instances.
+- `AMItype`: AMI type of the location.
+- `engine`: Engine of the location determining the compatible package formats (JavaScript or JVM).
+- `JavaVersion`: Java version of the location.
+- `ProfileName`: Profile name to be assigned to the location.
+- `IAMInstanceProfile`: IAM instance profile to be assigned to the location.
+- `Tags`: Tags to be assigned to the Location.
+- `TagsFor`: Tags to be assigned to the resources of the location.
+- `SystemProperties`: System properties to be assigned on the location.
+- `JvmOptions`: System properties to be assigned to the location.
+- `JavaHome`: Overwrite JAVA_HOME definition.
+- `JvmOptions`: string JSON array to assign JvmOptions to your location.
+
+#### Control Plane Stack
+
+The Control Plane stack configures networking, security, and storage for Gatling's control plane.
+
+```sh
+ControlPlane:
+  Type: AWS::CloudFormation::Stack
+  Properties:
+    TemplateURL: !Sub "${BaseTemplateURL}/control-plane/template.yaml"
+    Parameters:
+      BaseTemplateURL: !Ref BaseTemplateURL
+      Name: "name"
+      TokenSecretARN: "token-secret-arn"
+      SubnetIDs: "subnet-a,subnet-b"
+      SecurityGroupIDs: "sg-id"
+      Locations: !Sub "${Location.Outputs.Conf}"
+      PrivatePackage: !GetAtt PrivatePackage.Outputs.Conf
+      #CloudWatchLogs: "true"
+      #UseECR: "false"
+```
+
+- `BaseTemplateURL` (required): The root URL for locating the CloudFormation templates. (Use Gatling's official distribution: https://cloudformation-enterprise-templates.s3.eu-west-3.amazonaws.com)
+- `Name` (required): The name of the control plane.
+- `Description`: Description of the control plane.
+- `TokenSecretARN` (required): AWS Secrets Manager Plaintext secret ARN of the stored control plane token.
+- `SubnetIDs` (required): List of subnet IDs where the resources will be deployed.
+- `SecurityGroupIDs` (required): List of security group IDs to be used.
+- `Image`: Image of the control plane.
+- `Command`: The command to run in the control-plane container.
+- `Locations` (required): The list of location module(s).
+- `PrivatePackage` (required): The name of the private package stack for configuration.
+- `CloudWatchLogs`: Indicates if CloudWatch Logs are enabled.
+- `UseECR`: Indicates if ECR IAM permissions should be created.
+
+## Deployment Instructions
+
+1. Set up the **BaseTemplateURL** parameter to point to the root URL where your templates are stored.
+3. Adjust your template with your configuration.
+4. Deploy the template using the AWS CloudFormation console or CLI.
+
+```sh
+aws cloudformation deploy --stack-name Gatling-Enterprise-PrivateLocations \
+  --template-file file://path_to_template.yaml \
+  --capabilities CAPABILITY_NAMED_IAM \
+  --parameter-overrides BaseTemplateURL=https://cloudformation-enterprise-templates.s3.eu-west-3.amazonaws.com
+```

aws/cloudformation/samples/private-location-package/sample-private-package-template.yaml

@@ -0,0 +1,45 @@
+AWSTemplateFormatVersion: "2010-09-09"
+Description: Gatling Enterprise Private Locations & Packages Cloudformation Template
+
+Parameters:
+
+  BaseTemplateURL:
+    Type: String
+    Description: The root URL for CloudFormation templates
+    Default: https://{BUCKET-NAME}.s3.eu-west-3.amazonaws.com
+
+Resources:
+
+  PrivatePackage:
+    Type: AWS::CloudFormation::Stack
+    Properties:
+      TemplateURL: !Sub ${BaseTemplateURL}/private-package/template.yaml
+      Parameters:
+        Bucket: bucket-name
+
+  Location:
+    Type: AWS::CloudFormation::Stack
+    Properties:
+      TemplateURL: !Sub ${BaseTemplateURL}/location/template.yaml
+      Parameters:
+        Id: "prl_aws"
+        Region: "eu-west-1"
+        SubnetIDs: "[\"subnet-a\",\"subnet-b\",\"subnet-c\"]"   #JSON string
+        SecurityGroupIDs: "[\"sg-id\"]"   #JSON string
+        #Engine: "classic"
+        #InstanceType: "c7i.xlarge"
+
+  ControlPlane:
+    Type: AWS::CloudFormation::Stack
+    Properties:
+      TemplateURL: !Sub ${BaseTemplateURL}/control-plane/template.yaml
+      Parameters:
+        BaseTemplateURL: !Ref BaseTemplateURL
+        Name: "gatling-cp"
+        TokenSecretARN: "token-secret-arn"
+        SubnetIDs: "subnet-a,subnet-b,subnet-c"
+        SecurityGroupIDs: "sg-id"
+        Locations: !Sub "${Location.Outputs.Conf}"
+        PrivatePackage: !GetAtt PrivatePackage.Outputs.Conf
+        #CloudWatchLogs: "true"
+        #UseECR: "false"

aws/cloudformation/samples/private-location/README.md

@@ -0,0 +1,104 @@
+# Gatling Enterprise Private Locations & Packages CloudFormation Template
+
+This CloudFormation template sets up Gatling Enterprise Private Locations infrastructure on AWS. It contains nested stacks for the "Location" and "Control Plane" components, which provide network configurations and runtime environment settings for Gatling's Private Locations.
+
+## Prerequisites
+
+Before deploying, ensure you have:
+- A [Gatling Enterprise account](https://auth.gatling.io) with Private Locations enabled.
+- A control plane [token](https://docs.gatling.io/reference/install/cloud/private-locations/introduction/#token).
+- Proper AWS credentials configured.
+
+## Template Structure
+
+The main components in this CloudFormation template are:
+1. **Location**: Specifies the private location for Gatling load generators.
+2. **Control Plane**: Manages configurations, networking, and security for Gatling's control plane.
+
+### Parameters
+
+- **BaseTemplateURL** (required): The root URL for locating the CloudFormation templates. (Use Gatling's official distribution: https://cloudformation-enterprise-templates.s3.eu-west-3.amazonaws.com)
+
+### Resources
+
+#### Location Stack
+
+The Location stack defines the private locations where load generators will operate.
+
+```sh
+Location:
+  Type: AWS::CloudFormation::Stack
+  Properties:
+    TemplateURL: !Sub ${BaseTemplateURL}/location/template.yaml
+    Parameters:
+      Id: "prl_aws"
+      Region: "eu-west-3"
+      SubnetIDs: "[\"subnet-a\",\"subnet-b\"]"
+      SecurityGroupIDs: "[\"sg-id\"]"
+      #Engine: "classic"
+      #InstanceType: "c7i.xlarge"
+```
+
+- `Id`: Identifier for the location. Default is `"prl_aws"`.
+- `Description`: Description of the location.
+- `Region`: AWS region for deployment, specified as `"eu-west-1"`.
+- `SubnetIDs`: string JSON array of subnet IDs (e.g., `"[\"subnet-a\",\"subnet-b\"]"`).
+- `SecurityGroupIDs`: string JSON array of security group IDs to control network access (e.g., `"[\"sg-id\"]"`).
+- `ElasticIPs`: string JSON array of elastic IPs assigned to your location.
+- `InstanceType`: Instance type of the location.
+- `Spot`: Flag to enable spot instances.
+- `AMItype`: AMI type of the location.
+- `engine`: Engine of the location determining the compatible package formats (JavaScript or JVM).
+- `JavaVersion`: Java version of the location.
+- `ProfileName`: Profile name to be assigned to the location.
+- `IAMInstanceProfile`: IAM instance profile to be assigned to the location.
+- `Tags`: Tags to be assigned to the Location.
+- `TagsFor`: Tags to be assigned to the resources of the location.
+- `SystemProperties`: System properties to be assigned on the location.
+- `JvmOptions`: System properties to be assigned to the location.
+- `JavaHome`: Overwrite JAVA_HOME definition.
+- `JvmOptions`: string JSON array to assign JvmOptions to your location.
+
+#### Control Plane Stack
+
+The Control Plane stack configures networking, security, and storage for Gatling's control plane.
+
+```sh
+ControlPlane:
+  Type: AWS::CloudFormation::Stack
+  Properties:
+    TemplateURL: !Sub "${BaseTemplateURL}/control-plane/template.yaml"
+    Parameters:
+      BaseTemplateURL: !Ref BaseTemplateURL
+      Name: "name"
+      TokenSecretARN: "token-secret-arn"
+      SubnetIDs: "subnet-a,subnet-b"
+      SecurityGroupIDs: "sg-id"
+      Locations: !Sub "${Location.Outputs.Conf}"
+      #CloudWatchLogs: "true"
+      #UseECR: "false"
+```
+- `BaseTemplateURL` (required): The root URL for locating the CloudFormation templates. (Use Gatling's official distribution: https://cloudformation-enterprise-templates.s3.eu-west-3.amazonaws.com)
+- `Name` (required): The name of the control plane.
+- `Description`: Description of the control plane.
+- `TokenSecretARN` (required): AWS Secrets Manager Plaintext secret ARN of the stored control plane token.
+- `SubnetIDs` (required): List of subnet IDs where the resources will be deployed.
+- `SecurityGroupIDs` (required): List of security group IDs to be used.
+- `Image`: Image of the control plane.
+- `Command`: The command to run in the control-plane container.
+- `Locations` (required): The list of location module(s).
+- `CloudWatchLogs`: Indicates if CloudWatch Logs are enabled.
+- `UseECR`: Indicates if ECR IAM permissions should be created.
+
+## Deployment Instructions
+
+1. Set up the **BaseTemplateURL** parameter to point to the root URL where your templates are stored.
+3. Adjust your template with your configuration.
+4. Deploy the template using the AWS CloudFormation console or CLI.
+
+```sh
+aws cloudformation deploy --stack-name Gatling-Enterprise-PrivateLocations \
+  --template-file file://path_to_template.yaml \
+  --capabilities CAPABILITY_NAMED_IAM \
+  --parameter-overrides BaseTemplateURL=https://cloudformation-enterprise-templates.s3.eu-west-3.amazonaws.com
+```

aws/cloudformation/samples/private-location/sample-private-location-template.yaml

@@ -0,0 +1,37 @@
+AWSTemplateFormatVersion: "2010-09-09"
+Description: Gatling Enterprise Private Locations & Packages Cloudformation Template
+
+Parameters:
+
+  BaseTemplateURL:
+    Type: String
+    Description: The root URL for CloudFormation templates
+    Default: https://{BUCKET-NAME}.s3.eu-west-3.amazonaws.com
+
+Resources:
+
+  Location:
+    Type: AWS::CloudFormation::Stack
+    Properties:
+      TemplateURL: !Sub ${BaseTemplateURL}/location/template.yaml
+      Parameters:
+        Id: "prl_aws"
+        Region: "eu-west-1"
+        SubnetIDs: "[\"subnet-a\",\"subnet-b\",\"subnet-c\"]"   #JSON string
+        SecurityGroupIDs: "[\"sg-id\"]"   #JSON string
+        #Engine: "classic"
+        #InstanceType: "c7i.xlarge"
+
+  ControlPlane:
+    Type: AWS::CloudFormation::Stack
+    Properties:
+      TemplateURL: !Sub ${BaseTemplateURL}/control-plane/template.yaml
+      Parameters:
+        BaseTemplateURL: !Ref BaseTemplateURL
+        Name: "gatling-cp"
+        TokenSecretARN: "token-secret-arn"
+        SubnetIDs: "subnet-a,subnet-b,subnet-c"
+        SecurityGroupIDs: "sg-id"
+        Locations: !Sub "${Location.Outputs.Conf}"
+        #CloudWatchLogs: "true"
+        #UseECR: "false"