Applies to ReadyAPI 3.4, last modified on October 14, 2020

TestEngine is available on the AWS Marketplace, which allows you to quickly deploy TestEngine in the AWS cloud. This guide explains how you can launch a TestEngine instance from the AWS Marketplace.

TestEngine images

To run TestEngine in the AWS cloud, you can use Linux- or Windows-based image:

Prerequisites

Before deploying TestEngine on AWS, you must have the following:

1. Set up a Virtual Private Cloud (VPC)

A VPC is an isolated network within an Amazon region where you can deploy EC2 instances and host other resources. You have complete control over the VPC configuration, including the IP range, subnets, routing tables, network gateways, and security.

All new AWS accounts include a default VPC in each AWS region. The default VPC comes with a public subnet, meaning that EC2 instances from that subnet will have direct Internet access. VPCs can also have private subnets where instances can connect only to the Internet via NAT and cannot be accessed directly from outside the VPC.

If you don't have a VPC in your preferred AWS region, or if you need a specific VPC configuration, you can create your own VPC and configure it as required. To learn how to create VPCs, see Creating a VPC and Scenarios and Examples in the AWS documentation.

2. Launch TestEngine from AWS Marketplace

  1. Open the AWS Marketplace page for TestEngine:

  2. Click Continue to Subscribe:

    TestEngine plugin in AWS marketplace: Continue to subscribe

    Click the image to enlarge it.

  3. Read the End User License Agreement. Back in AWS, click Accept Terms to continue. Wait a minute or so for the "pending" status to clear:

    TestEngine plugin in AWS marketplace: Accept terms

    Click the image to enlarge it.

  4. Click Continue to Configuration:

    TestEngine plugin in AWS marketplace: Continue to Configuration

    Click the image to enlarge it.

  5. On the Configure this software page, select the AWS Region where you want to launch TestEngine, and click Continue to Launch:

    TestEngine plugin in AWS marketplace: Selecting AWS region for TestEngine

    Click the image to enlarge it.

  6. On the next page, select the following:

    • Choose Action -- Launch from Website (default):

      TestEngine plugin in AWS marketplace: Launch from Website

      Click the image to enlarge it.

    • EC2 Instance Type -- We recommend t2.medium:

      TestEngine plugin in AWS marketplace: EC2 Instance Type

      Click the image to enlarge it.

      You can also use a similar instance type that meets the minimum system requirements:

      • Memory: 4 GB or more
      • CPU: 2 virtual cores
      • Storage: EBS only

      To learn more about instance types and their pricing, see AWS Instance Types and Amazon EC2 Pricing.

    • VPC Settings and Subnet Settings -- Select the VPC and subnet where you want to launch the instance:

      TestEngine plugin in AWS marketplace: VPC and subnet settings

      Click the image to enlarge it.

    • Security Group Settings -- If you have an existing security group with inbound rules for ports 22 (SSH), 80, (HTTP), and 8080 (Custom TCP rule), select that group. Otherwise, click Create New Based on Seller Settings to create a new group with these rules:

      TestEngine plugin in AWS marketplace: Security group with inbound rules for ReadyAPI

      Click the image to enlarge it.

    • Key Pair Settings -- Select a key pair for SSH connections to the instance. If you don't have a key pair, there is an option to create one:

      TestEngine plugin in AWS marketplace: SSH key pair

      Click the image to enlarge it.

      You will need the key pair file later to connect to the created instance.

  7. Click Launch to launch the instance.

  8. Click the EC2 Console link to see your newly launched TestEngine instance in the AWS Console:

    TestEngine plugin in AWS marketplace: Open to EC2 console to see launched instance

    Click the image to enlarge it.

  9. Give your instance a name to make it easier to identify it later. To add a name, click the pencil icon in the Name column:

    Specifying a name for the EC2 instance
  10. Finally, note down the Public DNS address of the instance:

    TestEngine plugin in AWS marketplace: Public DNS address

    Click the image to enlarge it.

3. Initial TestEngine configuration

