Gérer les règles d'alerte avec Terraform

Ce document explique comment utiliser le fournisseur Terraform Google Cloud pour modifier et supprimer des règles d'alerte dans votre projet Google Cloud. Le fournisseur Terraform pour Google Cloud fournit les ressources suivantes pour les règles d'alerte et les canaux de notification:

Terraform est un outil permettant de créer, de modifier et de gérer les versions d'infrastructure. Il utilise des fichiers de configuration pour décrire les composants nécessaires à l'exécution d'une application donnée ou de l'ensemble de votre infrastructure. Pour en savoir plus sur l'utilisation de Terraform, consultez les documents suivants:

Avant de commencer

Pour obtenir les autorisations nécessaires pour modifier des règles d'alerte à l'aide de Terraform, demandez à votre administrateur de vous accorder le rôle IAM Éditeur Monitoring (roles/monitoring.alertPolicyEditor) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Pour en savoir plus sur les rôles Cloud Monitoring, consultez Contrôler les accès avec Identity and Access Management.

Modifier ou supprimer des règles d'alerte

Pour modifier ou supprimer une règle d'alerte dans votre projet Google Cloud, procédez comme suit:

  1. Assurez-vous que Terraform est installé dans Cloud Shell.

  2. Dans Cloud Shell, accédez au répertoire contenant votre configuration Terraform.

  3. Modifiez le fichier de configuration, recherchez la ressource google_monitoring_alert_policy de votre stratégie d'alerte, puis modifiez-la ou supprimez-la.

  4. Dans Cloud Shell, saisissez terraform apply.

Exporter une configuration de règle d'alerte vers une configuration Terraform

Vous pouvez exporter une configuration de règle d'alerte de Google Cloud vers une définition Terraform dans votre configuration Terraform. Ce processus est utile si vous avez créé une règle d'alerte dans Google Cloud après avoir créé votre configuration Terraform.

Pour exporter votre règle d'alerte, procédez comme suit:

  1. Assurez-vous que Terraform est installé dans Cloud Shell.

  2. Dans Cloud Shell, accédez au répertoire contenant votre configuration Terraform.

  3. Ajoutez un bloc import à un fichier de votre configuration Terraform. Le bloc d'importation comporte les arguments suivants:

    • to: adresse de la ressource telle que spécifiée par votre configuration Terraform. Ce champ a le format google_monitoring_alert_policy.RESOURCE_NAME, où RESOURCE_NAME est une valeur que vous choisissez. Nous vous recommandons de choisir un nom de ressource qui décrit clairement votre règle d'alerte.

    • id: nom de la règle d'alerte. Ce champ est au format project/PROJECT_ID/alertPolicies/ALERT_POLICY_ID.

    Par exemple, vous souhaitez exporter une règle d'alerte qui surveille l'utilisation du processeur. Vous définissez donc RESOURCE_NAME sur cpu_usage_threshold. Vous définissez ensuite id comme nom de la règle d'alerte:

    import {
    to = google_monitoring_alert_policy.cpu_usage_threshold
    id = "projects/my-alerting-project/alertPolicies/7160801095019277297"
    }
    
  4. Dans Cloud Shell, exécutez la commande suivante :

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

    La commande précédente crée un fichier nommé generated.tf, qui vous permet d'examiner la définition de votre règle d'alerte avant de l'ajouter à votre configuration Terraform. Vous pouvez modifier la définition, la déplacer vers un autre fichier ou la laisser inchangée.

  5. Dans Cloud Shell, saisissez terraform apply pour importer la définition de votre règle d'alerte dans votre configuration Terraform.

Pour en savoir plus sur la génération de définitions pour les ressources qui ne font pas partie de votre configuration Terraform, consultez la section Générer une configuration.

Étape suivante

  • Apprenez-en plus sur Terraform.
  • Testez des exemples de code qui utilisent le fournisseur Terraform pour Google Cloud avec Cloud Monitoring.
  • Consultez le dépôt GitHub du fournisseur Terraform pour Google Cloud.
  • Ouvrez une demande sur GitHub pour signaler un bug ou poser une question sur Terraform.