本文へスキップ
hdknr blog

Terraform IaC ベストプラクティス

大規模 Terraform プロジェクトの設計・運用:モジュール化・ファイル分割・state 管理と、Terraform のコード構造に対応させた AWS 設計指示書(パラメータシート)の書き方、環境分割、運用時の事故防止

概要

main.tf(リソース)/ variables.tf(入力)/ outputs.tf(出力)に分割し、大規模化したら modules/ 配下でコンポーネント化する。環境ごと(dev / stg / prod)に変数の値を分け、State はリモートに置いてロックで同時実行を防ぐ。設計工程から渡す設計指示書は、Terraform のコード構造(ディレクトリ・変数・リソース)にそのまま対応づけられる形で書くと、実装の速さとミスの量が大きく変わる。

詳細

設計指示書の 5 要素と対応先

要素Terraform 側の対応先書くこと
① 全体像と State 分割方針ディレクトリ・backend構成図、変更頻度による分割(01_network / 02_database / 03_app)、別 State の参照方法と公開する output
② リソース一覧と命名規則locals・provider の default_tags論理名(aws_vpc.main)と物理名(${var.project}-${var.env}-vpc)、共通タグのキーと値
③ パラメータシートvariables.tf・.tfvars・validation列を「リソース種別・変数名・型・環境ごとの値・制約」にする
④ 機密情報と手動作業の境界data ソース・Bootstrap 手順シークレットの渡し方、State バケット作成などの手動手順
⑤ 環境の分割方針環境ごとのルートと backendアカウント・State の置き場・apply の権限

State の参照と機密値

パラメータシートの書き方

環境の分け方

方式特徴
環境ごとのディレクトリ(envs/prod/01_network/)backend と assume する IAM ロールがファイルに書かれ、どこに apply するかが一目で分かる
共通コード + 環境ごとの設定ファイル-backend-config=envs/prod.s3.tfbackend と -var-file=envs/prod.tfvars を毎回正しく指定する運用ルールが要る
CLI workspace全 workspace が backend とコードを共有する。認証情報やアクセス制御を分けたい本番隔離には向かない

運用で事故を防ぐ指示

AI に実装させる場合

構成図ツール

ツール向いているケース
draw.io(.drawio.svg で保存)迷ったらこれ。GitHub でプレビューでき再編集もできる。ネットワーク境界を正確に描ける
MermaidState 間の参照関係やデータフローなどテキスト差分で管理したい図。入れ子の深い配置図は崩れやすい
Diagrams(Python)公式アイコン付きの配置図をコードで管理。Graphviz が要る
Eraser / Lucidchartデザイン性・同時編集重視の SaaS。構成情報を外部に上げてよいかの確認が要る
Inframap / Rover / terraform graph実装後にコードや State から逆生成して設計図と突き合わせる

関連ページ

ソース記事