Terraform を使用してアラート ポリシーを管理する

このドキュメントでは、Google Cloud Terraform Provider を使用して、 Google Cloud プロジェクトのアラート ポリシーを編集および削除する方法について説明します。 Google Cloud Terraform Provider は、アラート ポリシーと通知チャンネルに次のリソースを提供します。

• google_monitoring_alert_policy
• google_monitoring_notification_channel

Terraform は、インフラストラクチャを構築、変更、バージョニングするためのツールです。構成ファイルを使用して、単一のアプリケーションまたはインフラストラクチャ全体を実行するために必要なコンポーネントを記述します。Terraform の使用方法について詳しくは、以下のドキュメントをご覧ください。

• Google Cloud の Terraform に関するドキュメント
• Google Cloud Terraform Provider
• 使ってみる - Google Cloud

この機能は Google Cloud プロジェクトでのみサポートされています。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

始める前に

Terraform を使用してアラート ポリシーを変更するために必要な権限を取得するには、プロジェクトに対する次の IAM ロールを付与するよう管理者に依頼してください。

• モニタリング編集者（roles/monitoring.editor）
• ログベースのアラート ポリシーを作成して使用する: ログ構成書き込み（roles/logging.configWriter）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

Cloud Monitoring のロールの詳細については、Identity and Access Management を使用してアクセスを制御するをご覧ください。

アラート ポリシーを編集または削除する

Google Cloud プロジェクトでアラート ポリシーを編集または削除する手順は次のとおりです。

1. プロジェクトに Terraform をインストールして構成します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

2. Cloud Shell で、Terraform 構成を含むディレクトリに移動します。

3. 構成ファイルを編集し、アラート ポリシーの google_monitoring_alert_policy リソースを見つけて、そのリソースを変更または削除します。

4. Cloud Shell で「terraform apply」と入力します。

アラート ポリシー構成を Terraform 構成にエクスポートする

アラート ポリシー構成を Google Cloudから Terraform 構成の Terraform 定義にエクスポートできます。このプロセスは、Terraform 構成の作成後に Google Cloudでアラート ポリシーを作成した場合に役立ちます。

アラート ポリシーをエクスポートする手順は次のとおりです。

1. プロジェクトに Terraform をインストールして構成します。App Hub 構成の場合は、App Hub ホスト プロジェクトまたはアプリ管理用フォルダの管理プロジェクトを選択します。

2. Cloud Shell で、Terraform 構成を含むディレクトリに移動します。

3. Terraform 構成のファイルに import ブロックを追加します。import ブロックには次の引数があります。

   • to: Terraform 構成で指定されたリソース アドレス。このフィールドの形式は google_monitoring_alert_policy.RESOURCE_NAME で、RESOURCE_NAME は選択した値です。アラート ポリシーを明確に表すリソース名を選択することをおすすめします。

   • id: アラート ポリシーの名前。このフィールドの形式は project/PROJECT_ID/alertPolicies/ALERT_POLICY_ID です。

   たとえば、CPU 使用率をモニタリングするアラート ポリシーをエクスポートする場合は、RESOURCE_NAME を cpu_usage_threshold に設定します。次に、アラート ポリシー名として id を設定します。

   import {
   to = google_monitoring_alert_policy.cpu_usage_threshold
   id = "projects/my-alerting-project/alertPolicies/7160801095019277297"
   }
   

4. Cloud Shell で、次のコマンドを実行します。

   terraform plan -generate-config-out=generated.tf
   

   上記のコマンドでは、generated.tf という名前のファイルが作成されます。このファイルを使用すると、Terraform 構成に追加する前にアラート ポリシーの定義を確認できます。定義を編集したり、別のファイルに移動できます。また、変更せずにそのままにすることもできます。

5. Cloud Shell で「terraform apply」と入力して、アラート ポリシーの定義を Terraform 構成にインポートします。

Terraform 構成に含まれていないリソースの定義の生成について詳しくは、構成の生成をご覧ください。

次のステップ

• Terraform の詳細を確認する。
• Cloud Monitoring でGoogle Cloud Terraform Provider を使用するコードサンプルを試す。
• Google Cloud Terraform Provider の GitHub リポジトリを確認する。
• GitHub の問題を送信してバグを報告するか、Terraform について質問する。