■ はじめに

Terraform （テラフォーム）について、学ぶ。

【１】Terraform
　１）使用言語
　２）サポートOS
【２】Core Terraform Workflow
　１）Write
　２）Plan
　３）Apply
【３】主なTerraformコマンド一覧
【４】その他の便利コマンド一覧
　１）terraform state
　２）terraform show
　３）terraform refresh
　４）terraform workspace
　５）terraform fmt
　６）terraform graph
　７）terraform import

【１】Terraform

* Vagrant を開発しているHashiCorp社が提供する
　環境構築するためのIaC（Infrastructure as Code）ツール
 => 独自の設定ファイル (拡張子 .tf) から IaC できる

１）使用言語

* HCL（HashiCorp Configuration Language）という
　HashiCorp社製品で使われている独自の言語で記述

２）サポートOS

* 主要なOSは全て網羅
 + Windows
 + Mac
 + Linux

https://developer.hashicorp.com/terraform/downloads

【２】Core Terraform Workflow

* 以下の公式ドキュメントより
 => こういうシンプルなコンセプトは、非常にいいと思う

https://developer.hashicorp.com/terraform/intro/core-workflow

１）Write

* まずは、環境設定をTerraformコードとして書く。

２）Plan

* 「terraform plan」などで、デプロイ前に差分を見て、計画する

３）Apply

* Terraformコードを適用して、デプロイする

【３】主なTerraformコマンド一覧

Command	Explanation	Memo
terraform init	初期化処理
terraform plan	変更内容を確認する
terraform apply	Terraformコードを実行する
terraform destroy	Terraformコードで作成したリソースを削除	実行前に「terraform plan -destroy」がよさげ

terraform destroy
https://developer.hashicorp.com/terraform/cli/commands/destroy

【４】その他の便利コマンド一覧

Command	Explanation	Memo
terraform state	stateに関するコマンド
terraform show	管理しているリソースを表示
terraform refresh	stateと実際のInfra状況を同期するようなコマンド
terraform workspace	workspaceに関するコマンド
terraform fmt	HCLファイルをフォーマット	terraform fmt -recursive
terraform graph	Terraformの依存関係をグラフ化	dot -Tpng > graph.png
terraform import	既存のインフラストラクチャをTerraformの管理下に置くためのコマンド	terraform import [tfファイルのtypeとName] [対象リソース]

１）terraform state

Command	Explanation	Memo
terraform state list	使用しているリソースを一覧表示
terraform state mv	State内のリソース名を変更
terraform state rm .	リソースをTerraformの管理から外す	★お勧め★
terraform state pull	現在のStateをBackendからダウンロードし、表示
terraform state push	ローカルのStateファイルをリモートのBackendにアップロードする
terraform state show	リソースの詳細を表示	terraform showコマンドのリソース指定版

terraform state list
https://developer.hashicorp.com/terraform/cli/commands/state/list

terraform state rm
https://developer.hashicorp.com/terraform/cli/commands/state/rm

* Stateファイルで管理されているリソースを削除（除外）する

https://zenn.dev/toritori0318/articles/983bd73e2d2158

にあるように、不整合が起きて、
terrraform refresh (後述「３）terrraform refresh」)しても
状況が変わらない時に、使用したら解決できた。

２）terraform show

https://developer.hashicorp.com/terraform/cli/commands/show

* stateファイルを元に現在のリソースの状態を参照するコマンド
 => あくまで、現在の状態。terraform plan後の表示じゃない。

３）terrraform refresh

https://developer.hashicorp.com/terraform/cli/commands/refresh

* stateと実際のInfra状況を同期するようなコマンド

４）terraform workspace

https://developer.hashicorp.com/terraform/language/state/workspaces
そもそも「Workspace」とは？

* 同一の tfファイル群を別の tfsate として扱うことができる機能

* 使用例については、以下の関連記事を参照のこと

https://dk521123.hatenablog.com/entry/2023/05/06/003645

Command	Explanation	Memo
terraform workspace list	既存のworkspaceを一覧表示
terraform workspace new	Workspaceの新規作成	terraform workspace new prod
terraform workspace select	Workspaceの選択	terraform workspace select prod
terraform workspace delete	Workspaceの削除	terraform workspace delete prod
terraform workspace show	選択中のWorkspaceを表示

５）terraform fmt

* TFコードを整形してくれる（インデントの統一など）
 => 改行とかはそのまんまだった

https://developer.hashicorp.com/terraform/cli/commands/fmt

terraform fmt コマンド実行前

data "external" "hello_world" {
  program =         ["python", "hello_world.py"]

  query = {
               name = "Mike"
  }

}

output "result" {
                    value   =   data.external.hello_world.result["result"]
}

terraform fmt コマンド実行後

data "external" "hello_world" {
  program = ["python", "hello_world.py"]

  query = {
    name = "Mike"
  }

}

output "result" {
  value = data.external.hello_world.result["result"]
}

６）terraform graph

* terraform graphで、Terraformの依存関係をグラフ化することが可能

https://developer.hashicorp.com/terraform/cli/commands/graph

terraform graph | dot -Tsvg > graph.svg

# PNGだと、システムがでかくなると画像が荒くて文字が見れない可能性あり
terraform graph | dot -Tpng > graph.png

# それ以外の対応画像形式は、以下を参照のこと。

https://www.graphviz.org/docs/outputs/

補足：GraphViz

* ただし、GraphViz が必要。
* DOT言語/GraphViz に関する詳細は、以下の関連記事を参照のこと

Python + DOT言語で図作成するには
https://dk521123.hatenablog.com/entry/2023/06/14/174104
DOT言語～環境設定編～
https://dk521123.hatenablog.com/entry/2023/07/18/120407

７）terraform import

# terraform import [tfファイルのtypeとName] [対象リソース]
terraform import aws_s3_bucket.sample_bucket sample-bucket

https://go-journey.club/archives/17121
https://tech.layerx.co.jp/entry/improve-iac-development-with-terraform-import

参考文献

https://minegishirei.hatenablog.com/entry/2023/01/27/120400

プログラムの超個人的なメモ

Memo for Programming.

【Terraform】Terraform ～入門編～

■ はじめに

目次

【１】Terraform

１）使用言語

２）サポートOS

【２】Core Terraform Workflow

１）Write

２）Plan

３）Apply

【３】主なTerraformコマンド一覧

【４】その他の便利コマンド一覧

１）terraform state

２）terraform show

３）terrraform refresh

４）terraform workspace

５）terraform fmt

６）terraform graph

７）terraform import

参考文献

関連記事