Example
Here’s a simple configuration for an EC2 agent:alto.yml
Prerequisites
EC2 agents rely on the boto3 and botocore packages. These require you to set up authentication credentials for your AWS account. More information can be found here.You must configure your Boto3 credentials in order to use EC2 agents.
IAM permissions
EC2 agents require your AWS credentials to list, modify, create, and delete certain resources (e.g., key pairs, security groups, EC2 instances, etc.). The specific resources required depend on theprotocol
you use when creating, modifying, and
running your instance.
There are two protocol
options: ssh
, and ssm
. The ssh
protocol manages your
instance via the SSH / SCP protocols, whereas the ssm
protocol manages your instance
via AWS Systems Manager.
You’ll need to make sure your account has the necessary privileges to create resources
for your requested protocol. Contact your account administrator to help out with this.
You can use the following policy document to provision your account with the necessary
permissions:
SSH IAM policy document
SSH IAM policy document
SSM IAM policy document
SSM IAM policy document
Certain IAM permissions are not necessary if you plan on using the SSM protocol
with a pre-existing instance profile. Work with your cloud administrator to provision the necessary
permissions.
Key Specification
The EC2infra
accepts the following keys:
alto.yml
Required keys
type
: this should always beec2
instance_type
: the EC2 instance type. This defaults tot2.micro
. The list of all available EC2 instance types can be found here.ami_image
: the Amazon machine image to use. This defaults toami-0889a44b331db0194
. You should be able to find a list of available AMIs for your region via the AWS console (EC2 >> Images >> AMI Catalog).
Your
ami_image
must be an Amazon Linux AMI. We’re working on adding support for
other Linux-based images (e.g., Debian, Ubuntu, etc.)Optional keys
python_version
: the Python version to use. This is optional. If this isn’t specified, this your code will run using the Python version native to the EC2 instance. The latest version is always used, i.e.,:python_version: 3
—> version3.12.0
is usedpython_version: 3.1
—> version3.1.5
is usedpython_version: 3.11.6
—> version3.11.6
is used
python_version
will be deprecated starting in version 0.0.9
. Instead, users can
customize their Python version using a Docker image, e.g., python:3.10.8-slim-bullseye
.-
protocol
: the protocol to use to modify and manage your instance. Accepted options aressh
andssm
. Defaults tossh
if not specified. -
instance_profile
: instance profile to attach to your EC2 instance if thessm
protocol is used. If not specified, then Alto will create an instance profile for you.