出力の定義

各モジュールの出力値をまとめて、environments/test/outputs.tfに定義します。すべてのモジュールの構築が完了したので、terraform applyの実行結果にURLやリソースIDを表示することで、デプロイ後の確認を効率化します。

1. コードの記載

ここでは、各モジュールの出力値をまとめてterraform applyの実行結果に表示するための出力(output)を定義します。Terraformでは、outputブロックを使い、module.<モジュール名>.<出力名>で各モジュールの値を参照します。

1.1 outputs.tf

environments/test/outputs.tfに以下の内容を記述します。

output "api_alb_dns_name" {
  description = "API ALBのDNS名"
  value       = module.api.alb_dns_name
}

output "ecs_cluster_name" {
  description = "ECSクラスタ名"
  value       = module.api.cluster_name
}

output "ecs_service_name" {
  description = "ECSサービス名"
  value       = module.api.service_name
}

output "frontend_url" {
  description = "フロントエンドURL"
  value       = "https://${var.domain_name}"
}

output "api_url" {
  description = "API URL"
  value       = "https://api.${var.domain_name}"
}

output "cloudfront_distribution_id" {
  description = "CloudFrontディストリビューションID"
  value       = module.frontend.cloudfront_distribution_id
}

コードを解説します。

api_alb_dns_name / ecs_cluster_name / ecs_service_name

output "api_alb_dns_name" {
  value       = module.api.alb_dns_name
}

output "ecs_cluster_name" {
  value       = module.api.cluster_name
}

output "ecs_service_name" {
  value       = module.api.service_name
}

apiモジュールから受け取った値を出力します。api_alb_dns_nameはALBのDNS名、ecs_cluster_nameとecs_service_nameはCLIでECSサービスを操作する際(タスクの再起動やログの確認など)に必要な値です。

frontend_url / api_url

output "frontend_url" {
  value       = "https://${var.domain_name}"
}

output "api_url" {
  value       = "https://api.${var.domain_name}"
}

フロントエンドとAPIの完全なURLを出力します。terraform applyの実行後にこれらのURLが表示されるため、デプロイ後すぐにアクセス先を確認できます。

cloudfront_distribution_id

output "cloudfront_distribution_id" {
  value       = module.frontend.cloudfront_distribution_id
}

CloudFrontディストリビューションIDを出力します。フロントエンドの更新後にキャッシュを無効化するaws cloudfront create-invalidationコマンドで使用します。

2. 差分の確認

terraform planで差分を確認します。

terraform plan

以下のような実行結果が表示されます。

Changes to Outputs:
  + api_alb_dns_name           = "test-noteapp-api-alb-xxxxxxxxx.ap-northeast-1.elb.amazonaws.com"
  + api_url                    = "https://api.example.com"
  + ecs_cluster_name           = "test-noteapp-cluster"
  + ecs_service_name           = "test-noteapp-api"
  + cloudfront_distribution_id = "EXXXXXXXXXXXXX"
  + frontend_url               = "https://example.com"

Plan: 0 to add, 0 to change, 0 to destroy.

リソースの変更はなく、出力値のみが追加されることを確認してください。

3. AWSへの反映

terraform applyで出力値を反映します。

terraform apply

確認プロンプトが表示されたら、yesと入力して実行します。以下のように、リソースの変更がないことを確認します。

Apply complete! Resources: 0 added, 0 changed, 0 destroyed.