AWS Lightsail Driver

Preevy can provision virtual machines on AWS Lightsail using the lightsail driver. AWS lightsail is Amazon's cost-effective solution for VMs in the cloud. AWS lightsail provisioning time for a VM is usually around 2 minutes, and its cost can be as low as $3.50 per month making them suitable for preview environments at scale.

Supported options

option	flag	description	required	default
region	--lightsail-region	AWS region in which resources will be provisioned	required	(none)
bundle-id	--lightsail-bundle-id	Lightsail bundle ID (size of instance) to provision	optional	medium_2_0
availability-zone	--lightsail-availability-zone	AWS zone to provision resources in region	optional	(first AZ in zone)

Overriding options

Similar to other drivers, options are saved in the Preevy profile to be used as default values for all operations.

Options can be overridden for a specific compose file by adding them to the x-preevy section:

services:
  ...
x-preevy:
  driver: lightsail
  drivers:
    lightsail:
      # use a larger instance for this project
      bundle-id: xlarge_2_0

Options can also be overridden using a CLI flag per command execution:

preevy up ---lightsail-bundle-id=xlarge_2_0

Credentials Configuration

Preevy uses the AWS JS SDK which supports multiple ways of configuring credentials, according to the credentials provider chain. The simplest way is to use aws configure command or to set the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

In GitHub Actions, you can also use the aws-actions/configure-aws-credentials action to set up credentials in a secure way.

Also, you can check out the video below for a step-by-step guide on how to configure AWS credentials and use them with Preevy.

Required AWS permissions

Preevy requires the following IAM policy to be able to provision and manage Lightsail VMs:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "lightsail:*",
      "Resource": "*"
    }
  ]
}

note

When defining fine-grained permissions for Preevy, make sure to add S3 permissions as well when using s3 as a profile store. We recommend scoping the permissions to a specific bucket and prefix:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "s3:ListBucket",
        "s3:GetBucketLocation",
        "s3:PutObject",
        "s3:GetObject",
        "s3:DeleteObject",
        "s3:CreateBucket"
      ],
      "Resource": ["arn:aws:s3:::MY_BUCKET", "arn:aws:s3:::MY_BUCKET/*"]
    }
  ]
}