ubergeek77/AWS EC2 Spot Runner

Create temporary GitHub Actions Runners on AWS EC2 Spot Instances

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
aws-access-key-idYour AWS Access Key IDyes
aws-default-regionThe default AWS Region, needed for the CLIus-east-2
aws-secret-access-keyYour AWS Secret Access Keyyes
dry-runWhether or not do do a dry run (pretends to set up a runner but does not interact with AWS)false
ec2-amiThe ID of the AMI to use for the EC2 Spot Instanceami-05fb0b8c1424f266b
ec2-instance-typeThe EC2 Instance Type to use for the EC2 Spot Instancec5d.large
ec2-keypair-nameThe name of the pre-existing AWS keypair to use for the EC2 Spot Instance
ec2-security-group-idThe pre-existing Security Group ID to use for the EC2 Spot Instance
ec2-timeoutThe number of seconds to wait before terminating the instance3600
ec2-zoneThe AWS EC2 Zone to deploy the Spot Instance tous-east-2a
ephemeralIf 'true', will unregister the runner after it runs a single jobtrue
github-organizationIf set, the GitHub Organization to attach the runner to (if NOT deploying to a GitHub github-Organization, use 'github-repo' instead!)
github-repoThe repo to deploy the runner for; just pass through github.repository (if deploying to a GitHub Organization, use 'github-organization' instead!)
github-tokenYour GitHub Access Token with the 'repo' scope (repos) or 'admin:org' scope (Orgs). Must be a 'classic' token.
runner-archThe architecture to use for the runner ('x64', 'arm', or 'arm64')x64
runner-versionThe version of the GitHub Actions runner to uselatest
shutdown-labelThe label of the runner to shut down
vm-userThe username of the non-root user in the VMubuntu
volume-nameThe name of the block device to provision. To mount on '/', this must match the AMI's root volume name!/dev/sda1
volume-sizeThe size, in GiBs, that 'volume-name' should be32
namedescription
labelThe label of the temporary runner that was just deployed