0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

【Terraform】別のStateの値を受け取る3つの方法:terraform_remote_state・SSM Parameter Store・データソース

0
Posted at

Terraformの構成が大きくなると、ネットワーク・データベース・アプリケーションのように、Stateを分けて管理することが多くなります。そのとき困るのが、別のStateで作ったリソースのIDを、どうやって受け取るかです。たとえば、アプリケーションの構成で、ネットワークの構成が作ったVPCやサブネットのIDを使いたい場面です。

この記事では、別のStateの値を受け取る3つの方法と、それぞれの使い分けを紹介します。

3つの方法

  • terraform_remote_state:別のStateファイルを直接読み、outputの値を受け取る
  • SSM Parameter Store:渡す側がParameter Storeに値を書き、受け取る側が読む
  • データソースで検索する:タグなどの条件で、AWS上のリソースを直接探す

方法1:terraform_remote_state

渡す側(ネットワークの構成)で、outputを定義します。

# network/outputs.tf
output "vpc_id" {
  value = aws_vpc.main.id
}

output "private_subnet_ids" {
  value = aws_subnet.private[*].id
}

受け取る側(アプリケーションの構成)で、そのStateを読みます。

# app/main.tf
data "terraform_remote_state" "network" {
  backend = "s3"

  config = {
    bucket = "tfstate-123456789012"
    key    = "myapp/prod/network/terraform.tfstate"
    region = "ap-northeast-1"
  }
}

resource "aws_security_group" "app" {
  name   = "myapp-app"
  vpc_id = data.terraform_remote_state.network.outputs.vpc_id
}

よいところ

  • 追加のリソースが要らず、すぐに使える
  • outputを足せば、受け取れる値も増やせる

注意点

  • 受け取る側に、渡す側のStateファイル全体を読む権限が必要になる。Stateにはパスワードなどの機密情報が含まれることがあり、outputにしていない値も読めてしまう
  • Stateの置き場所(バケット名やkey)を、受け取る側が知っている必要がある。置き場所を変えると、受け取る側もすべて直す必要がある

方法2:SSM Parameter Store

渡す側が、受け取ってほしい値だけをParameter Storeに書き込みます。

# network/main.tf
resource "aws_ssm_parameter" "vpc_id" {
  name  = "/myapp/prod/network/vpc_id"
  type  = "String"
  value = aws_vpc.main.id
}

resource "aws_ssm_parameter" "private_subnet_ids" {
  name  = "/myapp/prod/network/private_subnet_ids"
  type  = "StringList"
  value = join(",", aws_subnet.private[*].id)
}

受け取る側は、データソースで読みます。

# app/main.tf
data "aws_ssm_parameter" "vpc_id" {
  name = "/myapp/prod/network/vpc_id"
}

data "aws_ssm_parameter" "private_subnet_ids" {
  name = "/myapp/prod/network/private_subnet_ids"
}

locals {
  vpc_id             = data.aws_ssm_parameter.vpc_id.value
  private_subnet_ids = split(",", data.aws_ssm_parameter.private_subnet_ids.value)
}

よいところ

  • 受け取る側は、公開された値だけを読める。Stateファイルを読む権限は要らない
  • IAMで、パラメータのパス(/myapp/prod/network/ など)ごとに読める範囲を絞れる
  • Terraform以外(アプリケーションやシェルスクリプト)からも、同じ値を読める

注意点

  • 渡したい値ごとに、パラメータのリソースを書く必要がある
  • 機密情報を渡す場合は、type を SecureString にする

方法3:データソースで検索する

渡す側で何も用意せず、受け取る側がタグなどでリソースを探す方法です。

data "aws_vpc" "main" {
  tags = {
    Project     = "myapp"
    Environment = "prod"
  }
}

data "aws_subnets" "private" {
  filter {
    name   = "vpc-id"
    values = [data.aws_vpc.main.id]
  }

  tags = {
    Tier = "private"
  }
}

よいところ

  • 渡す側の構成を変える必要がない
  • Terraform以外で作ったリソースも探せる

注意点

  • 条件に合うリソースが0件や2件以上だと、エラーになる(aws_vpc の場合)。タグの付け方をそろえておく必要がある
  • どの構成がそのリソースを作ったのかが、コードから分かりにくい

どれを選ぶか

  • 小さな構成で、同じチームだけが使う:terraform_remote_state で十分
  • Stateを読む権限を分けたい、Terraform以外からも値を使いたい:SSM Parameter Store
  • Terraformで作っていないリソースを参照したい:データソースで検索する

チームやシステムが増えてきたら、SSM Parameter Storeを使う方法がおすすめです。渡す側が「公開する値」を決め、受け取る側はそれだけを使う形になるため、構成どうしのつながりが分かりやすくなり、権限も絞れます。

適用する順番に注意する

どの方法でも、渡す側を先にapplyしておく必要があります。受け取る側を先にplanすると、値がまだ存在しないためエラーになります。

  • ネットワーク → データベース → アプリケーション、のように依存する順番を決めておく
  • CIでも、この順番でapplyされるようにジョブを並べる

また、渡す側で値が変わった場合(サブネットを作り直したなど)、受け取る側は次にplan・applyするまで古い値のままです。渡す側を変更したら、受け取る側のplanも確認します。

まとめ

  • 別のStateの値を受け取る方法には、terraform_remote_state、SSM Parameter Store、データソースでの検索がある
  • terraform_remote_state は手軽だが、Stateファイル全体を読む権限が必要になる
  • SSM Parameter Store なら、公開する値だけを渡せて、権限も絞れる
  • データソースでの検索は、タグの付け方をそろえておく必要がある
  • 渡す側を先にapplyし、変更したら受け取る側のplanも確認する

Stateを分けると、1回のapplyの影響範囲が小さくなり、安心して変更できるようになります。値の受け渡し方を最初に決めておくと、分けたあとの運用もスムーズです。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?