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

Ce document explique comment utiliser le Google Cloud fournisseur Terraform pour modifier et supprimer des règles d'alerte dans votre Google Cloud projet. Le Google Cloud fournisseur Terraform 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 :

Cette fonctionnalité n'est compatible qu'avec les Google Cloud projets. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion.

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 les rôles IAM suivants sur votre projet :

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises avec 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 l'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 Google Cloud projet, procédez comme suit :

  1. Installez et configurez Terraform pour votre projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion.

  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 pour votre règle d'alerte, puis modifiez ou supprimez cette ressource.

  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 depuis 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. Installez et configurez Terraform pour votre projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion.

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

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

    • to : adresse de la ressource spécifiée par votre configuration Terraform. Ce champ est au format de google_monitoring_alert_policy.RESOURCE_NAME, où RESOURCE_NAME est une valeur de votre choix. 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 de 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. Ensuite, vous définissez 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 de vérifier 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 Générer une configuration.

Étape suivante

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