モジュールの動作確認
実際にディレクトリ(フォルダ)を作成して、モジュールが動く仕組みを体験してみましょう。今回は、web_server というモジュールを作って、それを利用する例を説明します。
1. ディレクトリの作成
任意の場所に作業ディレクトリを作成し、その中にmodulesフォルダを作成します。Visual Studio Codeのエクスプローラーで作業ディレクトリを右クリックし、「新しいフォルダー」を選択してmodulesという名前で作成してください。
(作業ディレクトリ)
└── modules ← このフォルダを作成
さらに、作成したmodulesフォルダの中にweb_serverフォルダを作成します。modulesフォルダを右クリックし、「新しいフォルダー」を選択してweb_serverという名前で作成してください。
(作業ディレクトリ)
└── modules
└── web_server ← このフォルダを作成
2. モジュールファイルの作成
2.1 main.tfの作成
作成したmodules/web_server/の中に、main.tfというファイルを作成します。Visual Studio Codeのエクスプローラーでweb_serverフォルダを右クリックし、「新しいファイル」を選択してmain.tfという名前で作成してください。
(作業ディレクトリ)
└── modules
└── web_server
└── main.tf ← このファイルを作成
作成したファイルに以下の内容を記述して保存します。
resource "aws_s3_bucket" "this" {
bucket = var.name
tags = {
Module = "True"
}
}
2.2 variables.tfの作成
同じmodules/web_server/フォルダにvariables.tfファイルを作成します。web_serverフォルダを右クリックし、「新しいファイル」を選択してvariables.tfという名前で作成してください。
(作業ディレクトリ)
└── modules
└── web_server
├── main.tf
└── variables.tf ← このファイルを作成
作成したファイルに以下の内容を記述して保存します。外部から渡す引数としてnameを定義します。
variable "name" {
description = "バケット名を受け取る変数"
type = string
}
3. ルートファイルの作成(呼び出し)
作業ディレクトリ直下に main.tf を作成します。Terraformはterraform initを実行したディレクトリ直下の.tfファイルを読み込むため、このファイルが必要です。modules/配下のファイルだけでは、Terraformはリソース定義を認識できません。
(作業ディレクトリ)
├── main.tf ← このファイルを作成
└── modules
└── web_server
├── main.tf
└── variables.tf
main.tfに以下の内容を記述します。
provider "aws" {
region = "ap-northeast-1"
}
# モジュールを使ってバケットを作成
module "my_web_server" {
# 作成したディレクトリを指定
source = "./modules/web_server"
# モジュール内の variable "name" に値を渡す
name = "tf-module-test-bucket-12345"
}
4. 初期化
以下のコマンドで、Terraform がインストールされていることを確認します。
terraform --version
以下のように Terraform のバージョンが表示されれば、インストールは確認できています。
Terraform vX.X.X
on darwin_arm64
バージョンが表示されない場合は、Terraformのインストール を先に実施してください。
インストールが確認できたら、モジュールの初期化に進みます。 新しいモジュールを追加した場合、Terraformに「モジュールを読み込む」作業をさせる必要があります。 以下のコマンドを実行してください。
terraform init
成功すると Initializing modules... と表示され、モジュールの準備が整います。
| ⚠️ 「Module not installed」エラーが出る場合 |
|---|
モジュールを追加した後に terraform init を実行し忘れると、「Module not installed」や「Error: Module not found」というエラーが発生します。新しいモジュールを追加したら、必ず terraform init を実行してください。 |
5. 作成の実行
terraform apply
実行プランを確認すると、module.my_web_server.aws_s3_bucket.this という名前でリソースが作成されることがわかります。yes で作成してください。
6. リソースの削除
確認が終わったら、作成したリソースを削除しておきましょう。
terraform destroy