1.はじめに
Terraform では、ステートファイルを「環境(prod / stage / test など)」ごとに分割し、
ファイルレイアウトで管理するケースがよくあります。
しかし、この方法では次の問題が発生しがちです。
- 各環境に 同じコンポーネント(例:DB、VPC、Webサーバ) のコードが複数存在する
- 設定の重複によって メンテナンス性が低下する
- 修正時に複数ファイルを横断的に変更する必要があり、事故の原因となる
一般的に「同じコードがあちこちに散らばって存在する状態」は、
インフラコードの観点でも望ましくありません。
✦コンポーネントを共有する発想
環境に依存しない 共通のコンポーネント(例:共通VPC、共通DB、共通ALB)を
一つのコード+ステートファイルとして管理し、他の環境(prod/stage/test)から必要な情報だけを読み出すことで、コードの重複を避けられます。
これにより、
- 各環境から「共通コンポーネント」を参照できる
- 1つのステートファイルだけをメンテすればよい
- インフラ構成全体がモジュール的・再利用的に整理できる
- 修正の意図や依存関係が明確になる
といったメリットが得られます。
✦コンポーネントの共有ステートとは?
このように、環境横断で共通化するコンポーネントを
1つのステートファイル(.tfstate)で管理したものを、
本記事では コンポーネントステート と呼ぶことにします。
コンポーネントステートにより、Terraform コードはより柔軟かつ安全に運用でき、
環境ごとの冗長な重複や保守コストが削減されます。
2.読み出される側(ステートを渡す側)の設定
2-1. output を定義する
他のコンポーネントがコンポーネントステートを参照するには、
共有したい値を output ブロックで明示的に公開する必要があります。
たとえば、DB をコンポーネントとして他の環境から利用したい場合、
DB 接続先情報や認証情報などを output に定義します。
output "db_endpoint" {
value = aws_db_instance.example.endpoint
}
output "db_password" {
value = var.db_password
sensitive = true
}
output に設定された値だけが、
後述する terraform_remote_state から読み出せる対象になります。
2-2. コンポーネントステートが "S3" に保存されていることを確認する
コンポーネントステートは、S3 をバックエンドとして保存されている必要があります。
管理コンソールで以下を確認します。
- 指定した S3 バケット内にステートファイル(.tfstate)が存在している
- key のパスが、記事内で紹介する terraform_remote_state の指定内容と一致している
S3 上にステートが存在していれば、そのステートは他のコンポーネントから参照可能な
「共有コンポーネント」として機能します。
3.読み出す側(terraform_remote_stateを使う側)の設定
3-1. terraform_remote_state を定義する
コンポーネントステートからリソースを読み出すには、
Terraform のdata "terraform_remote_state"ブロックで S3 のステート情報を指定します。
data "terraform_remote_state" "db" {
backend = "s3"
config = {
bucket = "terraform-example-state"
key = "third/stage/database/terraform.tfstate"
region = "ap-northeast-1"
}
}
各項目の意味は以下のとおりです。
| 項目 | 意味 |
|---|---|
data "terraform_remote_state" "db" |
"db"はこのコード内で識別するためのローカル名(任意) |
backend = "s3" |
読み出し先のステートが S3 バックエンドで管理されている、という宣言 |
bucket |
ステートファイルが格納されている S3 バケット名 |
key |
ステートファイルのパス(バックエンド設定の key と一致している必要がある) |
region |
ステートバケットが存在する AWS リージョン |
このように設定することで、読み出し側の Terraform から
data.terraform_remote_state.db.outputs.db_endpoint
のように値へアクセスできるようになります。
3-2. ※注意:旧バージョンとの変更点
Terraform 0.12 以前では、次のように書けていましたが、
現在はサポートされていません。
data "terraform_remote_state" "db" {
backend "s3" {
...
}
}
現在は必ず backend = "s3" とし、設定は config = { ... } に書く必要があります。
4.ステート読み出し設定のチェックリスト
ステートの読み出しは、Terraform の失敗ポイントになりやすい部分です。
以下のチェックリストを満たしていれば、ほぼ確実に読み出しに成功するはずです。
読み出される側(ステートを渡す側) の確認
-
対象の tfstate が S3 に存在する
→ 実ファイルがない場合、remote_state は必ず失敗します。 -
terraform output欲しい値の output が出力される
→outputに定義されていない値は、読み出す側から参照できません。
読み出す側(terraform_remote_state を使う側) の確認
-
backendとconfigのbucket / key / regionが正しい
→ コンポーネントステートのバックエンド設定と一致している必要があります。 -
読み出す側の AWS 認証情報(profile / role)に S3 バケット読み取り権限がある
→ 権限がないと アクセス拒否(403)で読み取りエラーが発生します。 -
コード上で参照している output 名と、読み出し元側の output 名が一致している
例)data.terraform_remote_state.db.outputs.alb_dns_name
5.まとめ
コンポーネントステートを活用することで、Terraform の構成は下記のように改善されます。
- 環境ごとに分散しがちな同じコンポーネントの重複を回避できる
- 共通コンポーネント(VPC、DB、ALB など)を一元管理できる
- コードの DRY 原則(Don't Repeat Yourself)を自然に満たせる
- 保守性・安全性が飛躍的に向上する
- 複数環境を扱うチーム開発に相性が良い
また、Terraform を モジュール化 する際にも、この共有ステートの仕組みは非常に使い勝手がいいです。