Terraform Cloudで別のWorkspaceのStateファイルの値を参照する

佐藤雅樹

2023.05.17

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

「Terraform Cloudで別のWorkspaceのStateファイルを参照するには、どうしたらいいんだろう？」

Terraformを書いていると、別のStateファイルの情報を参照したくなることがあります。

Terraform Cloudの場合、どんな操作が必要かをブログにしてみました。

結論

参照される側
- WorkspaceのRemote state sharingの設定で参照側のWorkspaceを許可
- 参照される値をoutputで定義
参照する側
- data.terraform_remote_stateで該当の値を取得

例えば、VPC IDを他のWorkspaceで参照する場合は以下のようになります。

resource "aws_vpc" "main" {
  cidr_block       = "10.0.0.0/16"

  tags = {
    Name = "main"
  }
}

output "vpc_id" {
    value = aws_vpc.main.id
}

# OrganizationやWorkspaceを指定してdataで取得
data "terraform_remote_state" "vpc" {
  backend = "remote"

  config = {
    organization = "<Organization名>"
    workspaces = {
      name = "<参照側のWorkspace名>"
    }
  }
}

resource "aws_security_group" "test" {
  name        = "test"
  description = "test"
  # VPC IDを取得
  vpc_id      = data.terraform_remote_state.vpc.outputs.vpc_id
}

補足

参照する側Workspaceの実行モードがLocalの場合、参照される側の以下の作業は不要です。

WorkspaceのRemote state sharingの設定で参照側のWorkspaceを許可

現時点(2023/05/14)では、実行モードLocal参照される側のRemote state sharingで参照側を許可していなくても、参照が可能でした。

やってみる

以下の2つのWorkspace/Stateファイルがあると仮定します。

VPC(参照される側)
セキュリティグループ(参照する側)

セキュリティグループ WorkspaceでVPC WorkspaceのからVPC IDを参照して、セキュリティグループを作成します。

サンプルコードはGithubにあります。

実際に試す場合は、backend.tf.sampleの値を適切な値に修正して、backend.tfにファイル名を変更してください。

terraform-sample/tfstate-ref-tfc at main · msato0731/terraform-sample

Terraformコードの用意

以下のディレクトリ構成になっています。

VPCとSecurity GroupでStateファイルを分けている構成です。

$ tree  
.
├── security-group
│   ├── backend.tf
│   └── main.tf
└── vpc
    ├── backend.tf
    └── main.tf

必要な部分だけ抜粋して、紹介します。

参照される側のVPCのコードでは、VPC IDをOutputとして定義しています。

# 省略
resource "aws_vpc" "main" {
  cidr_block       = "10.0.0.0/16"

  tags = {
    Name = "main"
  }
}

output "vpc_id" {
    value = aws_vpc.main.id
}

参照する側のSecurityGroupのコードでは、dataでWorkspaceのOutputを取得して、VPC IDをセットしています。

# VPC WorkspaceのState取得
data "terraform_remote_state" "vpc" {
  backend = "remote"

  config = {
    organization = "<Organization名>" # 要修正
    workspaces = {
      name = "tfstate-ref-tfc-test-vpc"
    }
  }
}

resource "aws_security_group" "test" {
  name        = "test"
  description = "test"
  # VPC ID取得
  vpc_id      = data.terraform_remote_state.vpc.outputs.vpc_id
}

コードの用意ができたら、terraform initを実行してWorkspaceを作成します。

作成したWorkspaceでTerraform CloudでAWSリソースを作成できるように、AWS認証情報の設定を行なってください。

この時点でVPCの方は、terraform plan/applyに成功します。

しかし、Security Groupの方はVPC WorkspaceのState Fileを参照できず失敗します。

次の手順でSecurity Group Workspaceを許可してください。