Self-hosted AWS runner
The following is for creating a development environment on a self-hosted runner in AWS. See getting started to understand the benefits compared to Gitpod Desktop.
Steps
Create a runner configuration
To create a runner you must have the role admin in the organization.
To create a runner visit app.gitpod.io and open your organization settings and click runners in the navigation followed by setup an AWS runner.
- A runner is associated with an organization
- An organization can have any number of runners
- Runners are restricted to deploying to a single AWS region
Connect the runner
To connect the runner you must run the CloudFormation template. Ensure you are logged into the correct AWS account and click continue on aws.
If you do not have direct AWS access you can copy the runner details from the configuration page and share with your account admin.
Complete the CloudFormation form. The only required properties are:
- VPC
- Availability zone
- Subnet
If you are unsure, select the default networking options. These should be auto-populated in the form fields. When complete click create stack.
The CloudFormation stack will take around 3 minutes to create.
Configure source control
When complete, return to the runner configurations page and the runner should now be showing as online. You can configure repository access on your runner. Choose a provider such as GitHub and enable OAuth or PAT token access.
You can also (optionally) configure settings on your runner, such as the available classes. An environment class defines the performance profile (such as the CPU and memory available) for the development environment that can be launched on the runner.
Create your development environment
You can create your first environment by clicking create an environment in the navigation bar. Paste a public or private repository URL and click create environment. Then, select an environment class from the runner you deployed.
See AWS Runner for more information.