Terraform を図に変換

使い方

1. 01

   Terraform を貼り付けるかドロップ

   .tf ファイル 1 つ、同じモジュールの複数ファイル、または保存したプランや state について terraform show -json が出力する JSON を使えます。terraform init は不要です。

2. 02

   構成図を確認

   各リソースは、コンピュート、データベース、キューなど種類ごとのカードになります。ネットワーク、サブネット、リソースグループは、その中に配置されたリソースを囲む枠になります。

3. 03

   Archboard で開く

   新しい図として保存すれば、カードの配置変更、メモの追加、リンクの共有、SVG・PNG へのエクスポートができます。登録は Google か GitHub のアカウントだけで済みます。

Terraform コードから描かれるもの

図は構成内の次のブロックと引数から作られます。

• resourcedata

  リソースを種類ごとのカードとして描きます。aws_lb_target_group_attachment のようなつなぎ役のリソースは接続線に、aws_s3_bucket_versioning のような設定用のリソースはバケットのカードに折りたたまれます。data ソースは、中にリソースが配置されない限り省略されます。

• depends_on

  あるリソースから別のリソースへの参照（aws_iam_role.app.arn など）ごとに接続線を描きます。文字列、ヒアドキュメント、locals の中の参照も対象です。depends_on は破線の接続線を追加します。ただし、2 つのリソースがすでに参照でつながっている場合や、参照先が time_sleep のように表示しない補助リソースの場合は追加しません。

• vpc_idsubnet_id

  vpc_id と subnet_id による配置。1 つのサブネットにあるリソースはそのサブネットの中に、VPC の複数のサブネットにまたがるリソースは VPC の枠に入り、Azure のリソースはリソースグループの中に入ります。

• modulesource

  各 module ブロックをカードとして描きます。terraform-aws-modules/vpc/aws、eks、rds などのよく知られた Registry モジュールは、作成するネットワーク枠、クラスター、データベースとして描かれ、VPC モジュールのサブネットを使うリソースはその枠の中に入ります。

• resource_changes

  プランの JSON では、各リソースのカードにプランが行う変更が表示されます。+ は作成、~ は更新、− は削除、± は置き換えです。プランで変更されないリソースには印が付きません。VPC やサブネットなどの枠と、カードに折りたたまれた設定用のリソースにも印は付きません。

• awsazurermgoogle

  AWS、Azure、Google Cloud のリソースを描き、複数のプロバイダーを使っていれば 1 つの図にまとめます。専用カードのない種類は、リソースの種類を表示する汎用カードになります。

Terraform プランの可視化

プランの JSON を使うと最も完全な図になります。count と for_each は実際のインスタンス数になり、モジュールは中のリソースまで展開され、リソースのカードに予定された変更の印が付きます。ふだん terraform plan を実行する場所で次の 2 つのコマンドを実行し、JSON を貼り付けてください。

1. プランを作成して plan.out に保存します。何も適用しません。

   terraform plan -out plan.out

2. 保存したプランを JSON で出力します。出力を貼り付けるか、plan.json にリダイレクトしてそのファイルをここにドロップしてください。

   terraform show -json plan.out

Terraform の構成図に含まれないもの

• 変数と locals の値、.tfvars ファイル、tags、user_data などの属性値。カードには bucket や function_name のような固定の名前、なければコード上のリソース名が付きます。
• .tf ファイルでの count と for_each の展開。構成は評価されないため、count = 3 のリソースは ×3 の付いた 1 枚のカードに、for_each のリソースは ×N の付いたカードになります。実際のインスタンス数を見るにはプランの JSON を貼り付けてください。
• リモートモジュールの中身。Registry や Git のモジュールはダウンロードしません。よく知られたモジュール以外は 1 枚のカードのままで、中のリソースはプランの JSON で表示されます。
• クラウドの実際の状態、ドリフト、コスト、実行時にどのサービスがどのサービスを呼び出しているか。図が表すのは構成がリソースをどうつないでいるかで、トラフィックではありません。