Utiliser des règles d'administration personnalisées

Cette page vous explique comment utiliser les contraintes personnalisées du service de règles d'administration pour restreindre des opérations spécifiques sur les ressources Google Cloud suivantes :

• monitoring.googleapis.com/AlertPolicy
• monitoring.googleapis.com/NotificationChannel
• monitoring.googleapis.com/Snooze

Pour en savoir plus sur les règles d'administration, consultez Règles d'administration personnalisées.

À propos des règles et des contraintes d'administration

Le service de règles d'administration Google Cloud vous offre un contrôle centralisé et automatisé sur les ressources de votre organisation. En tant qu'administrateur des règles d'administration, vous pouvez définir des ensembles de restrictions appelées contraintes qui s'appliquent aux ressourcesGoogle Cloud et à leurs descendants dans la hiérarchie des ressourcesGoogle Cloud . Chaque ensemble de restrictions constitue une règle d'administration. Vous pouvez appliquer des règles d'administration au niveau d'une organisation, d'un dossier ou d'un projet.

Les règles d'administration fournissent des contraintes gérées intégrées pour divers services Google Cloud . Toutefois, si vous souhaitez exercer un contrôle plus précis et le personnaliser pour des champs spécifiques restreints dans vos règles d'administration, vous pouvez également créer des contraintes personnalisées et les utiliser dans une règle d'administration.

Héritage des règles

Par défaut, les règles d'administration sont héritées par les descendants des ressources sur lesquelles vous les appliquez. Par exemple, si vous appliquez une règle au niveau d'un dossier, Google Cloud l'applique à tous les projets du dossier. Pour mieux comprendre ce comportement et savoir comment le modifier, consultez Règles d'évaluation hiérarchique.

Avant de commencer

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

1. Assurez-vous de connaître votre ID d'organisation.

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer des règles d'administration personnalisées, demandez à votre administrateur de vous accorder le rôle IAM Administrateur des règles d'administration (roles/orgpolicy.policyAdmin) dans la ressource d'organisation. 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 avec des rôles personnalisés ou d'autres rôles prédéfinis.

Créer une contrainte personnalisée

Une contrainte personnalisée est définie dans un fichier YAML, qui spécifie les ressources, méthodes, conditions et actions compatibles avec le service auquel vous appliquez la règle d'administration. Les conditions de vos contraintes personnalisées sont définies à l'aide du langage CEL (Common Expression Language). Pour en savoir plus sur la création de conditions dans des contraintes personnalisées à l'aide du CEL, consultez la section CEL de la page Créer et gérer des contraintes personnalisées.

Pour créer une contrainte personnalisée, créez un fichier YAML au format suivant :

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME resourceTypes: - RESOURCE_NAME methodTypes: - CREATE - UPDATE condition: "CONDITION" actionType: ACTION displayName: DISPLAY_NAME description: DESCRIPTION 

Remplacez les éléments suivants :

• ORGANIZATION_ID : ID de votre organisation (par exemple, 123456789).

• CONSTRAINT_NAME : nom souhaité pour votre nouvelle contrainte personnalisée. Une contrainte personnalisée doit commencer par custom. et ne peut inclure que des lettres majuscules, minuscules ou des chiffres. Exemple : alertDocHasProject. La longueur maximale de ce champ est de 70 caractères.

• RESOURCE_NAME : nom complet de la ressourceGoogle Cloud contenant l'objet et le champ que vous souhaitez restreindre. Par exemple, monitoring.googleapis.com/AlertPolicy.

• CONDITION : condition CEL écrite pour une représentation d'une ressource de service compatible. Ce champ ne doit pas comporter plus de 1 000 caractères. Consultez la section Ressources compatibles pour en savoir plus sur les ressources disponibles pour l'écriture de conditions. Par exemple, resource.documentation.content.contains('${resource.project}').

• ACTION : action à effectuer si la condition est remplie. Les valeurs possibles sont ALLOW et DENY.

• DISPLAY_NAME : nom convivial de la contrainte. Ce champ ne doit pas comporter plus de 200 caractères.

• DESCRIPTION : description conviviale de la contrainte, qui sera affichée dans un message d'erreur en cas de non-respect de la règle. Ce champ ne doit pas comporter plus de 2 000 caractères.

Pour en savoir plus sur la création d'une contrainte personnalisée, consultez Définir des contraintes personnalisées.

Configurer une contrainte personnalisée

gcloud org-policies set-custom-constraint CONSTRAINT_PATH

gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

Appliquer une règle d'administration personnalisée

      name: projects/PROJECT_ID/policies/CONSTRAINT_NAME       spec:         rules:         - enforce: true     

    gcloud org-policies set-policy POLICY_PATH     

Tester la règle d'administration personnalisée

L'exemple suivant crée une contrainte et une règle personnalisées qui vérifient si la documentation d'une règle d'alerte mentionne le nom du projet.

Avant de commencer, remplacez les éléments suivants :

• ORGANIZATION_ID : identifiant numérique unique de l'organisation. Pour savoir comment obtenir cet identifiant, consultez Obtenir l'ID de votre organisation.
• PROJECT_ID : identifiant du projet.

Créer la contrainte

1. Enregistrez le fichier suivant sous le nom constraint-alert-doc-has-project.yaml :

       actionType: DENY     condition: resource.documentation.content.contains('${resource.project}')     description: Requires documentation to include the project name.     displayName: Alerting policy documentation must include project name.     methodTypes:       - CREATE       - UPDATE     name: organizations/ORGANIZATION_ID/customConstraints/custom.alertDocHasProject     resourceTypes:       - monitoring.googleapis.com/AlertPolicy 

   Remplacez ORGANIZATION_ID par votre ID d'organisation.

   Cette contrainte empêche la création ou la mise à jour d'une règle d'alerte si le nom du projet de ressource est manquant dans la documentation de la règle d'alerte.

2. Appliquez la contrainte :

   gcloud org-policies set-custom-constraint ~/constraint-alert-doc-has-project.yaml 

3. Vérifiez que la contrainte existe :

   gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID 

   Le résultat ressemble à ce qui suit :

   CUSTOM_CONSTRAINT: custom.alertDocHasProject ACTION_TYPE: DENY METHOD_TYPES: CREATE,UPDATE RESOURCE_TYPES: monitoring.googleapis.com/AlertPolicy DISPLAY_NAME: Alerting policy documentation must include the project name. 

Créer la règle

1. Enregistrez le fichier suivant sous le nom policy-alert-doc-has-project.yaml :

   name: projects/PROJECT_ID/policies/custom.alertDocHasProject spec:   rules:   - enforce: true 

   Remplacez PROJECT_ID par l'ID du projet.

2. Appliquez la règle :

   gcloud org-policies set-policy ~/policy-alert-doc-has-project.yaml 

3. Vérifiez que la règle existe :

   gcloud org-policies list --project=PROJECT_ID 

   Le résultat ressemble à ce qui suit :

   CONSTRAINT: custom.alertDocHasProject LIST_POLICY: - BOOLEAN_POLICY: SET ETAG: CKSx5LwGEPjBuKwD- 

Une fois la règle appliquée, attendez environ deux minutes que Google Cloud commence à l'appliquer.

Tester la stratégie

Essayez de créer une règle d'alerte avec une documentation qui exclut le nom du projet de ressource.

  gcloud alpha monitoring policies create \     --display-name="CPU Utilization - 5% Threshold" \     --project=PROJECT_ID \     --condition-display-name="Condition 1" \     --condition-filter='resource.type="gce_instance" AND metric.type="compute.googleapis.com/instance/cpu/utilization"' \     --duration='60s' \     --if='>5' \     --combiner='AND' \     --documentation='The ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} has exceeded 5% for over 60 seconds.' \ 

Remplacez PROJECT_ID par l'ID du projet.

Le résultat est le suivant :

  Operation denied by custom org policies: ["customConstraints/alertDocHasProject": "Alerting policy documentation must include project name."] 

Exemples de règles d'administration personnalisées pour des cas d'utilisation courants

Ce tableau fournit des exemples de syntaxe pour certaines contraintes personnalisées courantes.

    actionType: DENY     condition: "resource.conditions.size() > 1"     description: Requires alerting policies to have only one condition.     displayName: Alerting policies must have only one condition     methodTypes:       - CREATE       - UPDATE     name: organizations/ORGANIZATION_ID/customConstraints/custom.oneCondition     resourceTypes:       - monitoring.googleapis.com/AlertPolicy     

    actionType: DENY     condition: "resource.notificationChannels.size() < 2"     description: Alerting policies must use at least two notification channels.     displayName: Policies must have a backup notification channel     methodTypes:       - CREATE       - UPDATE     name: organizations/ORGANIZATION_ID/customConstraints/custom.alertOnTwoChannels     resourceTypes:       - monitoring.googleapis.com/AlertPolicy     

    actionType: DENY     condition: "resource.type != 'email'"     description: Requires notification channels to use only the email channel     type.     displayName: Always use email for notification channels     methodTypes:       - CREATE       - UPDATE     name: organizations/ORGANIZATION_ID/customConstraints/custom.emailChannelsOnly     resourceTypes:       - monitoring.googleapis.com/NotificationChannel     

    actionType: DENY     condition: "int(resource.interval.endTime) > int(resource.interval.startTime) + 3600"     description: Requires snoozes to be under 1 hour.     displayName: Snooze must be less than 1 hour     methodTypes:     - CREATE     - UPDATE     name: organizations/ORGANIZATION_ID/customConstraints/custom.setMaxSnooze     resourceTypes:     - monitoring.googleapis.com/Snooze     

Ressources compatibles avec Cloud Monitoring

Étapes suivantes

• Découvrez-en plus sur le service de règles d'administration.
• Découvrez comment créer et gérer des règles d'administration.
• Consultez la liste complète des contraintes liées aux règles d'administration gérées.