https://github.com/yhs88a/aws-oidc

AWS oidc identity providers.
https://github.com/yhs88a/aws-oidc

oidc terraform terragrunt

Last synced: about 2 months ago
JSON representation

AWS oidc identity providers.

• Host: GitHub
• URL: https://github.com/yhs88a/aws-oidc
• Owner: yhs88a
• License: mit
• Created: 2024-11-09T07:06:19.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-16T19:42:00.000Z (about 2 months ago)
• Last Synced: 2024-11-16T20:26:09.920Z (about 2 months ago)
• Topics: oidc, terraform, terragrunt
• Language: HCL
• Homepage:
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# aws-oidc

[![terragrunt action](https://github.com/yhs88a/aws-oidc/actions/workflows/terragrunt.yml/badge.svg)](https://github.com/yhs88a/aws-oidc/actions/workflows/terragrunt.yml)

[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)

[![Licence: MIT](https://img.shields.io/github/license/yhs88a/aws-oidc)](https://github.com/yhs88a/aws-oidc/blob/main/LICENSE)

This repository provides a Terraform and Terragrunt setup for managing AWS infrastructure with OIDC authentication. It includes preconfigured modules and a Makefile with common commands for easy management.

## Getting Started

To begin, clone the repository and review the Makefile targets for key commands.

### Makefile Targets

These Makefile targets simplify Terraform and Terragrunt operations:

```

docs      : Generate Terraform documentation

fmt       : Format Terraform files

init      : Initialize Terraform

refresh   : Refresh Terraform state

plan      : Plan Terraform changes

apply     : Apply Terraform changes

destroy   : Destroy Terraform-managed infrastructure

tfclean   : Clean up Terraform and Terragrunt cache files

```

## Usage

### Configuring S3 Backend

Set up `terragrunt.hcl` for remote state storage in S3 and configure a DynamoDB table for state locking. This ensures state management is secure and avoids conflicts.

#### Environment Variables

These variables control AWS credentials, endpoints, and Terraform configurations:

- `AWS_DEFAULT_REGION`: AWS region to use.

- `AWS_ACCESS_KEY_ID`: Your AWS access key for authentication.

- `AWS_SECRET_ACCESS_KEY`: Your AWS secret key for authentication.

- `TF_S3_ENDPOINT`: S3 endpoint for S3 backend.

- `TF_DYNAMODB_ENDPOINT`: DynamoDB for S3 backend.

- `TF_VAR_CI_ENVIRONMENT_NAME`: Specifies the environment (e.g., `dev`, `pre`, `prod`).

#### Modules

Modules are located under `modules/`, e.g., the `vpc` module:

- `_locals.tf`: Local values

- `_main.tf`: Main configuration

- `_output.tf`: Output values

- `_variable.tf`: Variables

- `data.tf`: Data sources

- `default.tfvars`: Default variable values

- `dev.tfvars`: Development environment values

- `pre.tfvars`: Pre-production environment values

- `prod.tfvars`: Production environment values

- `terragrunt.hcl`: Terragrunt configuration

#### Terragrunt

Specify the appropriate `tfvars` file for your environment.

# License

This project is licensed under the [MIT License](/LICENSE). See the LICENSE file for details.