depends_on
前のセクションでは、リソースの値を参照することで、Terraformが自動的に作成順序を判断してくれる「暗黙的な依存関係」について学びました。
1. depends_onが必要な理由
前のセクションでは、リソースの値を参照することで、Terraformが自動的に作成順序を判断してくれる「暗黙的な依存関係」について学びました。
しかし、「リソース同士で値の参照(idなど)はしていないけれど、作成順序を守らせたい」というケースが存在します。このような場合に利用するのが、depends_on というメタ引数です。
Terraformは基本的に、依存関係のないリソースは可能な限り並列(同時)に作成して、構築時間を短縮しようとします。
しかし、これによって困る場面があります。例えばアプリケーションのセットアップ時です。
「Webサーバ」と「データベース」を作るとします。これらが同時に作られ始めた場合、データベースの構築が完了する前に、Webサーバが起動してデータベースへ接続を試みてしまい、エラーになる(アプリケーションが起動しない)可能性があります。
この場合、「データベースの作成が完全に終わってから、Webサーバを作り始めてほしい」という指示を出す必要があります。
2. depends_onの書式
リソースブロックの中に、以下のように記述します。こうすることで、depends_on の中で定義したリソースが作成されるまで、作成が保留されます。
resource "リソース型" "名前" {
depends_on = [
リソース型.依存先のリソース名
]
}
また、depends_on の中には複数のリソースを、カンマ区切りで記載することができます。
resource "リソース型" "名前" {
depends_on = [
リソース型.依存先のリソース名1,
リソース型.依存先のリソース名2
]
}
3. サンプルコード(EC2とRDSの例)
ここでは概念を理解するために、EC2(Webサーバ)とRDS(データベース)の例を見てみましょう。
EC2の設定の中で、RDSのIDなどを直接参照していない場合でも、depends_on を使うことで順序を強制できます。
# 1. データベース (RDS)
resource "aws_db_instance" "db" {
allocated_storage = 10
engine = "mysql"
instance_class = "db.t3.micro"
username = "admin"
password = "password"
# ...その他の設定
}
# 2. Webサーバ (EC2)
resource "aws_instance" "web" {
ami = "ami-0abcdef1234567890"
instance_type = "t2.micro"
# ここがポイント
# "aws_db_instance.db" の作成完了を待ってから、このEC2を作り始める
depends_on = [
aws_db_instance.db
]
}
このように、aws_instance.web 側に depends_on で aws_db_instance.db を指定することで、aws_db_instance.db が確実に作成されてから、aws_instance.web が作成されます。
なお、EC2とRDSは作成に時間がかかりコストも発生しやすいこと、また作成順序の制御は裏側の処理であり挙動が見えにくいため、今回はハンズオンを省略します。
4. 注意点
depends_on は便利な機能ですが、多用しすぎるとTerraformのメリットである「並列実行による高速化」を損なってしまいます。
前回学んだ「値の参照(暗黙的な依存関係)」で解決できる場合はそちらを優先し、どうしても順序制御が必要な場合のみ depends_on を使用するのがベストプラクティスです。