https://github.com/tqer39/terraform-aws

Configure AWS resources with Terraform.
https://github.com/tqer39/terraform-aws

aws terraform

Last synced: 5 months ago
JSON representation

Configure AWS resources with Terraform.

• Host: GitHub
• URL: https://github.com/tqer39/terraform-aws
• Owner: tqer39
• License: mit
• Created: 2022-04-29T22:47:34.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-12-02T18:45:49.000Z (7 months ago)
• Last Synced: 2025-12-05T18:25:02.427Z (7 months ago)
• Topics: aws, terraform
• Language: HCL
• Homepage:
• Size: 1.03 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# terraform-aws

AWS のリソースを Terraform で構成する。

## GitHub Actions Status badges

| Name | Environment | Result |

| :--- | :--- | :--- |

| Linterなどによる検証 | pre-commit | ![pre-commit](https://github.com/tqer39/terraform-aws/actions/workflows/pre-commit.yml/badge.svg) |

| AWS 検証環境 | Sandbox | ![Terraform - sandbox](https://github.com/tqer39/terraform-aws/actions/workflows/_terraform-aws-sandbox.yml/badge.svg) |

| AWS ポートフォリオ | Management | ![Terraform - management](https://github.com/tqer39/terraform-aws/actions/workflows/_terraform-aws-portfolio.yml/badge.svg) |

| AWS 全体管理 | Management | ![Terraform - management](https://github.com/tqer39/terraform-aws/actions/workflows/_terraform-aws-management.yml/badge.svg) |

## ブランチ設計

```mermaid

gitGraph

    commit

    branch feature/update-readme

    commit

    commit

    commit

    checkout main

    merge feature/update-readme

    commit

    commit

```

1. GitHub Flow で運用します。

2. `main` がデフォルトブランチです。

3. `main` ブランチにマージされると GitHub Actions で `terraform apply` でインフラが更新されます。

   - **マージのタイミングがデプロイに相当します。**

## module 化しないリソース

| リソース | 理由 |

| :--- | :--- |

| [aws_iam_role_policy_attachment](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | パラメータが少なすぎて module 化するメリットがない |

| [aws_route53_record](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | リソースの種類が多く汎用的な module にするコストに見合うメリットがない |

## セキュリティポリシー

### AWS の認証方法

- GitHub Actions から AWS のリソースをデプロイするときの認証方式は OIDC です。

- Credential は管理面の手間がかかるため採用していません。

## EditorConfig 設定

包括的なコーディング規約として EditorConfig を使用しているため、[公式ページの Download a Plugin](https://editorconfig.org/#download) のエディタ・IDE を使用している場合は、プラグインを追加してください。

## Setup

### Homebrew

```bash

# install brew see: https://brew.sh/index_ja

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# install software

brew bundle

```

### anyenv

#### zsh

```bash

anyenv init

anyenv install --init

echo 'eval "$(anyenv init -)"' >> ~/.zshrc

exec $SHELL -l

mkdir -p "$(anyenv root)/plugins"

git clone https://github.com/znz/anyenv-update.git "$(anyenv root)/plugins/anyenv-update"

```

#### fish

```bash

anyenv init - fish | source

anyenv install --init

set -Ux fish_user_paths $HOME/.anyenv/bin $fish_user_paths

echo 'set -x PATH ~/.anyenv/bin $PATH' >> ~/.config/fish/config.fish

echo 'eval (anyenv init - | source)' >> ~/.config/fish/config.fish

exec fish -l

mkdir -p (anyenv root)/plugins

git clone https://github.com/znz/anyenv-update.git (anyenv root)/plugins/anyenv-update

which anyenv

```

### tfenv

```bash

anyenv install tfenv

which tfenv

```

### Terraform

```bash

tfenv install

which terraform

terraform install

terraform -version

```

### Rancher Desktop

#### Linux

see [Rancher Desktop - Linux](https://docs.rancherdesktop.io/getting-started/installation/#linux)

```bash

curl -s https://download.opensuse.org/repositories/isv:/Rancher:/stable/deb/Release.key | gpg --dearmor | sudo dd status=none of=/usr/share/keyrings/isv-rancher-stable-archive-keyring.gpg

echo 'deb [signed-by=/usr/share/keyrings/isv-rancher-stable-archive-keyring.gpg] https://download.opensuse.org/repositories/isv:/Rancher:/stable/deb/ ./' | sudo dd status=none of=/etc/apt/sources.list.d/isv-rancher-stable.list

sudo apt update

sudo apt install rancher-desktop

```

os reboot.

### Session Manager Plugin

see: [(オプション) AWS CLI 用の Session Manager プラグインをインストールする](https://docs.aws.amazon.com/ja_jp/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)

#### Linux (Debian | amd64)

```bash

curl "https://s3.amazonaws.com/session-manager-downloads/plugin/latest/ubuntu_64bit/session-manager-plugin.deb" -o "session-manager-plugin.deb"

sudo dpkg -i session-manager-plugin.deb

rm -rf session-manager-plugin.deb

```

### pre-commit

```bash

# setup

pre-commit install --install-hooks

```

### ローカルから Terraform CLI を実行する方法

#### AWS Profile の設定

これは Makefile の aws-vault で使用されます。

下記の内容を `~/.aws/config` に設定します。

```bash

[profile terraform-aws-management]

sso_start_url = https://tqer39-management.awsapps.com/start/

sso_region = ap-northeast-1

sso_account_id = 577523824419

sso_role_name = 

region = ap-northeast-1

output = json

```

### Terraform のセットアップ

```bash

tfenv install

terraform -v

```

コマンドのフォーマット

- `AWS CLI (SSO) の profile`: 前項で設定した AWS CLI の profile

- `実行先のパス`: Terraform CLI を実行するパス

- `Terraform コマンド`: `terraform` に続くコマンド

```bash

# Format:

aws-vault exec "${AWS CLI (SSO) の profile}" -- terraform -chdir="${実行先のパス}" "${Terraform コマンド}"

```

#### terraform init（初期化）

```bash

# Example:

aws-vault exec terraform-aws-management -- terraform -chdir=./terraform/environments/dev/base_apne1 init

```

#### terraform validate

```bash

# Example:

aws-vault exec terraform-aws-management -- terraform -chdir=./terraform/environments/dev/base_apne1 validate

```

#### terraform plan

```bash

# Example:

aws-vault exec terraform-aws-management -- terraform -chdir=./terraform/environments/dev/base_apne1 plan

```

#### terraform apply

**※ローカルからのデプロイは原則禁止です。**

```bash

# Example:

aws-vault exec terraform-aws-management -- terraform -chdir=./terraform/environments/dev/base_apne1 apply -auto-approve

```

## 新しい環境の作成方法

手動で s3 バケットを作成。

リソースを作成。

```txt

.github/workflows/terraform-aws-<環境名>.yml

.github/labeler.yml

terraform/environments/<環境名>/base/main.tf

terraform/environments/<環境名>/base/provider.tf

terraform/environments/<環境名>/base/terraform.tf

terraform/environments/<環境名>/base/shared-locals.tf

terraform/environments/<環境名>/shared/locals.tf

```

```zsh

# https://xxxxx.awsapps.com/start#/

export AWS_ACCESS_KEY_ID="XXXXXXXXXX"

export AWS_SECRET_ACCESS_KEY="XXXXXXXXXX"

export AWS_SESSION_TOKEN="XXXXXXXXXX"

terraform -chdir=terraform/environments/<環境名>/base init

```

手動で作成した s3 バケットを import。

```zsh

$TF_PATH="terraform/environments/<環境名>/base"

terraform -chdir="$TF_PATH" import module.terraform-backend.module.s3-bucket.aws_s3_bucket.this <バケット名>

terraform -chdir="$TF_PATH" import module.terraform-backend.module.s3-bucket.aws_s3_bucket_acl.this <バケット名>

terraform -chdir="$TF_PATH" import module.terraform-backend.module.s3-bucket.aws_s3_bucket_public_access_block.this <バケット名>

terraform -chdir="$TF_PATH" import module.terraform-backend.module.s3-bucket.aws_s3_bucket_versioning.this <バケット名>

```

OIDC 関連のリソースの新規作成と s3 バケットのパラメータ更新を行います。

```zsh

$TF_PATH="terraform/environments/<環境名>/base"

terraform -chdir="$TF_PATH" fmt

terraform -chdir="$TF_PATH" validate

terraform -chdir="$TF_PATH" plan

terraform -chdir="$TF_PATH" apply -auto-approve

```