Terraform インフラストラクチャ

Terraform は、インフラストラクチャを安全かつ予測可能に作成、変更、改善できるオープンソースの Infrastructure as Code ソフトウェアツールです。

Terraform インフラストラクチャジェネレーターは、Terraform インフラストラクチャプロジェクトを作成します。生成されたアプリケーションには、Checkov セキュリティチェックによるセキュリティのベストプラクティスが含まれています。

使用方法

Terraform プロジェクトの生成

新しい Terraform プロジェクトは 2 つの方法で生成できます：

CLI

pnpm

pnpm nx g @aws/nx-plugin:terraform#project --name=tf-infra

yarn

yarn nx g @aws/nx-plugin:terraform#project --name=tf-infra

npm

npx nx g @aws/nx-plugin:terraform#project --name=tf-infra

bun

bunx nx g @aws/nx-plugin:terraform#project --name=tf-infra

変更されるファイルを確認するためにドライランを実行することもできます

pnpm

pnpm nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

yarn

yarn nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

npm

npx nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

bun

bunx nx g @aws/nx-plugin:terraform#project --name=tf-infra --dry-run

VSCode

1. インストール Nx Console VSCode Plugin まだインストールしていない場合
2. VSCodeでNxコンソールを開く
3. クリック Generate (UI) "Common Nx Commands"セクションで
4. 検索 @aws/nx-plugin - terraform#project
5. 必須パラメータを入力
   • name: tf-infra
6. クリック Generate

オプション

パラメータ	型	デフォルト	説明
name 必須	string	-	プロジェクトの名前。
type	application | library	application	これがterraform lib（再利用可能なモジュール）かapp（デプロイ可能）かを指定します。
directory	string	packages	新しいプロジェクトのディレクトリ。
subDirectory	string	-	プロジェクトが配置されるサブディレクトリ。デフォルトではプロジェクト名になります。
preferInstallDependencies	boolean	true	ジェネレーター実行後に依存関係のインストールを優先するかどうか。複数のジェネレーターをバッチ処理する際にインストールを延期する場合はfalseに設定します（後続のジェネレーターがNxプロジェクトグラフを計算できるよう、必要に応じてインストールは実行されます）。最後に一度だけインストールします。

ジェネレーターの出力

ジェネレーターは、プロジェクトタイプに応じて異なるファイル構造を作成します：

type = application

アプリケーションタイプ

アプリケーションプロジェクト（--type=application）の場合、ジェネレーターはリモート状態管理を備えた完全な Terraform アプリケーションを作成します：

• Directorysrc

  • main.tf Main Terraform configuration file
  • providers.tf Provider configuration with S3 backend
  • variables.tf Input variable definitions
  • outputs.tf Output value definitions
  • Directoryenv Environment-specific variable files

    • dev.tfvars Development environment variables
• Directorybootstrap Bootstrap configuration for remote state

  • main.tf S3 bucket and policies for state storage
  • providers.tf AWS provider configuration
  • variables.tf Bootstrap variable definitions
• Directoryscripts Node helpers run by the nx bootstrap and init targets

  • aws-config.ts Resolves account + region via the AWS SDK credential chain
  • bootstrap.ts Pulls/pushes the bootstrap tfstate and runs terraform apply
  • init.ts Runs terraform init with the S3 backend config
• project.json Project configuration and build targets

共有 Terraform モジュール

ジェネレーターは packages/common/terraform ライブラリも作成します。これは最初にメトリクスモジュール（メタデータを含む空の Cloudformation スタックを作成）を追加するだけで、nx-plugin-for-aws チームが使用状況メトリクスを追跡できるように自動的に計装されます。

type = library

ライブラリタイプ

ライブラリプロジェクト（--type=library）の場合、ジェネレーターは再利用可能な Terraform モジュール用のよりシンプルな構造を作成します：

• Directorysrc

  • main.tf Main Terraform module file
• project.json Project configuration and build targets

アプリケーション vs ライブラリ

アプリケーションプロジェクトにはリモート状態管理を備えた完全なデプロイ機能が含まれていますが、ライブラリプロジェクトは他のプロジェクトで使用できる再利用可能な Terraform モジュールを作成するために設計されています。

