Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/infraspecdev/terraform-aws-github-action-iam-role
This Terraform module creates and configures an IAM role in AWS that allows GitHub Actions to assume the role using OpenID Connect (OIDC) for deploying resources in your AWS account
https://github.com/infraspecdev/terraform-aws-github-action-iam-role
Last synced: 3 days ago
JSON representation
This Terraform module creates and configures an IAM role in AWS that allows GitHub Actions to assume the role using OpenID Connect (OIDC) for deploying resources in your AWS account
- Host: GitHub
- URL: https://github.com/infraspecdev/terraform-aws-github-action-iam-role
- Owner: infraspecdev
- License: mit
- Created: 2024-07-29T05:28:29.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-17T09:30:25.000Z (3 months ago)
- Last Synced: 2024-11-08T09:28:17.196Z (about 2 months ago)
- Language: HCL
- Size: 22.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Terraform Module Template
This repository serves as a template for creating Terraform modules. It provides a structured approach to organizing and maintaining Terraform code, along with examples and best practices.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Examples](#examples)
- [Module Structure](#module-structure)
## Prerequisites
Before you begin, ensure you have met the following requirements:
1. [install terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)
2. [install pre-commit](https://pre-commit.com/#install)
3. configure pre-commit: `pre-commit install`
4. install required tools
- [tflint](https://github.com/terraform-linters/tflint)
- [terraform-docs](https://github.com/terraform-docs/terraform-docs)
## Usage
To use this template, clone the repository and customize it according to your module's requirements. Below is a quick start guide:
1. **Clone the repository:**
```sh
git clone https://github.com/your-username/terraform-module-template.git
cd terraform-module-template
```
2. **Customize the module:**
- Update `main.tf`, `variables.tf`, `outputs.tf`, and `versions.tf` files as needed.
- Add your own resources and logic.
3. **Run Terraform commands:**
```sh
terraform init
terraform plan
terraform apply
```
## Examples
This repository includes example configurations to help you understand how to use the module:
- **Complete Example:** Located in `examples/complete`
- Demonstrates a full-featured usage of the module.
```sh
cd examples/complete
terraform init
terraform apply
```
- **Minimal Example:** Located in `examples/minimal`
- Shows a minimal configuration for using the module.
```sh
cd examples/minimal
terraform init
terraform apply
```
## Module Structure
The repository is organized as follows:
```plaintext
.
├── .editorconfig
├── examples
│ ├── complete
│ │ ├── main.tf
│ │ ├── outputs.tf
│ │ ├── provider.tf
│ │ ├── README.md
│ │ ├── variables.tf
│ │ └── versions.tf
│ └── minimal
│ ├── main.tf
│ ├── outputs.tf
│ ├── provider.tf
│ ├── README.md
│ ├── variables.tf
│ └── versions.tf
├── .github
│ └── workflows
│ ├── documentation.yaml
│ ├── pre-commit.yaml
│ └── pr-title.yaml
├── .gitignore
├── main.tf
├── modules
│ └── sample-resource
│ ├── main.tf
│ ├── outputs.tf
│ ├── variables.tf
│ └── version.tf
├── outputs.tf
├── .pre-commit-config.yaml
├── README.md
├── .terraform-docs.yml
├── tests
│ ├── examples_minimal.tftest.hcl
│ └── unit_tests.tftest.hcl
├── .tflint.hcl
├── variables.tf
└── versions.tf
```
## Reference [Getoutline](https://infraspec.getoutline.com/doc/terraform-Xkko7xHwM5) Document for Conventions to follow in your module
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.8.4 |
| [aws](#requirement\_aws) | >= 5.51.0 |
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | >= 5.51.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_iam_openid_connect_provider.github_oidc](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_openid_connect_provider) | resource |
| [aws_iam_role.github_action](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role_policy_attachment.admin](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
| [aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [aws\_account\_id](#input\_aws\_account\_id) | The AWS Account ID | `string` | n/a | yes |
| [github\_username](#input\_github\_username) | The name of the GitHub user or organization that owns the repository(ies) the role will use | `string` | n/a | yes |
| [repository\_names](#input\_repository\_names) | List of names of the GitHub repository that will be allowed to assume the role | `list(string)` | n/a | yes |
| [role\_name](#input\_role\_name) | The name of the IAM Role to be created | `string` | `"GithubActionsRole"` | no |
## Outputs
| Name | Description |
|------|-------------|
| [github\_action\_iam\_role\_arn](#output\_github\_action\_iam\_role\_arn) | The ARN of the IAM role |