モジュールの基本

プログラミングにおいて、よく使う処理を「関数」として切り出すのと同じように、Terraformではよく使うリソースのセットを「モジュール」という単位で切り出して管理します。

1. モジュールとは

プログラミングにおいて、よく使う処理を「関数」として切り出すのと同じように、Terraformではよく使うリソースのセットを「モジュール」という単位で切り出して管理します。

例えば、「Webサーバと、それに紐づくセキュリティグループ」のセットをモジュール化しておけば、あとはそのモジュールを呼び出すだけで、同じ構成のサーバセットを簡単に何個でも作ることができます。

2. メリット

モジュールのメリットを説明します。

まず一つ目は「再利用性」です。一度書いたコードを、複数のプロジェクトや環境(Dev/Prodなど)で使い回すことができます。特に近年は、テストや本番で環境を分離することが一般的ですが、その場合の管理にモジュールが有効活用できます。

二つ目は「可読性」です。main.tf が巨大にならず、スッキリして読みやすくなります。また、特定の機能ごとにモジュールを分けることで、機能に絞ってコードを確認できるようになります。

三つ目は「標準化」です。「会社推奨のセキュリティ設定」などをモジュールに埋め込んでおけば、誰が作っても安全な構成にすることができます。

3. ファイル構成のイメージ

モジュールを使う場合、一般的には下記の3つのファイルを作成します。それを、ルートディレクトリにある main.tf から呼び出します。

ルートディレクトリ
├── main.tf           # (呼び出し元) ここからモジュールを使う
└── modules/
    └── web_server/   # (モジュール本体) 部品としてのコード
        ├── main.tf
        ├── variables.tf
        └── outputs.tf

今回は、modules というフォルダの中に web_server というフォルダを作り、そこにモジュールを定義します。一般的にモジュールを作るときは、main.tf、variables.tf、outputs.tf の3つをセットで管理します。

  • main.tf には、モジュールの中で作成するリソース(EC2やVPCなど)の実体を定義します。
  • variables.tf には、モジュールに引き渡す「引数(variables)」を定義します。これにより、呼び出し元から設定値を変更できるようになります。
  • outputs.tf は、モジュールで作成されたリソースの情報(IDやIPアドレスなど)を外部に「出力(return)」します。他のモジュールでその値を利用したい時に必要になります。

4. 呼び出し方

モジュールを利用する(呼び出す)際は、module ブロックを使用します。 必須なのは source(モジュールの場所)だけで、あとはそのモジュールが必要とする設定値(変数)を渡します。これは variables で指定した内容が該当します。

module "任意の名前" {
  source = "./modules/モジュール名"

  # モジュール内の変数に値を渡す
  変数名 = "値"
}