Terraform モジュールとリモート ストレージの使用

Terraform モジュールの作成

Terraform モジュールを使用すると、Github などのバージョン管理を使用して、Terraform 構成を再利用、共有、保存できます。次のステップでは、New Relic 構成を再利用可能なモジュールに移動します。

まず、プロジェクト ルートに、modules という名前のモジュールを格納する新しいディレクトリを作成します。

$
mkdir modules && cd modules

modules ディレクトリに、HostConditions という名前の新しいモジュール用の新しいディレクトリを作成し、 main.tfという名前の新しいファイルを作成します。

$
mkdir HostConditions && cd HostConditions
$
touch main.tf

ルート プロジェクトのmain.tfファイルから 2 つのアラート条件を削除し、それを HostConditions ディレクトリの新しいmain.tfファイルにコピーします。

ルート ディレクトリのmain.tfファイルで、モジュール ブロックを使用して新しいモジュールを呼び出します。

module "HostConditions" {
source = "./modules/HostConditions"
}

構成をテストして、 terraform planとterraform initを実行してください:

# Example output
------------------------------------------------------------------------
$
[output]Initializing modules...
$
[output]- HostConditions in
$
[output]Error: Unreadable module directory
$
[output]Unable to evaluate directory symlink: lstat modules/HostConditions: no such
$
[output]file or directory
$
[output]Error: Failed to read module directory
$
[output]Module directory  does not exist or cannot be read.
$
[output]Error: Unreadable module directory
$
[output]Unable to evaluate directory symlink: lstat modules/HostConditions: no such
$
[output]file or directory
$
[output]Error: Failed to read module directory
$
[output]Module directory  does not exist or cannot be read.

モジュール ディレクトリにプロバイダーの詳細がないため、コンソールにエラーが表示されます。エラーを修正するには、HostConditions ディレクトリにルートの provider.tf のコピーを作成します。

provider "newrelic" {
 account_id = 12345 # Your New Relic account ID
 api_key = "NRAK-zzzzzz" # Your New Relic user key
 region = "US" # US or EU (defaults to US)
}

構成をテストして、 terraform planとterraform initを実行してください:

# Example output
------------------------------------------------------------------------
$
[output]Error: Reference to undeclared resource
 on modules/HostConditions/main.tf line 2, in resource "newrelic_infra_alert_condition"
$
[output]"cpuhot":
  2:   policy_id = newrelic_alert_policy.DemoPolicy.id
$
[output]A managed resource "newrelic_alert_policy" "DemoPolicy" has not been declared
$
[output]in module.HostConditions.
$
[output]Error: Reference to undeclared resource
 on modules/HostConditions/main.tf line 24, in resource "newrelic_infra_alert_condition"
$
[output]"highDiskUsage":
 24:   policy_id = newrelic_alert_policy.DemoPolicy.id
$
[output]A managed resource "newrelic_alert_policy" "DemoPolicy" has not been declared
$
[output]in module.HostConditions.

Terraform init はエラーを表示しなくなりましたが、terraform plan を実行するとエラーが発生します。

エラーは、./modules/HostConditions/provider.tf で使用されているポリシー ID が存在しないことが原因です。モジュールに渡すには変数が必要です。

変数を作成する

変数は詳細をモジュールに渡し、デフォルト値を設定します。

まず、HostConditions provider.tf の上部に新しい変数を作成します。

variable "providerId" {}

次に、リソース ブロックで、既存の policyId を新しい変数に置き換えます。

var.policy

モジュールに変数を渡す

モジュールを動的にするには、モジュール リソース ブロックを使用して変数をモジュールに渡します。

ルート ディレクトリmain.tfで、モジュール ブロックを更新して、policyId 変数を追加します。

module "HostConditions" {
source = "./modules/HostConditions"
policyId = newrelic_alert_policy.DemoPolicy.id
}

モジュールに変数を追加した後、 terraform planを実行します。

$
terraform plan

ここで、さらに変数を追加し、CPU クリティカル、CPU 警告、およびディスク パーセントの値を置き換えます。次に、新しい変数をモジュールに渡します。

新しい変数を HostConditions main.tfに追加します。

variable cpu_warning {}
variable cpu_critical {}
variable diskPercent {}

HostConditons main.tfに追加された新しい変数を使用するようにアラート条件を更新します。

resource "newrelic_infra_alert_condition" "cpuhot" {
  policy_id = var.policyId

  name       = "CPU hot!"
  type       = "infra_metric"
  event      = "SystemSample"
  select     = "cpuPercent"
  comparison = "above"
  where      = "(hostname LIKE '%myhost%')"

  critical {
    duration      = 5
    value         = var.cpu_critical
    time_function = "all"
  }
  warning {
    duration      = 5
    value         = var.cpu_warning
    time_function = "all"
  }
}

resource "newrelic_infra_alert_condition" "highDiskUsage" {
  policy_id = var.policyId

  name       = "high disk usage"
  type       = "infra_metric"
  event      = "SystemSample"
  select     = "diskUsedPercent"
  comparison = "above"
  where      = "(hostname LIKE '%myhost%')"

  critical {
    duration      = 5
    value         = var.diskPercent
    time_function = "all"
  }
}

モジュールに変数を追加した後、 terraform planを実行します。変数値が欠落しているため、エラー メッセージが表示されます。値は、モジュール ブロックに追加するか、デフォルト値として追加できます。

