
【IT】【Terraform入門⑤】main.tf だけでは見づらくなってきたときの整理方法
〜 Terraformのディレクトリ構成を考える 〜
皆さま、こんにちは
前回に引き続き、
今回もTerraformについて学びたいと思います。
前回の記事
はじめに
ここまでのシリーズでは、Terraformを分かりやすく学ぶために、
できるだけ 1つの `main.tf` にまとめて書く 形で進めてきました。
最初の学習では、それで十分です。
実際、Terraformを触り始めたばかりの段階では、
provider の設定
S3 の作成
EC2 の作成
セキュリティグループの設定
といった内容を、1つのファイルで確認できた方が流れを追いやすいです。
ただ、少しずつ設定が増えてくると、`main.tf` だけでは見づらくなってきます。
たとえば、
どこに何が書いてあるのか探しづらい
値だけ変えたいのに、本体の設定まで見に行く必要がある
作成後に確認したい値が設定の中に埋もれてしまう
といったことが起きやすくなります。
そこで考えたいのが、
Terraformのファイルを役割ごとに分ける という考え方です。
今回は、
`main.tf`
`variables.tf`
`outputs.tf`
の3つを中心に、Terraformの基本的なディレクトリ構成を整理していきます。
まずは3つに分けて考える
Terraformのファイル構成は、最初は次の3つで考えると分かりやすいです。
main.tf // リソースの定義
variables.tf // 変数(入力値)の定義
outputs.tf // 出力値の定義かなりざっくり言うと、
main.tf // 本体
variables.tf // 入力
outputs.tf // 出力という整理です。
この3つに分けるだけで、Terraformの見通しはかなりよくなります。
main.tf は何を書くファイルか
`main.tf` は、Terraformの中心になるファイルです。
ここには主に、
provider の設定
resource の定義
data の参照
などを書きます。
つまり `main.tf` は、
実際に何を作るかを書くファイル
です。
たとえば、これまでシリーズで書いてきたような
S3 バケットを作る
セキュリティグループを作る
EC2 インスタンスを作る
といった内容は、基本的に `main.tf` に入ります。
Terraformを学び始めた段階では、まず
リソースを書く場所が `main.tf`
と覚えておくと分かりやすいと思います。
たとえば、EC2 を作る設定なら、こんな内容が `main.tf` に入ります。
provider "aws" {
region = var.aws_region
}
resource "aws_security_group" "ec2_ssh" {
name = "terraform-ec2-ssh"
description = "Allow SSH access"
ingress {
description = "SSH"
from_port = 22
to_port = 22
protocol = "tcp"
cidr_blocks = [var.allowed_ssh_cidr]
}
egress {
from_port = 0
to_port = 0
protocol = "-1"
cidr_blocks = ["0.0.0.0/0"]
}
}
resource "aws_instance" "sample" {
ami = "ami-xxxxxxxxxxxxxxxxx"
instance_type = var.instance_type
key_name = var.key_name
vpc_security_group_ids = [aws_security_group.ec2_ssh.id]
tags = {
Name = "terraform-ec2-sample"
}
}このように、Terraformの本体になる設定は `main.tf` に集めます。
variables.tf は何を書くファイルか
次に `variables.tf` です。
Terraformでは、設定の中に「あとから変えたい値」がよく出てきます。
たとえば、
AWSリージョン
インスタンスタイプ
キーペア名
SSH を許可する CIDR
バケット名
などです。
これらをすべて `main.tf` に直接書くこともできます。
ただ、その方法だと、あとで値を変更したいときに少し見づらくなります。
そこで使うのが `variables.tf` です。
`variables.tf` は、
入力値として使う変数を定義するファイル
です。
ここで大事なのは、`variables.tf` は
値そのものを書く場所ではなく、変数の箱を作る場所 だということです。
たとえば、こう書きます。
variable "aws_region" {
description = "AWS region"
type = string
default = "ap-northeast-1"
}
variable "instance_type" {
description = "EC2 instance type"
type = string
default = "t3.micro"
}
variable "key_name" {
description = "EC2 key pair name"
type = string
default = "terraform-ec2-key"
}
variable "allowed_ssh_cidr" {
description = "CIDR allowed for SSH access"
type = string
}このようにしておくと、`main.tf` 側では
region = var.aws_regionや
instance_type = var.instance_typeのように、変数として呼び出せます。
つまり、
`main.tf` には「何を作るか」
`variables.tf` には「あとで変わる値の定義」
を書く、という役割分担です。
outputs.tf は何を書くファイルか
Terraformでリソースを作ると、
作成後に確認したい値が出てきます。
たとえば、
EC2 のパブリックIP
S3 のバケット名
セキュリティグループID
などです。
こうした
作成した結果として確認したい値 をまとめるのが `outputs.tf` です。
たとえば、EC2 のパブリックIP を確認したいなら、こう書けます。
output "ec2_public_ip" {
description = "Public IP address of EC2 instance"
value = aws_instance.sample.public_ip
}これを書いておくと、`terraform apply` のあとに
結果として確認しやすくなります。
つまり `outputs.tf` は、
Terraformで作ったものの結果を見やすくするファイル
です。
`main.tf` に全部書いても動きますが、出力を分けておくと
作成したあと何を見たいか
次の作業で何が必要か
が整理しやすくなります。
variables.tf と terraform.tfvars の違い
ここは初学者が混乱しやすいところなので、少し丁寧に整理します。
`variables.tf` は、先ほど説明した通り、
変数を定義するファイル
です。
一方で `terraform.tfvars` は、
その変数に入れる実際の値を書くファイル
です。
たとえば、`variables.tf` に次のように書いたとします。
variable "instance_type" {
description = "EC2 instance type"
type = string
}これは、「`instance_type` という変数を使います」と定義しているだけです。
実際の値はまだ入っていません。
その値を `terraform.tfvars` でこう書きます。
instance_type = "t3.micro"この違いをかなりざっくり言うと、
variables.tf // 変数の箱を作る
terraform.tfvars // その箱に値を入れるという関係です。
最初の学習では、`variables.tf` の中で `default` を使えば進められるので、
必ずしも最初から `terraform.tfvars` が必要なわけではありません。
ただ、
環境ごとに値を変えたい
値をまとめて管理したい
main.tf をすっきりさせたい
というときに、`terraform.tfvars` が便利になってきます。
まずはどんな構成にすればよいか
入門段階でおすすめなのは、次のような構成です。
terraform-ec2-sample/
├── main.tf
├── variables.tf
├── outputs.tf
└── terraform.tfvarsただし、最初から全部を無理に使う必要はありません。
たとえば、まずは
terraform-ec2-sample/
├── main.tf
├── variables.tf
└── outputs.tfでも十分です。
そのうえで、
値を別ファイルに分けたくなった
default を減らしたくなった
と感じたタイミングで `terraform.tfvars` を追加すればよいと思います。
大事なのは、最初から完璧な構成を作ることではなく、
役割ごとに分ける感覚をつかむこと
です。
EC2の例をファイルごとに分けるとどうなるか
ここで、EC2 の設定をファイルごとに分けたイメージを見てみます。
main.tf
terraform {
required_version = ">= 1.0.0"
}
provider "aws" {
region = var.aws_region
}
resource "aws_security_group" "ec2_ssh" {
name = "terraform-ec2-ssh"
description = "Allow SSH access"
ingress {
description = "SSH"
from_port = 22
to_port = 22
protocol = "tcp"
cidr_blocks = [var.allowed_ssh_cidr]
}
egress {
from_port = 0
to_port = 0
protocol = "-1"
cidr_blocks = ["0.0.0.0/0"]
}
}
resource "aws_instance" "sample" {
ami = "ami-xxxxxxxxxxxxxxxxx"
instance_type = var.instance_type
key_name = var.key_name
vpc_security_group_ids = [aws_security_group.ec2_ssh.id]
tags = {
Name = "terraform-ec2-sample"
}
}variables.tf
variable "aws_region" {
description = "AWS region"
type = string
default = "ap-northeast-1"
}
variable "instance_type" {
description = "EC2 instance type"
type = string
default = "t3.micro"
}
variable "key_name" {
description = "EC2 key pair name"
type = string
default = "terraform-ec2-key"
}
variable "allowed_ssh_cidr" {
description = "CIDR allowed for SSH access"
type = string
}outputs.tf
output "ec2_public_ip" {
description = "Public IP address of EC2 instance"
value = aws_instance.sample.public_ip
}terraform.tfvars
allowed_ssh_cidr = "203.0.113.10/32"このように分けると、役割がかなりはっきりします。
本体の設定は `main.tf`
入力値の定義は `variables.tf`
確認したい結果は `outputs.tf`
実際の値は `terraform.tfvars`
という整理です。
どこまで細かく分ければよいのか
ここで気になるのが、
「では最初からもっと細かく分けた方がいいのか」という点だと思います。
結論としては、
最初はそこまで細かく分けなくて大丈夫 です。
たとえば最初から
`ec2.tf`
`network.tf`
`security_group.tf`
`provider.tf`
のように分け始めると、今度はファイル数が増えて、かえって追いづらくなることがあります。
入門段階では、まず
`main.tf`
`variables.tf`
`outputs.tf`
を基本にして、
「見づらくなってきたらさらに分ける」
くらいで十分です。
Terraformで大事なのは、
分けること自体ではなく、分かりやすく保つこと です。
今回の整理
今回の内容を短くまとめると、Terraformの基本構成は次のように考えると分かりやすいです。
main.tf // リソースの定義
variables.tf // 変数(入力値)の定義
outputs.tf // 出力値の定義そして必要に応じて、
terraform.tfvars // 変数に入れる実際の値を追加します。
この整理ができると、`main.tf` だけに全部を書くよりも、
Terraformの見通しがかなりよくなります。
まとめ
今回は、Terraformのディレクトリ構成の基本として、
`main.tf`
`variables.tf`
`outputs.tf`
の役割を整理しました。
ポイントは次の通りです。
`main.tf` は、実際に何を作るかを書くファイル
`variables.tf` は、入力値として使う変数を定義するファイル
`outputs.tf` は、作成後に確認したい値を出力するファイル
`terraform.tfvars` は、変数に実際の値を渡したいときに使う
ここまで整理できると、Terraformは
「とりあえず動かす」だけでなく、
少しずつ整えて使う 段階に入ってきます。
最初から難しく考えすぎず、
まずはこの3つを意識するところから始めると、かなり分かりやすいと思います。
では
また!