At this step, you connect to the created instance and install TestEngine. Particular steps depend on your operating system and the instance you run.

  1. Connect to your Windows instance via Remote Desktop Protocol (RDP). In this guide, we will use the Remote Desktop Connection (mstsc.exe) utility built in the Windows operating system. On other operating systems, use its alternatives:

  2. In AWS Console, click Connect:

    TestEngine plugin in AWS marketplace: Connecting to the TestEngine instance

    Click the image to enlarge it.

  3. Set the Connection method to A standalone RDP client.

  4. Click Download Remote Desktop File and save the .RDP file:

    TestEngine plugin in AWS marketplace: Download the .RDP file

    Click the image to enlarge it.

  5. Click Get Password:

    TestEngine plugin in AWS marketplace: Get password

    Click the image to enlarge it.

  6. Click Browse and select a key pair file you specify during the instance creation. Then, click Decrypt Password:

    TestEngine plugin in AWS marketplace: Decrypt password for RDP connection

    Click the image to enlarge it.

  7. Copy the generated password:

    TestEngine plugin in AWS marketplace: Decrypted password for RDP connection

    Click the image to enlarge it.

    Close the dialog.

  8. Open a remote desktop client. Open the Windows Start menu and type mstsc (or use the Search box):

    TestEngine plugin in AWS marketplace: Open remote desktop client

    Click the image to enlarge it.

  9. Click Show Options:

    TestEngine plugin in AWS marketplace: Open remote desktop options
  10. Click Open and select the saved .RDP file. Then, click Connect:

    TestEngine plugin in AWS marketplace: Connect to remote desktop
  11. Use the decrypted password you've got above to connect to the instance.

  12. Open the installation file from the C:\Program Files folder:

    TestEngine plugin in AWS marketplace: Run TestEngine installation

    Click the image to enlarge it.

  13. During the installation, select the Autostart service option:

    TestEngine plugin in AWS marketplace: Select the Autostart Service option

    Click the image to enlarge it.

  14. Select the Set admin password option and specify the password you want. You will use this password to log in to TestEngine for the first time:

    TestEngine plugin in AWS marketplace: Set admin password

    Click the image to enlarge it.

  15. The TestEngine service starts automatically after the installation. Now, you can close the remote desktop connection.

To connect to the Linux instance, use the SSH connection. On the Windows operating system, you can also use PuTTY.

  1. Make sure your key pair file is private.

    How to do it on Linux

    How to do it on Windows

  2. Open Terminal (on Linux) or PowerShell (on Windows) and run the following command:

    ssh -i <your-key-pair.pem> ubuntu@<public-DNS-address>

    You can get the DNS address in the E2 console:

    TestEngine plugin in AWS marketplace: Get public DNS address

    Click the image to enlarge it.

    For example, your command may look like this:

    ssh -i ".\my-key-pair.pem" ubuntu@ec2-52-90-6-242.compute-1.amazonaws.com

  3. After the connection, you will get the headless access to the instance. To install TestEngine, run the following command:

    ./ReadyAPITestEngine-x64-1.13.0.sh -q -Vautostart=true -Vadminpassword=<your password>

    The -Vadminpassword=<your password> argument specifies a password for the default TestEngine account. You will need it to log in to TestEngine for the first time.

  4. The TestEngine service starts automatically after the installation. Now, you can close the remote control of the Linux instance.

4. Connect to TestEngine and install license

  1. Navigate to http://public-DNS-address:8080/login to open TestEngine Web UI.

  2. Use the following credentials to login to TestEngine:

    Username: admin
    Password: a password you specify during the installation

  3. Install your TestEngine license.

After that, you can access TestEngine at http://<public-DNS-address>:8080.

4. Disable the instance metadata service

For security purposes, we recommend that you disable the instance metadata service on your EC2 instance. To do this, use the following command provided by AWS CLI:

aws ec2 modify-instance-metadata-options --instance-id YOUR_INSTANCE_ID --http-endpoint disabled

5. Monitor instance health

AWS provides status checks to monitor the operational status of EC2 instances. You can configure status check alarms to get notified when an issue is detected.

  1. In the EC2 Console, go to Instances.

  2. Select your TestEngine instance and switch to the Status Checks tab at the bottom.

  3. Click Create Status Check Alarm.

  4. Specify the following options:

    • Send a notification to -- the user to send a notification to

    • Whenever -- Status Check Failed (Any)

    • Name of alarm -- enter a unique name for this alarm

    Leave the default values for the other options.

  5. Click Create Alarm.

In addition to status checks, you can configure CloudWatch alarms to monitor the CPU usage and other metrics and get alerted when these metrics reach critical levels. To learn more about using CloudWatch, refer to the CloudWatch documentation.

How to update TestEngine instance

To update TestEngine run on an AWS cloud machine:

  1. Connect to the instance as it is described above.

  2. Update TestEngine as a regular installation.

Next steps

See Also

Installing TestEngine
Administrative Tasks
Run Tests in TestEngine Using Jenkins
Audit Log

Highlight search results