$
terraform plan

デフォルト値の追加

デフォルトの変数値を HostConditions main.tfに追加します。

variable cpu_warning { default=80}
variable cpu_critical { default=90}
variable diskPercent { default=60 }

モジュール ブロックを使用して変数値を渡す

ルート ディレクトリmain.tfで、モジュール ブロックを更新して、cpu_critical、cpu_warning、および diskPercentage 変数を追加します。

module "HostConditions" {
source = "./modules/HostConditions"
policyId = newrelic_alert_policy.DemoPolicy.id
cpu_critical = 88
cpu_warning = 78
diskPercentage = 66
}

モジュールに変数を追加した後、 terraform planを実行します。

$
terraform plan

モジュールの再利用

既存の New Relic ポリシーに接続するモジュールを再利用できます。開始する前に、New Relic アカウントで、 Preexisting Policy という名前の新しいアラート ポリシーを作成します。

既存のアラート ポリシーの接続

まず、ルートのmain.tfファイルにデータ ブロックを追加して、既存のポリシーをインポートします。

data "newrelic_alert_policy" "ExistingPolicy" {
    name = "Preexisting Policy"
}

次に、 HostConditions2 という名前の 2 番目のモジュール ブロックを作成します。アラート条件を既存のポリシーに追加します。

module "HostConditions2" {
source = "./modules/HostConditions"
policyId = data.newrelic_alert_policy.ExistingPolicy.id
cpu_critical = 87
cpu_warning = 77
diskPercentage = 67
}

terraform initを実行して新しいモジュールを初期化し、「terraform apply」を実行して New Relic アカウントに変更を適用します。

Terraform スクリプトは、新しいアラート ポリシーと 2 つの条件を作成しますが、アラート条件を既存のポリシーにも適用します。

New Relic アカウントの Preexisting Policy を調べて、CPU ホットおよび高ディスク使用率について追加されたアラート条件を確認してください。

モジュールを Github に保存する

モジュールを作成した後、他の人が使用できる場所にモジュールを保存したい場合は、Github を使用できます。

新しい Github リポジトリを作成する

まず、HostModules ディレクトリ内で、新しい Github リポジトリを初期化します。main.tfとprovider.tfをコミットのステージに追加します。

$
git add main.tf provider.tf
$
git commit -m "init"

次に、新しいリポジトリで提供されているコマンドを使用して、コミットを Github にプッシュします。

$
git remote add origin <repo_url>
$
git branch -M main
$
git push -u origin main

Github に保存されているモジュールを使用する

Github リポジトリを確認し、 main.tfとprovider.tfがリポジトリにあることを確認します。GitHub リポジトリの Web URL をコピーして、リポジトリを複製します。

GitHub を HostConditions のソースとして使用して、ルートのmain.tfファイルを更新します。

module "HostConditions" {
source = "git::https://github.com/<your_username>/<your_repo_name>" # Add your repo URL
policyId = newrelic_alert_policy.DemoPolicy.id
cpu_critical = 88
cpu_warning = 78
diskPercentage = 66
}

module "HostConditions2" {
source = "git::https://github.com/<your_username>/<your_repo_name>" # Add your repo URL
policyId = data.newrelic_alert_policy.ExistingPolicy.id
cpu_critical = 87
cpu_warning = 77
diskPercentage = 67
}

terraform initを実行して、新しいモジュールを初期化します。terraform initを実行すると、Terraform はリポジトリをローカルに複製します。走る terraform plan

git リポジトリに加えられた更新でローカル モジュールを更新する必要がある場合は、次を実行します。 terraform get -update

Amazon S3 で状態をリモートで管理する

状態ファイルは、作成されたリソースに関して terraform が保持する表現です。状態ファイルはルート ディレクトリにありますが、削除または破損すると問題が発生します。状態ファイルをリモートに保存すると、セキュリティが確保され、共有とリモート アクセスが可能になります。

ルート ディレクトリのprovider.tfで、Amazon S3 の Terraform バックエンド ブロックを追加します。

terraform {
    backend "s3" {
        bucket = "<s3_bucket_name>"
        key = "<s3_bucket_key>"
        region = "<s3_bucket_region>"
    }
}

正しい S3 バケットの詳細を提供するには変数が必要であり、アクセスが必要です。

Amazon アカウントで S3 バケットへのアクセスを許可するには、IAM ユーザーを作成します。Terraform 状態を保存する S3 バケットへのアクセス権を IAM ユーザーに付与します。

プロファイルを Terraform バックエンド ブロックに追加します。

terraform {
    backend "s3" {
        bucket = "<s3_bucket_name>"
        key = "<s3_bucket_key>"
        region = "<s3_bucket_region>"
        profile = "<iam_user_profile_name>"
    }
}

状態を Amazon S3 に保存する前に、現在の設定を破棄して白紙の状態から開始します。

$
terraform destroy

Terraform を初期化し、Terraform init を実行します。

$
terraform init

ターミナルの出力には、S3 として初期化されたバックエンドが表示されます。ローカル状態は不要なので削除します

$
rm terraform.*

terraform applyを実行して、Terraform 構成の変更を適用します。

$
terraform apply

状態ファイルは、ローカルではなく S3 に保存されるようになりました。S3 バケットを調べて、テラフォームの状態が存在することを確認します。