terraformの仕組みざっくり解説
terraformを業務で使用しており、なんとなく動かしてはいるけど動いている仕組みについて理解できていなかったので調べてみました
想定読者
- 既存のterraformを編集して、planとapplyは行っているが、自分で構築したことはない
- terraformの動作原理について知りたい
terraform is 何？
詳細な説明はいろんな記事があるので割愛しますが、一言でいうと
「IaCを用いてインフラ構成をコードで管理するツール」
です
OSSでソースコードもみることができます
terraformよく使うコマンドの詳細
terraform init
初期化を行います。
.terraformというディレクトリが作られ、プロバイダープラグインとモジュールをキャッシュします。
tfstateがローカルで保持している場合はtfstate本体、S3においている場合はその場所へのリンクが記載されたterraform.tfstateが作成される
tfstateが何かはあとで解説しますが、terraformが管理しているインフラの状態を保持しておくファイルと捉えてください。
プロバイダープラグインは以下に一覧がありますが、各リソースをterraformで管理するためのプラグインというイメージでよいと思います。
(AWS用のプラグイン、Azure用のプラグインなどなど・・・)
terraform plan
.tfstateとの差分を検知して、必要な修正を出力してくれます。
変化した内容によって、再作成が必要なインスタンスはdelete → createの動きになるし、In Placeで変更が可能なものはIn Placeで変更するようにterraformで判断してくれます。
terraform apply
terraform planででてきた内容を適用します。
たまにplanでエラーなかったけどapplyできないなんてこともあるので注意
terraform destroy
applyの逆、管理しているリソースを全部削除する操作です。
tfstate
json形式で書かれている、terraformが管理するリソースの状態や依存関係が書かれているファイルです。
デフォルトではローカルの .terraform配下にありますが、設定するとS3においてPJ内で共有できます。
ロック用のファイルをDynamoDBで管理して、競合して編集できないように設定ができます。
こんな感じ
terraform {
backend "s3" {
bucket = "hogehoge"
key = "hoge/fuga/terraform.tfstate"
region = "ap-northeast-1"
dynamodb_table = "hoge-lock"
}
}
tfstateの中身は以下のようなコマンドを用いて見ることができます。
- terraform graph
-
terraform graph | dot -Tsvg > graph.svgとかでリソースの依存関係がsvgで出力できる
-
- terraform show
- terraform list
また、既存のリソースをtfstate管理下においたり、はずしたり、移動させたりということができます。
- terraform import
- リソースをterraform管理下におく
- terraform mv
- terraformのコードでの管理名称を変えたい時などに使用
- terraform rm
- リソースをterraform管理下からはずす
Resource と Data Source
Resourceは文字通りリソースのこと。
以下のように宣言すると、書かれたConfigurationでEC2が作成されます。
resource "aws_instance" "app_server" {
ami = "ami-830c94e3"
instance_type = "t2.micro"
tags = {
Name = "ExampleAppServerInstance"
}
}
例は以下の公式チュートリアルからもってきました。
Data Sourceは外部データを参照する仕組みです。
以下のように記述すると該当のamiをexampleという名前で参照できるようになります。
他にも、サブネットとかをData Sourceで書いて使用したりなど色々便利な使い方があります。
直接arnとかを書かずに名前解決できるのが嬉しいポイントですね。
data "aws_ami" "example" {
most_recent = true
owners = ["self"]
tags = {
Name = "app-server"
Tested = "true"
}
}
こちらの例も公式ドキュメントより
モジュール
最後に、モジュールについて書きます。
実際にterraform planなどを実行するディレクトリをルートモジュールと呼びます。
ルートモジュールから子モジュールを以下のように呼び出すことができます。
./app-clusterのディレクトリにあるリソースをservers = 5という引数を与えて作成しています。
module "servers" {
source = "./app-cluster"
servers = 5
}
モジュールを使うと嬉しい点は、複数環境で少しだけ変数の違うものを共通化できるという点です。
(本番と検品環境で同じリソースなんだけど、VPCなどなどのパラメータのみが違う場合など)
この例も公式ドキュメントより引用しています。
他にもsourceにはterraformのレジストリ、github、bitbucketなど指定方法は色々あるみたいです。
以上です！
あんまりtfstateまわりは意識せずに使っていたので、今回改めて調べてみてイメージ持てました。あと、公式ドキュメントがだいぶ充実していることに気づきました。今後はきちんと読んでいきたい😁
最後まで読んでいただきありがとうございます！
Discussion