runs-on

This component is responsible for provisioning an RunsOn (https://runs-on.com/).

After deploying this component, you will need to install the RunsOn app to GitHub. See the RunsOn documentation for more information.

Usage

Stack Level: Regional

The following is an example snippet for how to use this component:

(runs-on.yaml)

import:
  - orgs/acme/core/auto/_defaults
  - mixins/region/us-east-1

components:
  terraform:
    runs-on:
      metadata:
        component: runs-on
      vars:
        name: runs-on
        enabled: true
        capabilities: ["CAPABILITY_IAM"]
        on_failure: "ROLLBACK"
        timeout_in_minutes: 30
        template_url: https://runs-on.s3.eu-west-1.amazonaws.com/cloudformation/template.yaml
        parameters:
          AppCPU: 512
          AppMemory: 1024
          EmailAddress: [email protected]
          Environment: core-auto
          GithubOrganization: ACME
          LicenseKey: <LICENSE>
          Private: always # always | true | false - Always will default place in private subnet, true will place in private subnet if tag `private=true` present on workflow, false will place in public subnet
          VpcCidrBlock: 10.100.0.0/16

Setting up with Transit Gateway

This assumes you are using the Cloud Posse Components for Transit Gateway (tgw/hub & tgw/spoke).

The outputs of this component contain the same outputs as the vpc component. This is because the runs-on cloudformation stack creates a VPC and subnets.

First we need to update the TGW/Hub - this stores information about the VPCs that are allowed to be used by TGW Spokes.

Assuming your TGW/Hub lives in the core-network account and your Runs-On is deployed to core-auto (tgw-hub.yaml)

vars:
  connections:
    - account:
        tenant: core
        stage: auto
      vpc_component_names:
        - vpc
        - runs-on

components:
terraform:
  tgw/hub/defaults:
    metadata:
      type: abstract
      component: tgw/hub
    vars:
      enabled: true
      name: tgw-hub
      tags:
        Team: sre
        Service: tgw-hub

  tgw/hub:
    metadata:
      inherits:
        - tgw/hub/defaults
      component: tgw/hub
    vars:
      connections:
        - account:
            tenant: core
            stage: network
        - account:
            tenant: core
            stage: auto
          vpc_component_names:
            - vpc
            - runs-on
        - account:
            tenant: plat
            stage: sandbox
        - account:
            tenant: plat
            stage: dev
        - account:
            tenant: plat
            stage: staging
        - account:
            tenant: plat
            stage: prod

We then need to create a spoke that refers to the VPC created by Runs-On.

(tgw-spoke.yaml)

tgw/spoke/runs-on:
  metadata:
    component: tgw/spoke
    inherits:
      - tgw/spoke-defaults
  vars:
    own_vpc_component_name: runs-on
    attributes:
      - "runs-on"
    connections:
      - account:
          tenant: core
          stage: network
      - account:
          tenant: core
          stage: auto
        vpc_component_names:
          - vpc
          - runs-on
      - account:
          tenant: plat
          stage: sandbox
      - account:
          tenant: plat
          stage: dev
      - account:
          tenant: plat
          stage: staging
      - account:
          tenant: plat
          stage: prod

Finally we need to update the spokes of the TGW/Spokes to allow Runs-On traffic to the other accounts.

Typically this includes core-auto, core-network, and your platform accounts.

(tgw-spoke.yaml)

  tgw/spoke:
    metadata:
      inherits:
        - tgw/spoke-defaults
    vars:
      connections:
        ...
            vpc_component_names:
              - vpc
              - runs-on
        ...

Variables

Required Variables

region (string) required

AWS Region

template_url (string) required

Amazon S3 bucket URL location of a file containing the CloudFormation template body. Maximum file size: 460,800 bytes

Optional Variables

capabilities (list(string)) optional

A list of capabilities. Valid values: CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND

Default value: [ ]

on_failure (string) optional

Action to be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE

Default value: "ROLLBACK"

parameters (map(string)) optional

Key-value map of input parameters for the Stack Set template. (e.g. map("BusinessUnit","ABC")

Default value: { }

policy_body (string) optional

Structure containing the stack policy body

Default value: ""

timeout_in_minutes (number) optional

The amount of time that can pass before the stack status becomes CREATE_FAILED

Default value: 30

vpc_peering_component optional

The component name of the VPC Peering Connection

Type:

object({
component   = string
environment = optional(string)
tenant      = optional(string)
stage       = optional(string)
})

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

id

ID of the CloudFormation Stack

name

Name of the CloudFormation Stack

nat_gateway_ids

NAT Gateway IDs

nat_instance_ids

NAT Instance IDs

outputs

Outputs of the CloudFormation Stack

private_route_table_ids

Private subnet route table IDs

private_subnet_ids

Private subnet IDs

public_subnet_ids

Public subnet IDs

vpc_cidr

CIDR of the VPC created by RunsOn CloudFormation Stack

vpc_id

ID of the VPC created by RunsOn CloudFormation Stack

Dependencies

Requirements

• terraform, version: >= 1.0.0
• aws, version: >= 4.9.0

Providers

• aws, version: >= 4.9.0

Modules

Name	Version	Source	Description
cloudformation_stack	v0.7.1	cloudposse/cloudformation-stack/aws	n/a
iam_policy	v2.0.1	cloudposse/iam-policy/aws	n/a
iam_roles	latest	../account-map/modules/iam-roles	n/a
this	0.25.0	cloudposse/label/null	n/a
vpc	1.5.0	cloudposse/stack-config/yaml//modules/remote-state	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

• aws_nat_gateways.ngws (data source)

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component