Awesome
<!-- markdownlint-disable --><a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse-terraform-components/aws-github-oidc-role/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-github-oidc-role/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-github-oidc-role.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->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.
- Through the
iam_policy
input which you can use to add inline policies to the IAM role. - By defining policies in Terraform and then attaching them to roles by name.
Defining Custom Policies in Terraform
-
Give the policy a unique name, e.g.
docker-publish
. We will useNAME
as a placeholder for the name in the instructions below. -
Create a file in the component directory (i.e.
github-oidc-role
) with the namepolicy_NAME.tf
. -
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.
-
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. -
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
. -
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
Name | Version |
---|---|
<a name="requirement_terraform"></a> terraform | >= 1.3.0 |
<a name="requirement_aws"></a> aws | >= 4.9.0 |
Providers
Name | Version |
---|---|
<a name="provider_aws"></a> aws | >= 4.9.0 |
Modules
Name | Source | Version |
---|---|---|
<a name="module_dynamodb"></a> dynamodb | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
<a name="module_gha_assume_role"></a> gha_assume_role | ../account-map/modules/team-assume-role-policy | n/a |
<a name="module_iam_policy"></a> iam_policy | cloudposse/iam-policy/aws | 2.0.1 |
<a name="module_iam_roles"></a> iam_roles | ../account-map/modules/iam-roles | n/a |
<a name="module_s3_artifacts_bucket"></a> s3_artifacts_bucket | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
<a name="module_s3_bucket"></a> s3_bucket | cloudposse/stack-config/yaml//modules/remote-state | 1.5.0 |
<a name="module_this"></a> this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_iam_role.github_actions | resource |
aws_iam_policy_document.gitops_iam_policy | data source |
aws_iam_policy_document.lambda_cicd_policy | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
<a name="input_additional_tag_map"></a> additional_tag_map | Additional key-value pairs to add to each map in tags_as_list_of_maps . Not added to tags or id .<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration. | map(string) | {} | no |
<a name="input_attributes"></a> attributes | ID element. Additional attributes (e.g. workers or cluster ) to add to id ,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter <br/>and treated as a single ID element. | list(string) | [] | no |
<a name="input_context"></a> context | Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged. | any | <pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre> | no |
<a name="input_delimiter"></a> delimiter | Delimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all. | string | null | no |
<a name="input_descriptor_formats"></a> descriptor_formats | Describe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>} <br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id .<br/>Default is {} (descriptors output will be empty). | any | {} | no |
<a name="input_enabled"></a> enabled | Set to false to prevent the module from creating any resources | bool | null | no |
<a name="input_environment"></a> environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
<a name="input_github_actions_allowed_repos"></a> github_actions_allowed_repos | A list of the GitHub repositories that are allowed to assume this role from GitHub Actions. For example,<br/> ["cloudposse/infra-live"]. Can contain "*" as wildcard.<br/> If org part of repo name is omitted, "cloudposse" will be assumed. | list(string) | [] | no |
<a name="input_gitops_policy_configuration"></a> gitops_policy_configuration | Configuration for the GitOps IAM Policy, valid keys are<br/> - s3_bucket_component_name - Component Name of where to store the TF Plans in S3, defaults to gitops/s3-bucket <br/> - dynamodb_component_name - Component Name of where to store the TF Plans in Dynamodb, defaults to gitops/dynamodb <br/> - s3_bucket_environment_name - Environment name for the S3 Bucket, defaults to current environment<br/> - dynamodb_environment_name - Environment name for the Dynamodb Table, defaults to current environment | <pre>object({<br/> s3_bucket_component_name = optional(string, "gitops/s3-bucket")<br/> dynamodb_component_name = optional(string, "gitops/dynamodb")<br/> s3_bucket_environment_name = optional(string)<br/> dynamodb_environment_name = optional(string)<br/> })</pre> | {} | no |
<a name="input_iam_policies"></a> iam_policies | List 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. gitops | list(string) | [] | no |
<a name="input_iam_policy"></a> iam_policy | IAM policy as list of Terraform objects, compatible with Terraform aws_iam_policy_document data source<br/>except that source_policy_documents and override_policy_documents are not included.<br/>Use inputs iam_source_policy_documents and iam_override_policy_documents for that. | <pre>list(object({<br/> policy_id = optional(string, null)<br/> version = optional(string, null)<br/> statements = list(object({<br/> sid = optional(string, null)<br/> effect = optional(string, null)<br/> actions = optional(list(string), null)<br/> not_actions = optional(list(string), null)<br/> resources = optional(list(string), null)<br/> not_resources = optional(list(string), null)<br/> conditions = optional(list(object({<br/> test = string<br/> variable = string<br/> values = list(string)<br/> })), [])<br/> principals = optional(list(object({<br/> type = string<br/> identifiers = list(string)<br/> })), [])<br/> not_principals = optional(list(object({<br/> type = string<br/> identifiers = list(string)<br/> })), [])<br/> }))<br/> }))</pre> | [] | no |
<a name="input_id_length_limit"></a> id_length_limit | Limit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0 .<br/>Does not affect id_full . | number | null | no |
<a name="input_label_key_case"></a> label_key_case | Controls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower , title , upper .<br/>Default value: title . | string | null | no |
<a name="input_label_order"></a> label_order | The order in which the labels (ID elements) appear in the id .<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | list(string) | null | no |
<a name="input_label_value_case"></a> label_value_case | Controls the letter case of ID elements (labels) as included in id ,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower , title , upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower . | string | null | no |
<a name="input_labels_as_tags"></a> labels_as_tags | Set of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id , not the name .<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored. | set(string) | <pre>[<br/> "default"<br/>]</pre> | no |
<a name="input_lambda_cicd_policy_configuration"></a> lambda_cicd_policy_configuration | Configuration for the lambda-cicd policy. The following keys are supported:<br/> - enable_kms_access - (bool) - Whether to allow access to KMS. Defaults to false.<br/> - enable_ssm_access - (bool) - Whether to allow access to SSM. Defaults to false.<br/> - enable_s3_access - (bool) - Whether to allow access to S3. Defaults to false.<br/> - s3_bucket_component_name - (string) - The name of the component to use for the S3 bucket. Defaults to s3-bucket/github-action-artifacts .<br/> - s3_bucket_environment_name - (string) - The name of the environment to use for the S3 bucket. Defaults to the environment of the current module.<br/> - s3_bucket_tenant_name - (string) - The name of the tenant to use for the S3 bucket. Defaults to the tenant of the current module.<br/> - s3_bucket_stage_name - (string) - The name of the stage to use for the S3 bucket. Defaults to the stage of the current module.<br/> - enable_lambda_update - (bool) - Whether to allow access to update lambda functions. Defaults to false. | <pre>object({<br/> enable_kms_access = optional(bool, false)<br/> enable_ssm_access = optional(bool, false)<br/> enable_s3_access = optional(bool, false)<br/> s3_bucket_component_name = optional(string, "s3-bucket/github-action-artifacts")<br/> s3_bucket_environment_name = optional(string)<br/> s3_bucket_tenant_name = optional(string)<br/> s3_bucket_stage_name = optional(string)<br/> enable_lambda_update = optional(bool, false)<br/> })</pre> | {} | no |
<a name="input_name"></a> name | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag .<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input. | string | null | no |
<a name="input_namespace"></a> namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string | null | no |
<a name="input_regex_replace_chars"></a> regex_replace_chars | Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits. | string | null | no |
<a name="input_region"></a> region | AWS Region | string | n/a | yes |
<a name="input_stage"></a> stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | string | null | no |
<a name="input_tags"></a> tags | Additional tags (e.g. {'BusinessUnit': 'XYZ'} ).<br/>Neither the tag keys nor the tag values will be modified by this module. | map(string) | {} | no |
<a name="input_tenant"></a> tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
Outputs
Name | Description |
---|---|
<a name="output_github_actions_iam_role_arn"></a> github_actions_iam_role_arn | ARN of IAM role for GitHub Actions |
<a name="output_github_actions_iam_role_name"></a> github_actions_iam_role_name | Name of IAM role for GitHub Actions |
References
- cloudposse/terraform-aws-components - Cloud Posse's upstream component
[!TIP]
π½ Use Atmos with Terraform
Cloud Posse uses
<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>atmos
to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.
Related Projects
Check out these related projects.
- Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
- Atmos - Atmos is like docker-compose but for your infrastructure
[!TIP]
Use Terraform Reference Architectures for AWS
Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
β We build it together with your team.<br/> β Your team owns everything.<br/> β 100% Open Source and backed by fanatical support.<br/>
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-github-oidc-role&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>π <strong>Learn More</strong></summary> <br/>Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.
Your team can operate like a pro today.
Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
Day-0: Your Foundation for Success
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
- Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
- Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
- GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-github-oidc-role&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
Day-2: Your Operational Mastery
- Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
- Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
- Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
- Code Reviews. Enhance your teamβs code quality with our expert feedback, fostering continuous improvement and collaboration.
- Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
- Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
- Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-github-oidc-role&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>
β¨ Contributing
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
<a href="https://github.com/cloudposse-terraform-components/aws-github-oidc-role/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-github-oidc-role&max=24" /> </a>For π bug reports & feature requests, please use the issue tracker.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull Request so that we can review your changes
NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!
π Slack Community
Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.
π° Newsletter
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β and usually a 5-minute read.
π Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-github-oidc-role&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you canβt find anywhere else. It's FREE for everyone!
License
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>
<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
</details>
Trademarks
All other trademarks referenced herein are the property of their respective owners.
Copyright Β© 2017-2024 Cloud Posse, LLC
<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-github-oidc-role&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>
<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-github-oidc-role?pixel&cs=github&cm=readme&an=aws-github-oidc-role"/>