Trusted Runtime Deployment Guide

---

Overview

This document describes how to deploy the Testany Trusted Runtime on cloud infrastructure.

Download Deployment Package

Before starting deployment, please download the deployment package:

Download AWS Deployment Package

The deployment script automatically completes the following tasks:

1. Deploy cloud infrastructure (VPC, Kubernetes cluster, database, cache, object storage)
2. Configure kubectl to connect to the cluster
3. Render and deploy Helm Charts
4. Register with the Testany SaaS platform
5. Configure Ingress and TLS certificates

Estimated deployment time: 30-45 minutes (excluding DNS configuration wait time)

---

Prerequisites

Tool Dependencies

Before starting deployment, ensure the following tools are installed and available:

Core Tools (Required)

Deployment Script Dependencies (Required)

Cloud Platform Permissions - AWS

Ensure AWS credentials are configured with the following permissions:

• VPC: Create/manage VPC, subnets, route tables, NAT Gateway, Internet Gateway
• EKS: Create/manage EKS clusters, node groups
• RDS: Create/manage RDS instances
• ElastiCache: Create/manage ElastiCache clusters
• S3: Create/manage S3 buckets
• IAM: Create IAM roles and policies required for EKS
• EC2: Create security groups, manage EC2 resources

Testany Provided Credentials

Before deployment, contact the Testany support team to obtain the following information:

---

Configuration

Configure Terraform Variables

BashCopy
# Enter the Terraform directory
cd aws/terraform

# Copy the example configuration file
cp terraform.tfvars.example terraform.tfvars

# Edit the configuration file
vi terraform.tfvars

Required Configuration Items

HCLCopy
# AWS Region
aws_region = "us-west-2"

# Project name (used for all resource naming)
project_name = "testany"

# === Testany Provided Credentials (Required) ===
ecr_registry              = "123456789012.dkr.ecr.us-west-2.amazonaws.com/testany"
testany_secrets_region    = "us-west-2"
testany_secrets_name      = "testany/customers/YOUR_CUSTOMER_ID/appsecrets"
testany_saas_endpoint     = "tr.testany.com"

---

Installation

AWS

Step 1: Set AWS Profile (if needed)

BashCopy
export AWS_PROFILE=your-profile-name

Step 2: Set Testany Credential Environment Variables

BashCopy
export TF_VAR_testany_access_key_id="AKIAXXXXXXXXXXXXXXXXXX"
export TF_VAR_testany_secret_access_key="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Step 3: Execute Installation Script

BashCopy
cd scripts
bash install.sh

The script automatically executes the following steps:

1. [Automatic] Check prerequisites
2. [Automatic] Deploy AWS infrastructure (approximately 15-20 minutes)
3. [Automatic] Configure kubectl
4. [Automatic] Render Helm templates
5. [Automatic] Deploy base components
6. [User Action Required] Bootstrap registration
7. [Automatic] Deploy application services
8. [Automatic] Configure Ingress
9. [Waiting for User] Create TLS certificates

Bootstrap Registration Process

When the script reaches the Bootstrap registration step, it will pause waiting for user confirmation.

1. Get Registration Code: After pressing Enter, the command line will display the registration code:

2. Log in to SaaS Management Platform: Log in to the Testany SaaS management interface using the global administrator account

3. Enter Registration Code: Find the Runtime registration entry in the SaaS management interface and enter the registration code displayed in the command line

4. Set Runtime Name: Set an easily identifiable name for this new Runtime instance

5. Complete Registration: After the administrator confirms on the SaaS platform, the command line script will automatically continue

DNS Configuration

The script will pause at the certificate creation step, prompting you to configure DNS.

1. Get the Ingress Load Balancer address:

   BashCopy
   kubectl get ingress -n testany-app

2. Contact the Testany support team, provide the Load Balancer address, and complete DNS configuration

3. Verify DNS resolution:

   BashCopy
   nslookup your-domain.testany.com

4. After DNS configuration is complete, press Enter to continue the script and create TLS certificates

---

Installation Verification

After completing the installation, verify the deployment through the following steps.

AWS Secrets Data Preparation

1. Get the Secrets Manager service endpoint address:

   Region	Endpoint
   AWS Global	Refer to AWS Documentation ↗
   AWS China (Ningxia)	secretsmanager.cn-northwest-1.amazonaws.com.cn
   AWS China (Beijing)	secretsmanager.cn-north-1.amazonaws.com.cn

2. Create a Secret. In the Secrets Manager console, click "Store a new secret":

   

3. Select "Other type of secret", enter 123 in Plaintext (can be any content), and click "Next":

   

4. Enter testany-env-secret-test-YOUR_ACCOUNT_ID in Secret name, and click "Next":

   

5. Keep the default configuration and click "Next":

   

6. Confirm the information and click "Store":

   

Method 1: UI Operations

Suitable for users who need to understand the configuration process in detail.

1. Create Credential Safe and Credential

1. Access the Workspace Settings page, click "Workspace Settings" in the bottom left corner, click the "Credential" tab in the right panel, select the newly registered Runtime, and click the "Add credential safe" button:

2. Fill in Credential Safe information:
   • Instance name: Set a name
   • Instance URL: Secrets management access address (based on your cloud deployment, enter Key Vault access address or AWS Secrets Manager access address)

3. After creation, expand the Credential Safe:

