Deploying Test Run Engine

info

Visit Test Run Engine versions page to view all the available versions of the Test Run Engine.

Environment Variables or Secrets

Pass any secrets or sensitive information as environment variables. This allows you to securely store and utilize credentials such as database credentials, Kafka credentials, or any other secrets required for your tests.

Deployment Options

Local (Docker)

To deploy the Test Run Engine (TRE) locally. Use this if you want to bring your application stack to a local environment or test against public APIs.

warning

Note that resources deployed within a private subnet of a public cloud are not accessible from the locally deployed TRE. Either use a VPC or deploy the TRE directly into your public cloud.

Step 1

Pull the latest version of the TRE image:

docker pull ghcr.io/tesmon-io/tesmon-test-run-engine:latest

Step 2

Run the docker container with the required environment variables:

info

To pass additional environment variables, you can use the -e parameter.

docker run -d --name "tesmon-test-run-engine" \
    -e TESMON_ENVIRONMENT_ID=************** \
    -e TESMON_API_TOKEN=************** \
    ghcr.io/tesmon-io/tesmon-test-run-engine:latest

Property	Description	Required
TESMON_ENVIRONMENT_ID	Environment ID from Environments page	true
TESMON_API_TOKEN	Token from Tokens page	true

Updating

Repeat Step 1 and Step 2 as shown above.

AWS

New Deployment

1. Click the Launch Stack button:
2. Fill out the Parameters section, enter a stack name, and click the checkboxes to acknowledge custom IAM role creation.
3. Click Create Stack.

Once the stack is created, navigate to the Environments page to check if TRE is online.

Updating

caution

Use a specific version of the Test Run Engine package for updates. The latest version tag is not applicable for updates.

1. In AWS console, navigate to Cloudformation > Stacks.
2. Select the stack and click update.
3. Select Use current template and click Next.
4. In the Specify stack details page, enter the version for the TestRunEngineImageVersion parameter and click Next.
5. In the Configure stack options page, do not change anything and click Next.
6. In the Review page, acknowledge and click Submit.