背景

業務でterraformを使ってAWSリソースをデプロイする機会が増えてきたので、自分用の備忘録としてコマンドチートシートを作成しました。

terraformとは何か

Terraformとは、 HashiCorp社によって開発されたオープンソースのサービスで、開発環境を効率的に構築できるIaC（Infrastructure as Code）ツールの一種です。クラウドサーバーなどシステム開発に必要なインフラを、コードを記述することにより自動で構築できます。また、インフラの構成管理などもTerraformのコードによる宣言が可能な事も特徴です。

コマンド

# バージョン確認
$ terraform -v

# 初期化
$ terraform init

➡terraform作業ディレクトリの初期化　※一番最初に実施すること
　.tf ファイルで利用している pluginのダウンロード処理等が走る
　このコマンドは複数回実行しても問題ありません。

# バックエンドをローカルからS3に移行

$ terraform init -migrate-state
 ⇒ 既存の状態を保ちながら、バックエンドを更新するオプション

# terraform init -reconfigure
 ⇒ 既存の状態を保持せずバックエンドを更新するオプション

# コードのフォーマット調整
$ terraform fmt
# サブディレクトリも含める
$ terraform fmt -recursive

# リソース確認
$ terraform plan

# 個別にリソース確認
$ terraform plan -target={resource}

# ファイル出力(色文字コード抜き)
$ terraform plan -no-color > nocolor.txt

# リソース投入
$ terraform apply

# 個別にリソース投入
$ terraform apply -target={resource}

# リソース投入(強制yes)
$ terraform apply -auto-approve

# リソース削除確認
$ terraform plan -destory

# リソース削除
$ terraform destory

# リソース削除(強制yes)
$ terraform destory -auto-approve

# 現在のリソースの状態(中身)を確認
$ terraform show

# tfstateで管理しているリソース一覧表示
$ terraform state list

# tfstate管理からリソースを削除
$ terraform state rm ${リソース名}

# tfstate管理に既存リソースを追加
$ terraform import ${tfstate上で管理したい名前} ${リソース名}

# 特定のモジュールのみ実行
$ terraform [plan|apply|destroy] -target=module.${モジュール名}

# outputに記載された内容を出力
$ terraform output

おまけ

# terraform コマンド省略(エイリアス)
$ alias tf = 'terraform'
➡これで若干コマンドを短くできます。
　例)tf state list