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

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

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

準備

Terraform を使用してアラート ポリシーを変更するために必要な権限を取得するには、プロジェクトに対するモニタリング編集者roles/monitoring.alertPolicyEditor)の IAM ロールを付与するよう管理者に依頼してください。 ロールの付与の詳細については、アクセス権の管理をご覧ください。

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

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

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

Google Cloud プロジェクトのアラート ポリシーを編集または削除するには、次の操作を行います。

  1. Cloud Shell に Terraform がインストールされていることを確認します。

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

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

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

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

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

アラート ポリシーをエクスポートするには、次のようにします。

  1. Cloud Shell に Terraform がインストールされていることを確認します。

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

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

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

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

    たとえば、CPU 使用率をモニタリングするアラート ポリシーをエクスポートする場合は、RESOURCE_NAMEcpu_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 プロバイダを使用するコードサンプルを試す。
  • Google Cloud Terraform プロバイダ リポジトリをGitHub で表示する。
  • GitHub の問題を提出してバグを報告するか、Terraform について質問する。