4. Click "+" to add a Credential (if you don't see "+" after expanding, refresh the page):

5. Fill in Credential information:
   • Credential name: Set a name
   • Type: Select the corresponding type
   • Key: The secret name in Secrets management (e.g., testany-env-secret-test)

6. After saving, record the following information (needed when configuring Cases later):
   • Credential Safe Key (e.g., WKS-CS-0001)
   • Credential Key (e.g., testany-env-secret-test)

2. Create Cases

Case 1: Test Environment Variable Passing

1. Log in to Testany, select "Test Case Library", and click "Register Test Case":

2. Enter Case information:

   • Name: testany-deploy-check-case1
   • Runtime: Select the newly registered Runtime

   Click "Register & Next":

3. On the redirected page, click the "JSON" tab:

4. Paste the environment variable configuration into the editor and click "Save Changes":

JSONCopy
[
  {"name": "URL", "value": "www.baidu.com", "type": "env"},
  {"name": "RELAY_NEW_URL", "value": "www.bing.com", "type": "env"},
  {"name": "AAA", "value": "-", "type": "output"},
  {"name": "NEW_URL", "value": "-", "type": "output"}
]

5. Prepare code file, compress testany-env-check-case1-postman.json to a zip file:

6. Click the "Upload" icon to upload code:

7. Select the zip file to complete upload:

8. Wait for upload to complete:

9. Select Executor as postman:

10. Set Trigger path to testany-env-check-case1-postman.json:

Case 2: Test Secrets Retrieval

1. Register a new Case, click "Register Test Case":

2. Enter Case information:
   • Name: testany-deploy-check-case2
   • Runtime: Select the newly registered Runtime

3. On the redirected page, click the "JSON" tab:

4. Paste the environment variable configuration into the editor:

JSONCopy
[
  {"name": "AAA", "value": "-", "type": "env"},
  {"name": "URL", "value": "-", "type": "env"},
  {"name": "SAFE_KEY", "value": "WKS-CS-0001", "type": "env"},
  {"name": "KEY", "value": "testany-env-secret-test", "type": "env"}
]

5. Switch to Form view and modify the "SAFE_KEY" value to the actual Credential Safe Key:

6. Prepare code file, compress testany-env-check-case2-postman.json to a zip file:

7. Click the "Upload" icon to upload code:

8. Select the zip file to complete upload:

9. Wait for upload to complete:

10. Select Executor as postman:

11. Set Trigger path to testany-env-check-case2-postman.json:

12. Configure the credential reference: add a Secret row under the case Environment variables, then select the created Credential Safe and Credential:

13. Case 2 creation complete, check details to confirm configuration:

3. Create Pipeline

1. Switch to the Workspace page, click "+ Assemble pipeline", and enter Pipeline information:
   • Name: deploy-test-pipeline
   • Description: Test newly deployed Runtime

2. Click the expand button:

3. Select "YAML View" and configure Pipeline rules:

YAMLCopy
kind: rule/v1.3
spec:
  rules:
    - run: 'CASE1_KEY'
    - run: 'CASE2_KEY'
      whenPassed: 'CASE1_KEY'
      relay:
        - key: AAA
          refKey: CASE1_KEY/AAA
          nonSecret: true
        - key: URL
          refKey: CASE1_KEY/NEW_URL
          nonSecret: true

4. Refresh the Pipeline page and click the "Trigger" button to execute the Pipeline:

4. View Execution Results

1. View Pipeline execution status:

2. Click the "View log" button for Case 2 to view execution logs:

3. Verify Case 1 information is passed to Case 2:
   • AAA value should display 200 (HTTP status code)

• URL value should be http://www.bing.com

4. Verify Secrets are retrieved correctly:
   • Returned secret length should be 3 (length of value 123)

Method 2: Script Operations

Suitable for users who want to quickly verify deployment.

1. Locate Script Directory

The verification script is included in the deployment package, located in the deploy-checker directory:

deploy-checker
├── linux
│   ├── env.txt
│   └── register.sh
├── windows
│   ├── env.txt
│   └── register.ps1
├── requirements.txt
├── testany-env-check-case1-postman.json.zip
├── testany-env-check-case2-postman.json.zip
└── tr_deploy_check.py

2. Configure Environment Variables

Linux/macOS:

BashCopy
export BASE_URL=YOUR_SAAS_URL
export RUNTIME_UUID=YOUR_RUNTIME_UUID
export WORKSPACE_KEY=AAA
export ACCESS_TOKEN=XXXXXXXXXXX
export KEY_VAULT_URL=https://xxx.vault.azure.cn

Windows (PowerShell):

PowerShellCopy
$env:BASE_URL="YOUR_SAAS_URL"
$env:RUNTIME_UUID="YOUR_RUNTIME_UUID"
$env:WORKSPACE_KEY="AAA"
$env:ACCESS_TOKEN="XXXXXXXXXXX"
$env:KEY_VAULT_URL="https://xxx.vault.azure.cn"

3. Execute Script

Linux/macOS:

BashCopy
cd linux
bash register.sh

Windows:

PowerShellCopy
cd windows
.\register.ps1

After execution, the console will output:

********************************************************************************
All Related information:
Credential Safe Key: XXX-CS-XXXX
Credential Key: testany-env-secret-test
Case 1 Key: XXXXXXXX
Case 2 Key: XXXXXXXX
Pipeline Key: XXX-XXXXX
********************************************************************************

4. Trigger Pipeline Verification

1. Find the newly created Pipeline in the Testany interface (naming convention: runtime-<runtime-name>-deploy-check) and click the "Trigger" button:

2. View execution status:

3. Wait for execution to complete:

4. Click the "View log" button for Case 2 to view execution logs:

5. Verify AAA value is 200:

6. Verify URL value is http://www.bing.com:

7. Verify Secret length is 3:

---

Contact Support

If you encounter issues that cannot be resolved, please contact the Testany support team:

• Email: [email protected]
• Documentation: https://docs.testany.io ↗