Terraform設計ガイドライン
Terraform Design Guidelines
Skip to content
はじめに
Terraformはインフラを宣言的にコード管理するツールであるが、特に大規模なシステムでは扱うリソース数が増え、必然的にTerraformコードも複雑化する傾向にある。Terraformの可読性が低下すると、作業効率の低下だけではなく影響度が大きいミスを誘発する懸念がある。
また、Terraformは活発に機能開発が継続されており新しい機能／記述方法もリリース毎に追加されている。これは嬉しい反面、新規開発者が悩むポイントも増えたと言える。関連して、チームやプロジェクトごとに設計方針が異なる場合も多く、Terraformの熟練者であってもそれぞれのコードベースに慣れるまで時間を要することも往々にしてある。
本ガイドラインは、各開発者が悩むポイントを軽減し、可読性や保守性、安全性を高めるルールをまとめ、設計のベースラインとするために作成された。それにより、生産性の向上・レビュー負荷の軽減・ナレッジやツールの横展開の支援・技術レベルの底上げを目指すものとする。
免責事項
- 有志で作成したドキュメントである。フューチャーには多様なプロジェクトが存在し、それぞれの状況に合わせて工夫された開発プロセスや高度な開発支援環境が存在する。本ガイドラインはフューチャーの全ての部署／プロジェクトで適用されているわけではなく、有志が観点を持ち寄って新たに整理したものである
- 相容れない部分があればその領域を書き換えて利用することを想定している。プロジェクト固有の背景や要件への配慮は、ガイドライン利用者が最終的に判断すること。本ガイドラインに必ず従うことは求めておらず、設計案の提示と、それらの評価観点を利用者に提供することを主目的としている
- 掲載内容および利用に際して発生した問題、それに伴う損害については、フューチャー株式会社は一切の責務を負わないものとする。掲載している情報は予告なく変更する場合がある
適用範囲
対象とする技術は以下を想定している。
- Terraform 1.10+
- OSS利用のみ（HCP Terraformは利用しない）
- AWS、Google Cloud、Azureなどのクラウドサービスに対しての利用
利用者は以下の技術を理解しているとし、本ガイドラインではこれらについて解説はしない。
- 基本的なTerraformの知識と理解
- Gitの基本的な知識
- CI/CDの基本的な知識
本ガイドラインの適用範囲は、Terraformの設計、開発時に利用することを想定している。クラウドサービス上の技術選定、サービス設計の手法については本ガイドラインで対象外とする。
用語定義
| 用語 | 説明 |
|---|---|
| ルートモジュール | terraformコマンドを実行するディレクトリ上にある .tf リソース |
| モジュール | 本ガイドラインでは、ルートモジュールから利用される子モジュールのことを指す |
参考資料
- Terraform を使用するためのベスト プラクティス | Google Cloud
- コードベースの構造と組織のベストプラクティス - AWS 規範ガイダンス
- 最低限のTerraformコード規約を定義した | Zenn
謝辞
このアーキテクチャガイドラインの作成には多くの方々にご協力いただいた。心より感謝申し上げる。
- 作成者: 真野隼記、牛田隆之、前原応光、伊藤太斉、金澤祐輔、天明昂輝、神崎林太郎
Articles
- 2025.04.09 Terraform設計ガイドラインを公開しました