Skip to content
RunsOn
Blog

Stack configuration

The CloudFormation stack that RunsOn creates when installing the service has the following parameters:

GithubOrganization

  • Type: String
  • Description: Name of your GitHub organization. For instance if your GitHub organization lives at https://github.com/my-org, then the value of this parameter should be: my-org.
  • MinLength: 1

LicenseKey

EmailAddress

  • Type: String
  • Description: Email address for cost and alert reports.
  • MinLength: 1

Environment

  • Type: String
  • Description: Environment name. Defaults to production.
  • MinLength: 1

AlertTopicSubscriptionHttpsEndpoint

SSHCidrRange

  • Type: String
  • Default: 0.0.0.0/0
  • Description: CIDR range for SSH access (mainly useful when Private=false). By default, only repository collaborators with admin permission will be able to SSH into the runner instances.
  • MinLength: 1

Private

  • Type: String
  • Default: false
  • AllowedValues:
    • true
    • false
  • Description: Enable (true) or disable (false) private subnets. Note that enabling will create 3 managed NAT gateways, with the corresponding costs.

DefaultAdmins

  • Type: String
  • Default: ""
  • Description: Comma-separated list of GitHub usernames that will always be granted SSH access to all the runner instances (if SSH access is enabled). If blank, only repository collaborators with push permission will be able to SSH into the runner instances.

AppEc2QueueSize

  • Type: Number
  • Default: 2
  • MinValue: 1
  • Description: Rate limit for launching instances, per second. New AWS accounts come with a default of 2 RunInstances call/s, so only increase if you have requested a higher limit from AWS.

AppAlarmDailyMinutes

  • Type: Number
  • Default: 4000
  • Description: Trigger an alarm if the cumulative number of minutes consumed during a day is over that number.

AppCPU

  • Type: Number
  • Default: 256
  • Description: CPU units for RunsOn service (256 or higher). If you have many workflows, you may need to increase this (512, 1024, etc.).

AppMemory

  • Type: Number
  • Default: 512
  • Description: Memory in MB for RunsOn service (512 or higher). If you have many workflows, you may need to increase this (1024, 2048, etc.).

RunnerDefaultDiskSize

  • Type: Number
  • Default: 40
  • MinValue: 40
  • Description: Disk size in GB for default runners.

RunnerDefaultVolumeThroughput

  • Type: Number
  • Default: 400
  • MinValue: 125
  • MaxValue: 1000
  • Description: Volume throughput in MiB/s for default runners (helps with faster boot times, but costs more).

RunnerLargeDiskSize

  • Type: Number
  • Default: 80
  • MinValue: 40
  • Description: Disk size in GB for large runners.

RunnerLargeVolumeThroughput

  • Type: Number
  • Default: 750
  • MinValue: 125
  • MaxValue: 1000
  • Description: Volume throughput in MiB/s for large runners (helps with faster boot times, but costs more).

CostReportsEnabled

  • Type: String
  • Default: true
  • AllowedValues:
    • true
    • false
  • Description: Enable or disable cost reports sent by email.

EC2InstanceCustomPolicy

  • Type: String
  • Default: ""
  • Description: Optional managed IAM Policy ARN to assign to the EC2 runner instances.

ECInstanceDetailedMonitoring

  • Type: String
  • Default: false
  • AllowedValues:
    • true
    • false
  • Description: Enable or disable detailed monitoring for EC2 instances (can incur additional costs).