Terraform インフラストラクチャの実装

src/main.tf 内で Terraform インフラストラクチャの記述を開始できます。例えば：

src/main.tf

locals {
  account_id = data.aws_caller_identity.current.account_id
  aws_region = data.aws_region.current.id
}

resource "null_resource" "print_info" {
  # triggers = {
  #   always_run = timestamp()
  # }

  provisioner "local-exec" {
    command = "echo 'AWS Region: ${local.aws_region}, AWS Account: ${local.account_id}, Environment: ${var.environment}'"
  }
}

# Declare your infrastructure here
resource "aws_s3_bucket" "my_bucket" {
  bucket = "my-unique-bucket-name"
}

プロジェクト間の依存関係

別のプロジェクト（lib）からモジュールを実行したい場合は、次のようにできます：

module "lib_module" {
  source = "../../path/to/my-lib/src"
}

これにより、Nx グラフが自動的に更新され、使用するアプリケーションとライブラリの間に依存関係が追加されます。

環境設定

src/env/*.tfvars ファイルで環境固有の変数を設定します。

新しい環境を追加するには、環境固有の変数を含む新しい src/env/<environment>.tfvars ファイルを作成し、新しい環境設定用に project.json の apply, destroy, init, plan に新しいエントリを追加します。例えば、prod 環境を追加したいとします：

src/env/prod.tfvars

# Production environment variables
environment = "prod"
region      = "us-west-2"

project.json

{
  "targets": {
        "apply": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform apply ../../../dist/packages/infra/terraform/dev.tfplan"
                },
                "prod": {
                    "command": "terraform apply ../../../dist/packages/infra/terraform/prod.tfplan"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd": "{projectRoot}/src"
            },
            "dependsOn": ["plan"]
        },
        "destroy": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform destroy -var-file=env/dev.tfvars"
                },
                "prod": {
                    "command": "terraform destroy -var-file=env/prod.tfvars"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd":"{projectRoot}/src"
            },
            "dependsOn": ["init"]
        },
        "init": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "env": { "TF_ENV": "dev" }
                },
                "prod": {
                    "env": { "TF_ENV": "prod" }
                }
            },
            "options": {
                "forwardAllArgs": true,
                "commands": ["tsx {projectRoot}/scripts/init.ts {projectRoot}"],
                "cwd": "{workspaceRoot}"
            }
        },
        "plan": {
            "executor": "nx:run-commands",
            "defaultConfiguration": "dev",
            "configurations": {
                "dev": {
                    "command": "terraform plan -var-file=env/dev.tfvars -out=../../../dist/packages/infra/terraform/dev.tfplan"
                },
                "prod": {
                    "command": "terraform plan -var-file=env/dev.tfvars -out=../../../dist/packages/infra/terraform/prod.tfplan"
                }
            },
            "options": {
                "forwardAllArgs": true,
                "cwd": "{projectRoot}/src"
            },
            "dependsOn": ["init"]
        }
    }
}

デフォルト環境

デフォルトでは、すべてのターゲットは dev 環境を想定していますが、次のように特定の環境をターゲットにできます：

• pnpm
• yarn
• npm
• bun

pnpm nx apply tf-infra --configuration=prod

yarn nx apply tf-infra --configuration=prod

npx nx apply tf-infra --configuration=prod

bunx nx apply tf-infra --configuration=prod

状態が環境間で tfstate を自動的にセグメント化するため、いつでも環境を切り替えることができます。

type = application

リモート状態のブートストラップ（アプリケーションプロジェクトのみ）

インフラストラクチャをデプロイする前に、リモート状態バックエンドをブートストラップする必要があります。これにより、Terraform 状態ファイルを保存する S3 バケットが作成されます：

pnpm

pnpm nx bootstrap tf-infra

yarn

yarn nx bootstrap tf-infra

npm

npx nx bootstrap tf-infra

bun

bunx nx bootstrap tf-infra

AWS プロファイル設定

ブートストラップリソースをデプロイするアカウント/リージョンに AWS CLI プロファイルが設定されていることを確認してください。

bootstrap ターゲットはアプリケーションタイプのプロジェクトでのみ使用できます。ライブラリプロジェクトは再利用可能なモジュールとして設計されているため、リモート状態管理は必要ありません。

利用可能なターゲット

利用可能なターゲットは、プロジェクトタイプによって異なります：

共通ターゲット（アプリケーションとライブラリの両方）

インフラストラクチャの検証

validate ターゲットを使用して Terraform 設定を検証できます：

pnpm

pnpm nx validate tf-infra

yarn

yarn nx validate tf-infra

npm

npx nx validate tf-infra

bun

bunx nx validate tf-infra

コードのフォーマット

fmt ターゲットを使用して Terraform コードをフォーマットします：

pnpm

pnpm nx fmt tf-infra

yarn

yarn nx fmt tf-infra

npm

npx nx fmt tf-infra

bun

bunx nx fmt tf-infra

セキュリティテスト

test ターゲットで Checkov を使用してインフラストラクチャのセキュリティチェックを実行します：

pnpm

pnpm nx test tf-infra

yarn

yarn nx test tf-infra

npm

npx nx test tf-infra

bun

bunx nx test tf-infra

セキュリティテストの結果は、ルートの dist フォルダー内の dist/packages/<my-terraform-project>/checkov にあります。

type = application

アプリケーション専用ターゲット

以下のターゲットは、アプリケーションタイプのプロジェクトでのみ使用できます：

インフラストラクチャの計画

変更を適用する前に、plan ターゲットを実行して Terraform が何を行うかを確認できます：

pnpm

pnpm nx plan tf-infra

yarn

yarn nx plan tf-infra

npm

npx nx plan tf-infra

bun

bunx nx plan tf-infra

これにより、dist/packages/<my-terraform-project>/terraform/dev.tfplan にプランファイルが作成されます。

Terraform の初期化

init ターゲットで Terraform 作業ディレクトリを初期化します：

pnpm

pnpm nx run tf-infra:init

yarn

yarn nx run tf-infra:init

npm

npx nx run tf-infra:init

bun

bunx nx run tf-infra:init

AWS へのデプロイ

計画後、apply ターゲットを使用してインフラストラクチャを AWS にデプロイできます：

pnpm

pnpm nx apply tf-infra

yarn

yarn nx apply tf-infra

npm

npx nx apply tf-infra

bun

bunx nx apply tf-infra

自動承認

上記のコマンドは、plan ターゲットによって作成されたプランを適用します。変更を確認するために、最初に plan を実行してください。

デプロイエイリアス

deploy ターゲットも apply のエイリアスとして使用できます。

• pnpm
• yarn
• npm
• bun

pnpm nx deploy tf-infra

yarn nx deploy tf-infra

npx nx deploy tf-infra

bunx nx deploy tf-infra

または

pnpm

pnpm nx apply tf-infra

yarn

yarn nx apply tf-infra

npm

npx nx apply tf-infra

bun

bunx nx apply tf-infra

のいずれかを同じように使用できます。

出力の取得

Terraform 設定から出力値を取得します：

pnpm

pnpm nx output tf-infra

yarn

yarn nx output tf-infra

npm

npx nx output tf-infra

bun

bunx nx output tf-infra

インフラストラクチャの破棄

インフラストラクチャを削除する必要がある場合は、destroy ターゲットを使用します：

pnpm

pnpm nx destroy tf-infra

yarn

yarn nx destroy tf-infra

npm

npx nx destroy tf-infra

bun

bunx nx destroy tf-infra

破壊的な操作

これにより、この Terraform 設定で管理されているすべてのリソースが完全に削除されます。注意して使用してください！

ブートストラップリソースの破棄

ブートストラップリソース（状態保存用の S3 バケット）をクリーンアップするには：

pnpm

pnpm nx bootstrap-destroy tf-infra

yarn

yarn nx bootstrap-destroy tf-infra

npm

npx nx bootstrap-destroy tf-infra

bun

bunx nx bootstrap-destroy tf-infra

詳細情報

Terraform の詳細については、Terraform ドキュメントおよび AWS プロバイダードキュメントを参照してください。