Skip to main content

Component: github-oidc-role

This component is responsible for creating IAM roles for GitHub Actions to assume.

Usage

Stack Level: Global

Here's an example snippet for how to use this component.

# stacks/catalog/github-oidc-role/defaults.yaml
components:
terraform:
github-oidc-role/defaults:
metadata:
type: abstract
vars:
enabled: true
name: gha-iam
# Note: inherited lists are not merged, they are replaced
github_actions_allowed_repos:
- MyOrg/* ## allow all repos in MyOrg

Example using for gitops (predefined policy):

# stacks/catalog/github-oidc-role/gitops.yaml
import:
- catalog/github-oidc-role/defaults

components:
terraform:
github-oidc-role/gitops:
metadata:
component: github-oidc-role
inherits:
- github-oidc-role/defaults
vars:
enabled: true
# Note: inherited lists are not merged, they are replaced
github_actions_allowed_repos:
- "MyOrg/infrastructure"
attributes: [ "gitops" ]
iam_policies:
- gitops
gitops_policy_configuration:
s3_bucket_component_name: gitops/s3-bucket
dynamodb_component_name: gitops/dynamodb

Example using for lambda-cicd (predefined policy):

# stacks/catalog/github-oidc-role/lambda-cicd.yaml
import:
- catalog/github-oidc-role/defaults

components:
terraform:
github-oidc-role/lambda-cicd:
metadata:
component: github-oidc-role
inherits:
- github-oidc-role/defaults
vars:
enabled: true
github_actions_allowed_repos:
- MyOrg/example-app-on-lambda-with-gha
attributes: [ "lambda-cicd" ]
iam_policies:
- lambda-cicd
lambda_cicd_policy_configuration:
enable_ssm_access: true
enable_s3_access: true
s3_bucket_component_name: s3-bucket/github-action-artifacts
s3_bucket_environment_name: gbl
s3_bucket_stage_name: artifacts
s3_bucket_tenant_name: core

Example Using an AWS Managed policy and a custom inline policy:

# stacks/catalog/github-oidc-role/custom.yaml
import:
- catalog/github-oidc-role/defaults

components:
terraform:
github-oidc-role/custom:
metadata:
component: github-oidc-role
inherits:
- github-oidc-role/defaults
vars:
enabled: true
github_actions_allowed_repos:
- MyOrg/example-app-on-lambda-with-gha
attributes: [ "custom" ]
iam_policies:
- arn:aws:iam::aws:policy/AdministratorAccess
iam_policy:
- version: "2012-10-17"
statements:
- effect: "Allow"
actions:
- "ec2:*"
resources:
- "*"

Adding Custom Policies

There are two methods for adding custom policies to the IAM role.

  1. Through the iam_policy input which you can use to add inline policies to the IAM role.
  2. By defining policies in Terraform and then attaching them to roles by name.

Defining Custom Policies in Terraform

  1. Give the policy a unique name, e.g. docker-publish. We will use NAME as a placeholder for the name in the instructions below.

  2. Create a file in the component directory (i.e. github-oidc-role) with the name policy_NAME.tf.

  3. In that file, conditionally (based on need) create a policy document as follows:

    locals {
    NAME_policy_enabled = contains(var.iam_policies, "NAME")
    NAME_policy = local.NAME_policy_enabled ? one(data.aws_iam_policy_document.NAME.*.json) : null
    }

    data "aws_iam_policy_document" "NAME" {
    count = local.NAME_policy_enabled ? 1 : 0

    # Define the policy here
    }

    Note that you can also add input variables and outputs to this file if desired. Just make sure that all inputs are optional.

  4. Create a file named additional-policy-map_override.tf in the component directory (if it does not already exist). This is a terraform override file, meaning its contents will be merged with the main terraform file, and any locals defined in it will override locals defined in other files. Having your code in this separate override file makes it possible for the component to provide a placeholder local variable so that it works without customization, while allowing you to customize the component and still update it without losing your customizations.

  5. In that file, redefine the local variable overridable_additional_custom_policy_map map as follows:

    locals {
    overridable_additional_custom_policy_map = {
    "NAME" = local.NAME_policy
    }
    }

    If you have multiple custom policies, using just this one file, add each policy document to the map in the form NAME = local.NAME_policy.

  6. With that done, you can now attach that policy by adding the name to the iam_policies list. For example:

        iam_policies:
    - "arn:aws:iam::aws:policy/job-function/ViewOnlyAccess"
    - "NAME"

Requirements

NameVersion
terraform>= 1.3.0
aws>= 4.9.0

Providers

NameVersion
aws>= 4.9.0

Modules

NameSourceVersion
dynamodbcloudposse/stack-config/yaml//modules/remote-state1.5.0
gha_assume_role../account-map/modules/team-assume-role-policyn/a
iam_policycloudposse/iam-policy/aws2.0.1
iam_roles../account-map/modules/iam-rolesn/a
s3_artifacts_bucketcloudposse/stack-config/yaml//modules/remote-state1.5.0
s3_bucketcloudposse/stack-config/yaml//modules/remote-state1.5.0
thiscloudposse/label/null0.25.0

Resources

NameType
aws_iam_role.github_actionsresource
aws_iam_policy_document.gitops_iam_policydata source
aws_iam_policy_document.lambda_cicd_policydata source

Inputs

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional 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.
map(string){}no
attributesID 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.
list(string)[]no
contextSingle 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.
any
{
"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
}
no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe 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).
any{}no
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
github_actions_allowed_reposA list of the GitHub repositories that are allowed to assume this role from GitHub Actions. For example,
["cloudposse/infra-live"]. Can contain "*" as wildcard.
If org part of repo name is omitted, "cloudposse" will be assumed.
list(string)[]no
gitops_policy_configurationConfiguration for the GitOps IAM Policy, valid keys are
- s3_bucket_component_name - Component Name of where to store the TF Plans in S3, defaults to gitops/s3-bucket
- dynamodb_component_name - Component Name of where to store the TF Plans in Dynamodb, defaults to gitops/dynamodb
- s3_bucket_environment_name - Environment name for the S3 Bucket, defaults to current environment
- dynamodb_environment_name - Environment name for the Dynamodb Table, defaults to current environment
object({
s3_bucket_component_name = optional(string, "gitops/s3-bucket")
dynamodb_component_name = optional(string, "gitops/dynamodb")
s3_bucket_environment_name = optional(string)
dynamodb_environment_name = optional(string)
})
{}no
iam_policiesList of policies to attach to the IAM role, should be either an ARN of an AWS Managed Policy or a name of a custom policy e.g. gitopslist(string)[]no
iam_policyIAM policy as list of Terraform objects, compatible with Terraform aws_iam_policy_document data source
except that source_policy_documents and override_policy_documents are not included.
Use inputs iam_source_policy_documents and iam_override_policy_documents for that.
list(object({
policy_id = optional(string, null)
version = optional(string, null)
statements = list(object({
sid = optional(string, null)
effect = optional(string, null)
actions = optional(list(string), null)
not_actions = optional(list(string), null)
resources = optional(list(string), null)
not_resources = optional(list(string), null)
conditions = optional(list(object({
test = string
variable = string
values = list(string)
})), [])
principals = optional(list(object({
type = string
identifiers = list(string)
})), [])
not_principals = optional(list(object({
type = string
identifiers = list(string)
})), [])
}))
}))
[]no
id_length_limitLimit 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.
numbernullno
label_key_caseControls 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.
stringnullno
label_orderThe 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.
list(string)nullno
label_value_caseControls 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.
stringnullno
labels_as_tagsSet 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.
set(string)
[
"default"
]
no
lambda_cicd_policy_configurationConfiguration for the lambda-cicd policy. The following keys are supported:
- enable_kms_access - (bool) - Whether to allow access to KMS. Defaults to false.
- enable_ssm_access - (bool) - Whether to allow access to SSM. Defaults to false.
- enable_s3_access - (bool) - Whether to allow access to S3. Defaults to false.
- s3_bucket_component_name - (string) - The name of the component to use for the S3 bucket. Defaults to s3-bucket/github-action-artifacts.
- s3_bucket_environment_name - (string) - The name of the environment to use for the S3 bucket. Defaults to the environment of the current module.
- s3_bucket_tenant_name - (string) - The name of the tenant to use for the S3 bucket. Defaults to the tenant of the current module.
- s3_bucket_stage_name - (string) - The name of the stage to use for the S3 bucket. Defaults to the stage of the current module.
- enable_lambda_update - (bool) - Whether to allow access to update lambda functions. Defaults to false.
object({
enable_kms_access = optional(bool, false)
enable_ssm_access = optional(bool, false)
enable_s3_access = optional(bool, false)
s3_bucket_component_name = optional(string, "s3-bucket/github-action-artifacts")
s3_bucket_environment_name = optional(string)
s3_bucket_tenant_name = optional(string)
s3_bucket_stage_name = optional(string)
enable_lambda_update = optional(bool, false)
})
{}no
nameID 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.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform 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.
stringnullno
regionAWS Regionstringn/ayes
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs

NameDescription
github_actions_iam_role_arnARN of IAM role for GitHub Actions
github_actions_iam_role_nameName of IAM role for GitHub Actions

References