Module: `github-action-token-rotator`

This module deploys a lambda function that runs as a GitHub Application and periodically gets a new GitHub Runner Registration Token from the GitHub API. This token is then stored in AWS Systems Manager Parameter Store.

Usage

module "github_action_token_rotator" {
    source = "cloudposse/github-action-token-rotator/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"
    parameter_store_token_path       = "/github/runners/cloudposse/registrationToken"
    parameter_store_private_key_path = "/github/runners/cloudposse/privateKey"
    github_app_id                    = "111111"
    github_app_installation_id       = "22222222"
    github_org                       = "cloudposse"
}

Quick Start

Browse to https://github.com/organizations/\{YOUR_ORG\}/settings/apps and click the New GitHub App button
Set the name to "GitHub Action Token Rotator"
Set the Homepage URL to https://github.com/cloudposse/lambda-github-action-token-rotator
Uncheck the Active checkbox under the Webhook heading
Select Read and write under Organization permissions -> Self-hosted runners
Click the Create GitHub App button at the bottom of the page
Under the Client secrets section, click the Generate a new client secret button
Copy the Client secret to a safe place, it will be needed to install the app
Under the Private key section, click the Generate a private key button
Download the private key to a safe place, it will be needed to install the app
Convert the private key to a PEM file using the following command: openssl pkcs8 -topk8 -inform PEM -outform PEM -nocrypt -in {DOWNLOADED_FILE_NAME}.pem -out private-key-pkcs8.key
Base64 encode the private key using the following command: cat private-key-pkcs8.key | base64
Copy the Base64 value to AWS SSM Parameter store at /github/runners/${YOUR_GITHUB_ORG}/privateKey

Variables

Required Variables

github_app_id (string) required: GitHub App ID
github_app_installation_id (string) required: GitHub App Installation ID
github_org (string) required: GitHub Organization
parameter_store_private_key_path (string) required: Path to read the GitHub App private key from parameter store
parameter_store_token_path (string) required: Path to store the token in parameter store

Optional Variables

function_description (string) optional

Default value: "An app that automatically rotates the GitHub Action Runner token and stores it in SSM Parameter Store"

function_name (string) optional

Default value: "GitHubRunnerTokenRotator"

lambda_zip_version (string) optional

The version of the Lambda function to deploy

Default value: "0.1.0"

memory_size (number) optional

Amount of memory in MB the Lambda Function can use at runtime.

Default value: 512

schedule_expression (string) optional

AWS Schedule Expression: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html

Default value: "rate(30 minutes)"

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

arn: ARN of the lambda function
function_name: Lambda function name
invoke_arn: Invoke ARN of the lambda function
qualified_arn: ARN identifying your Lambda Function Version (if versioning is enabled via publish = true)
role_arn: Lambda IAM role ARN
role_name: Lambda IAM role name

Dependencies

Requirements

terraform, version: >= 1.0
random, version: >= 2.2

Providers

aws

Modules

Name	Version	Source	Description
`label`	0.25.0	`cloudposse/label/null`	n/a
`lambda`	0.3.2	`cloudposse/lambda-function/aws`	n/a
`parameter_store_private_key`	0.10.0	`cloudposse/ssm-parameter-store/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`utils`	latest	`cloudposse/utils/aws`	n/a

Resources

The following resources are used by this module:

aws_cloudwatch_event_rule.this (resource)
aws_cloudwatch_event_target.this (resource)
aws_iam_policy.allow_ssm_parameter_store (resource)
aws_iam_role_policy_attachment.this (resource)
aws_lambda_permission.this (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.this (data source)
aws_iam_policy_document.allow_ssm_parameter_store (data source)
aws_region.this (data source)

Module: github-action-token-rotator

Usage​

Quick Start​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `github-action-token-rotator`

Usage

Quick Start

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources