Updating AWS Runner

This guide explains how to update your AWS runner to ensure you have the latest features, improvements, and security patches. There are three methods to update your runner:

• Automatic Updates: The AWS runner handles most updates automatically with minimal user intervention.
• Updating Infrastructure: For significant changes, manual updates via CloudFormation are required.
• Updating CloudFormation Parameters: Update specific configuration settings through CloudFormation parameters.

Follow the instructions in each section to keep your AWS runner up-to-date and running smoothly.

Automatic Updates

The AWS runner handles most updates automatically. It regularly checks for updates and applies them without user intervention, ensuring it stays current with the latest releases.

Updates include changes to both the runner and the environments:

• The runner ECS task is restarted to apply new changes.
• However, environment updates only apply to new environments. To ensure your environments benefit from the latest updates, regularly delete and recreate them. Doing this once a week should keep your environments up-to-date with the latest improvements and features.

Tip: View the current version of the runner on the runner card under Settings > Runners.

Updating Infrastructure

Certain updates, particularly those involving significant infrastructural changes, cannot be applied automatically. Follow these steps to apply updates:

1. Open the CloudFormation stack used for the runner in the AWS console.

2. Select Update to modify the stack configuration.

3. Select the Replace existing template option and enter the following URL in the Amazon S3 URL field:

   plaintext

   https://gitpod-flex-releases.s3.amazonaws.com/ec2/stable/gitpod-ec2-runner.json

   

4. Review and adjust the parameters as needed.

5. Follow the remaining steps in the wizard to update the stack.

Updating CloudFormation Parameters

To update only the CloudFormation (CF) parameters, such as VPC, subnets, or other configuration settings, follow these steps:

1. Open the CloudFormation stack used for the runner in the AWS console.

2. Select Update to modify the stack configuration.

3. Choose Use existing template when prompted, as shown below:

   

4. Adjust the parameters in the update wizard to reflect the desired changes (e.g., updating VPC or subnet configurations).

5. Complete the remaining steps in the wizard to update the stack.

Expanding Availability Zones

When expanding to additional availability zones, keep in mind that availability is determined by the subnets where your EC2 instances are running. The availability zones parameter helps you identify available subnets, but modifying this parameter alone will not impact availability. Ensure that your subnets are correctly configured to support the desired availability zones.

Use the VPC Resource Map in the AWS console to find subnets corresponding to your desired availability zones.