Créer une règle d'administration en mode de simulation

Cette page explique comment utiliser une règle d'administration en mode de simulation pour surveiller l'impact d'une modification de règle sur vos workflows avant son application forcée.

Une règle d'administration en mode de simulation est créée et appliquée de la même manière que les autres règles d'administration d'administration. Les cas de non-respect de la règle sont consignés dans des journaux d'audit, mais les actions non conformes ne sont pas refusées.

Avant de commencer

Pour utiliser une règle d'administration en mode de simulation, la facturation doit être activée pour votre projet Google Cloud. Pour savoir comment vérifier si la facturation est activée pour un projet, consultez la section Vérifier l'état de facturation de vos projets.

Pour en savoir plus sur les règles d'administration et les contraintes et sur leur fonctionnement, consultez la page Présentation du service de règles d'administration.

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer les règles d'administration, demandez à votre administrateur de vous attribuer le rôle IAM Administrateur des règles d'administration (roles/orgpolicy.policyAdmin) sur l'organisation. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Ce rôle prédéfini contient les autorisations requises pour gérer les règles d'administration. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour gérer les règles d'administration:

  • orgpolicy.constraints.list
  • orgpolicy.policies.create
  • orgpolicy.policies.delete
  • orgpolicy.policies.list
  • orgpolicy.policies.update
  • orgpolicy.policy.get
  • orgpolicy.policy.set

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

Limites

Les seules contraintes de règle d'administration disponibles pour les règles d'administration de simulation sont les suivantes:

Toute tentative de création d'une règle d'administration en mode dry run à l'aide d'une autre contrainte entraîne une erreur.

Créer une règle d'administration en mode de simulation

Contraintes de liste

Vous pouvez créer une règle d'administration en mode dry run pour une contrainte de liste à l'aide de la console Google Cloud ou de la Google Cloud CLI. Les exemples suivants montrent comment créer une règle d'administration en mode de simulation qui audite l'effet de la contrainte de liste gcp.restrictServiceUsage.

Console

  1. Dans la console Google Cloud, accédez à la page Règles d'administration.

    Accéder à la page Règles d'administration

  2. Dans le sélecteur de projet, choisissez la ressource pour laquelle vous souhaitez définir la règle d'administration.

  3. Sélectionnez la contrainte Restreindre l'utilisation du service de ressources dans la liste sur la page Règles d'administration.

  4. Sélectionnez l'onglet Simulation.

  5. Cliquez sur Gérer la règle de dry run.

  6. Sur la page Modifier la règle de dry run, sélectionnez Remplacer la règle parente.

  7. Sous Application des règles, cliquez sur Remplacer.

  8. Cliquez sur Ajouter une règle.

  9. Dans Valeurs de règles, sélectionnez Personnalisé.

  10. Dans Type de règle, sélectionnez Refuser.

  11. Dans la zone Custom values (Valeurs personnalisées), saisissez compute.googleapis.com, puis cliquez sur Done (OK).

  12. S'il s'agit d'une contrainte personnalisée, vous pouvez cliquer sur Tester les modifications pour simuler l'effet de cette règle d'administration. Pour en savoir plus, consultez Tester les modifications apportées aux règles d'administration avec Policy Simulator.

  13. Pour appliquer la règle d'administration en mode de simulation, cliquez sur Définir la règle de dry run. Vous pouvez également définir la règle active en cliquant sur Définir la règle.

Vous pouvez vérifier l'état de votre règle d'administration en mode de simulation en accédant à l'onglet Dry run (Simulation) d'une contrainte de règle d'administration.

Pour les projets auxquels une règle d'administration en mode dry run est appliquée, vous pouvez afficher les journaux d'audit en cliquant sur Afficher les journaux de refus. Pour cette règle d'administration, les journaux d'audit affichent les violations comme si la contrainte Restreindre l'utilisation du service des ressources était appliquée pour refuser compute.googleapis.com.

gcloud

Pour créer une règle d'administration en mode de simulation, créez un fichier YAML qui définit la contrainte avec dryRunSpec. Exemple :

  name: RESOURCE_TYPE/RESOURCE_ID/policies/gcp.restrictServiceUsage
  dryRunSpec:
    rules:
      values:
        denied_values:
        - compute.googleapis.com

Remplacez les éléments suivants :

  • RESOURCE_TYPE avec organizations, folders ou projects.

  • RESOURCE_ID par l'ID de votre organisation, de votre dossier, de votre projet ou de votre numéro de projet, en fonction du type de ressource spécifié dans RESOURCE_TYPE.

Cette règle d'administration n'applique pas la contrainte gcp.restrictServiceUsage, mais les journaux d'audit affichent les violations comme si c'était le cas.

Vous pouvez définir une règle d'administration active et une règle d'administration de simulation dans le même fichier YAML, si vous définissez à la fois spec et dryRunSpec. Exemple :

name: RESOURCE_TYPE/RESOURCE_ID/policies/gcp.restrictServiceUsage
spec:
  rules:
  - values:
    allowedValues:
    - container.googleapis.com

dryRunSpec:
  rules:
    values:
      allowedValues:
      - compute.googleapis.com
      - appengine.googleapis.com

Pour appliquer une règle d'administration en mode de simulation, utilisez la commande org-policies set policy. Pour mettre à jour une règle d'administration existante en mode de simulation avec de nouvelles contraintes, utilisez l'option --update-mask. Exemple :

gcloud org-policies set-policy POLICY_PATH \
  --update-mask=UPDATE_MASK

Remplacez les éléments suivants :

  • POLICY_PATH par le chemin d'accès complet au fichier YAML de votre règle d'administration.

  • UPDATE_MASK avec spec pour ne mettre à jour que la règle active, ou dryRunSpec pour ne mettre à jour que la règle d'administration en mode de simulation. Vous pouvez également utiliser * pour mettre à jour les champs spec et dryRunSpec. Si ce champ n'est pas défini lors de la mise à jour d'une règle d'administration existante, cette commande génère une erreur et la règle d'administration n'est pas mise à jour.

Vous pouvez vérifier que la règle d'administration en mode de simulation est définie à l'aide de la commande org-policies describe. Le champ dryRunSpec n'apparaît que s'il existe dans la règle d'administration.

La règle d'administration ci-dessus applique la contrainte gcp.restrictServiceUsage de sorte que seul container.googleapis.com soit autorisé. Toutefois, les journaux d'audit affichent également les cas de non-respect des règles compute.googleapis.com et appengine.googleapis.com.

Contraintes booléennes

Vous pouvez créer une règle d'administration en mode dry run pour une contrainte booléenne à l'aide de la console Google Cloud ou de la Google Cloud CLI. Les exemples suivants montrent comment créer une règle d'administration en mode de simulation qui audite l'effet d'une règle d'administration personnalisée booléenne.

Console

  1. Dans la console Google Cloud, accédez à la page Règles d'administration.

    Accéder à la page Règles d'administration

  2. Dans le sélecteur de projet, choisissez la ressource pour laquelle vous souhaitez définir la règle d'administration.

  3. Sélectionnez la règle d'administration personnalisée que vous souhaitez appliquer dans la liste figurant sur la page Règles d'administration.

  4. Sélectionnez l'onglet Simulation.

  5. Cliquez sur Gérer la règle de dry run.

  6. Sur la page Modifier la règle de dry run, sélectionnez Remplacer la règle parente.

  7. Cliquez sur Ajouter une règle.

  8. Sous Application, sélectionnez Activé, puis cliquez sur OK.

  9. Pour appliquer la règle d'administration en mode de simulation, cliquez sur Définir la règle de dry run. Une fois que vous avez vérifié que la règle d'administration en mode de simulation fonctionne comme prévu, vous pouvez définir la règle active en cliquant sur Définir la règle.

Vous pouvez vérifier l'état de votre règle d'administration en mode de simulation en accédant à l'onglet Dry run (Simulation) d'une contrainte de règle d'administration.

Pour les projets auxquels une règle d'administration en mode dry run est appliquée, vous pouvez afficher les journaux d'audit en cliquant sur Afficher les journaux de refus. Pour cette règle d'administration, les journaux d'audit affichent les violations comme si la règle d'administration personnalisée était appliquée.

gcloud

Pour créer une règle d'administration en mode de simulation, créez un fichier YAML qui définit la contrainte avec dryRunSpec. Exemple :

  name: RESOURCE_TYPE/RESOURCE_ID/policies/CONSTRAINT_NAME
  dryRunSpec:
    rules:
    - enforce: true

Remplacez les éléments suivants :

  • RESOURCE_TYPE avec organizations, folders ou projects.

  • RESOURCE_ID par l'ID de votre organisation, de votre dossier, de votre projet ou de votre numéro de projet, en fonction du type de ressource spécifié dans RESOURCE_TYPE.

  • CONSTRAINT_NAME par le nom de votre contrainte personnalisée. Exemple :custom.disableGkeAutoUpgrade

Cette règle d'administration n'applique pas la contrainte personnalisée, mais les journaux d'audit affichent les violations comme si c'était le cas.

Vous pouvez définir une règle d'administration active et une règle d'administration en mode de simulation dans le même fichier YAML, si vous définissez à la fois spec et dryRunSpec. Exemple :

name: RESOURCE_TYPE/RESOURCE_ID/policies/CONSTRAINT_NAME
spec:
  rules:
  - enforce: false

dryRunSpec:
  rules:
  - enforce: true

Pour appliquer une règle d'administration en mode de simulation, utilisez la commande org-policies set policy. Pour mettre à jour une règle d'administration existante en mode de simulation avec de nouvelles contraintes, utilisez l'option --update-mask. Exemple :

gcloud org-policies set-policy POLICY_PATH \
  --update-mask=UPDATE_MASK

Remplacez les éléments suivants :

  • POLICY_PATH par le chemin d'accès complet au fichier YAML de votre règle d'administration.

  • UPDATE_MASK avec spec pour ne mettre à jour que la règle active, ou dryRunSpec pour ne mettre à jour que la règle d'administration en mode de simulation. Vous pouvez également utiliser * pour mettre à jour les champs spec et dryRunSpec. Si ce champ n'est pas défini lors de la mise à jour d'une règle d'administration existante, cette commande génère une erreur et la règle d'administration n'est pas mise à jour.

Vous pouvez vérifier qu'une règle d'administration en mode de simulation est définie à l'aide de la commande org-policies describe. Le champ dryRunSpec n'apparaît que s'il existe dans la règle d'administration.

Cette règle d'administration n'applique pas la contrainte personnalisée. Toutefois, les journaux d'audit indiquent les cas de non-respect de la contrainte personnalisée.

Créer une règle d'administration en mode dry run à partir d'une règle active

Vous pouvez utiliser une règle d'administration existante comme point de départ d'une règle d'administration en mode de simulation. Cela peut vous permettre d'identifier les conséquences d'une modification de la règle existante sur votre environnement.

Vous pouvez créer une règle d'administration en mode de simulation basée sur une règle existante à l'aide de la console Google Cloud ou de la Google Cloud CLI.

Console

  1. Dans la console Google Cloud, accédez à la page Règles d'administration.

    Accéder à la page Règles d'administration

  2. Dans le sélecteur de projets, choisissez une ressource sur laquelle la contrainte Restreindre l'utilisation du service des ressources est configurée.

  3. Sélectionnez la contrainte Restreindre l'utilisation du service de ressources dans la liste sur la page Règles d'administration.

  4. Sélectionnez l'onglet Diffusions en direct.

  5. Cliquez sur Gérer la règle.

  6. Cliquez sur Ajouter une règle.

  7. Dans Valeurs de règles, sélectionnez Personnalisé.

  8. Dans Type de règle, sélectionnez Refuser.

  9. Dans le champ Valeurs personnalisées, saisissez appengine.googleapis.com.

  10. Cliquez sur OK, puis sur Définir une règle de dry run.

gcloud

Pour créer une règle d'administration en mode de simulation basée sur une règle d'administration active existante, obtenez la règle actuelle de la ressource à l'aide de la commande org-policies describe. Exemple :

gcloud org-policies describe gcp.restrictServiceUsage \
  --project=PROJECT_ID

Remplacez PROJECT_ID par l'ID ou le numéro du projet dans lequel cette règle d'administration est configurée.

Le résultat doit ressembler à ce qui suit :

  name: projects/123456789012/policies/gcp.restrictServiceUsage
  spec:
    etag: CJy93KEGEKCJw/QB
    rules:
    - values:
        allowedValues:
        - compute.googleapis.com
  updateTime: '2023-04-12T21:11:56.512804Z'

Copiez le résultat de cette commande dans un fichier temporaire. Modifiez ce fichier pour supprimer les champs etag et updateTime, puis remplacez le champ spec par dryRunSpec. Modifiez la configuration de la contrainte que vous souhaitez tester dans votre règle d'administration en mode de simulation.

Une fois terminé, le fichier YAML doit se présenter comme suit:

  name: projects/123456789012/policies/gcp.restrictServiceUsage
  dryRunSpec:
    rules:
      values:
        allowedValues:
        - compute.googleapis.com
        - appengine.googleapis.com

Pour appliquer la règle d'administration en mode de simulation, utilisez org-policies set policy avec l'option --update-mask. Exemple :

gcloud org-policies set-policy POLICY_PATH \
  --update-mask=dryRunSpec

Remplacez POLICY_PATH par le chemin d'accès complet au fichier YAML temporaire de votre règle d'administration.

Supprimer une règle d'administration en mode dry run

Vous pouvez supprimer une règle d'administration en mode dry run à l'aide de la console Google Cloud ou de la Google Cloud CLI.

Console

  1. Dans la console Google Cloud, accédez à la page Règles d'administration.

    Accéder à la page Règles d'administration

  2. Dans le sélecteur de projet, choisissez la ressource pour laquelle vous souhaitez définir la règle d'administration.

  3. Sélectionnez la contrainte Restreindre l'utilisation du service de ressources dans la liste sur la page Règles d'administration.

  4. Sélectionnez l'onglet Simulation.

  5. Cliquez sur Supprimer la règle de dry run.

gcloud

Pour supprimer une règle d'administration en mode de simulation, créez un fichier YAML qui définit la règle d'administration sans spécification de simulation. Exemple :

  name: RESOURCE_TYPE/RESOURCE_ID/policies/gcp.restrictServiceUsage
  spec:
    rules:
    - values:
      allowedValues:
      - container.googleapis.com

Remplacez les éléments suivants :

  • RESOURCE_TYPE avec organizations, folders ou projects.

  • RESOURCE_ID par l'ID de votre organisation, de votre dossier, de votre projet ou de votre numéro de projet, en fonction du type de ressource spécifié dans RESOURCE_TYPE.

Exécutez ensuite la commande org-policies set policy avec l'option --update-mask définie sur dryRunSpec. Exemple :

gcloud org-policies set-policy POLICY_PATH \
  --update-mask=dryRunSpec

Cette action met à jour la règle d'administration existante pour supprimer la spécification de simulation et ignore la partie active de la spécification.

Pour supprimer simultanément les règles d'administration actives et les règles d'règles d'administration en mode de simulation, utilisez la commande org-policies delete. Exemple :

gcloud org-policies delete CONSTRAINT_NAME \
  --RESOURCE_TYPE=RESOURCE_ID

Remplacez les éléments suivants :

  • CONSTRAINT_NAME par le nom de la contrainte que vous souhaitez supprimer. Exemple :gcp.restrictServiceUsage

  • RESOURCE_TYPE avec organizations, folders ou projects.

  • RESOURCE_ID par l'ID de votre organisation, de votre dossier, de votre projet ou de votre numéro de projet, en fonction du type de ressource spécifié dans RESOURCE_TYPE.

Évaluation efficace des règles d'administration en mode de simulation

Les règles d'administration en mode de simulation sont héritées de la même manière que les autres règles d'administration. Si une règle d'administration en mode de simulation est définie sur une ressource d'organisation, toutes les ressources descendantes en héritent, sauf si elle est remplacée à un niveau inférieur de la hiérarchie.

L'évaluation effective des stratégies montre le résultat des règles d'administration fusionnées sur cette ressource. Par conséquent, les ajustements apportés à la règle d'administration active sont reflétés dans la règle d'administration en vigueur en mode de simulation, si celle-ci est héritée plutôt que définie localement.

La modification de la règle d'administration active d'un projet modifie également sa règle d'administration en vigueur en mode de simulation.

Prenons l'exemple d'une ressource d'organisation, Organization A, avec une règle d'administration active définie sur enforced: false et une règle d'administration en mode de simulation définie sur enforced: true. Une ressource enfant, Folder B, définit également la règle d'administration active sur enforced: false et hérite de la règle d'administration en mode de simulation. Sous Folder B, la règle en ligne définie signifie que l'évaluation effective de la règle d'administration en mode de simulation est également enforce: false, ce qui remplace la règle d'administration en mode de simulation définie dans son organisation parente.

Une ressource enfant de Folder B, Project X, définit la règle active sur enforced: true. Comme pour Folder B, l'évaluation effective de la règle d'administration en mode de simulation pour Project X est enforced: true, car la règle active est définie.

Une autre ressource enfant de Folder B, Project Y, définit la règle d'administration en mode de simulation sur enforced: true. Elle hérite de la règle d'administration de sa ressource parente. Par conséquent, l'évaluation effective est enforced: false pour la règle active et enforced: true pour la règle d'administration en mode de simulation.

Ressource Définir une règle d'administration active Règle d'administration en direct effective Définir une règle d'administration en mode dry run Règle d'administration efficace en mode de simulation
Organisation A enforced: false enforced: false enforced: true enforced: true
Dossier B enforced: false enforced: false Aucune enforced: false
Dossier C Aucune enforced: false Aucune enforced: true
Projet X enforced: true enforced: true Aucune enforced: true
Projet Y Aucune enforced: false enforced: true enforced: true

Analyser les effets d'une règle d'administration en mode dry run

Une règle d'administration en mode dry run ne bloque aucune opération lorsqu'elle est appliquée. Pour voir l'effet de votre règle d'administration, vous pouvez consulter les journaux d'audit des règles d'administration.

Les journaux d'audit des règles d'administration pour les règles d'administration et les règles d'administration d'administration actives en mode de simulation sont générés selon que l'opération est autorisée ou refusée par les règles appliquées à la ressource donnée. Le tableau suivant décrit les situations dans lesquelles un journal d'audit de règle d'administration est généré:

Règles d'administration actives Règle d'administration en mode de simulation Journal d'audit généré
Autoriser Autoriser Non
Autoriser Refuser Journal d'audit en mode de simulation uniquement
Refuser Autoriser Journal d'audit en mode "Live" et "Dry run"
Refuser Refuser Journal d'audit en mode "Live" et "Dry run"

Les cas de non-respect des règles d'administration en mode dry run apparaissent aux côtés des cas de non-respect en mode actif dans les journaux d'audit. Exemple :

{
  "protoPayload": {
    "@type": "type.googleapis.com/google.cloud.audit.AuditLog",
    "status": {
      "code": 7,
      "message": "PERMISSION_DENIED"
    },
    "authenticationInfo": {},
    "requestMetadata": {
      "callerIp": "1.2.3.4",
      "requestAttributes": {},
      "destinationAttributes": {}
    },
    "serviceName": "appengine.googleapis.com",
    "methodName": "google.api.appengine.v1.appengine.apps.services.get",
    "resourceName": "projects/sur-project-test-3",
    "metadata": {
      "constraint": "constraints/gcp.restrictServiceUsage",
      "checkedValue": "appengine.googleapis.com",
      "liveResult": "ALLOWED",
      "@type": "type.googleapis.com/google.cloud.audit.OrgPolicyDryRunAuditMetadata",
      "dryRunResult": "DENIED"
    }
  },
  "insertId": "1f2bvoxcmg1",
  "resource": {
    "type": "audited_resource",
    "labels": {
      "project_id": "sur-project-test-3",
      "service": "appengine.googleapis.com",
      "method": "google.api.appengine.v1.appengine.apps.services.get"
    }
  },
  "timestamp": "2022-06-16T19:42:58.244990928Z",
  "severity": "WARNING",
  "logName": "projects/sur-project-test-3/logs/cloudaudit.googleapis.com%2Fpolicy",
  "receiveTimestamp": "2022-06-16T19:42:59.572025716Z"
}

Vous pouvez utiliser l'explorateur de journaux pour n'interroger que la règle d'administration en cas de non-respect du mode de simulation.

Console

Vous pouvez utiliser l'explorateur de journaux de la console Google Cloud pour récupérer les entrées du journal d'audit de votre projet, dossier ou organisation Google Cloud :

  1. Dans la console Google Cloud, accédez à la page Journalisation > Explorateur de journaux.

    Accéder à l'explorateur de journaux

  2. Sélectionnez un projet, une organisation ou un dossier Google Cloud existant.

  3. Dans le volet Générateur de requêtes, procédez comme suit :

    • Dans Type de ressource, sélectionnez la ressource Google Cloud dont vous souhaitez afficher les journaux d'audit.

    • Dans Nom du journal, sélectionnez le type de journal d'audit policy.

    • Dans le volet Requête, saisissez la commande suivante : protoPayload.metadata.dryRunResult = "DENIED" AND \ protoPayload.metadata.liveResult = "ALLOWED"

    Si vous rencontrez des problèmes lorsque vous essayez d'afficher des journaux dans l'explorateur de journaux, consultez les informations de dépannage.

    Pour en savoir plus sur l'utilisation de l'explorateur de journaux pour effectuer des requêtes, consultez la page Créer des requêtes dans l'explorateur de journaux.

gcloud

Google Cloud CLI fournit une interface de ligne de commande à l'API Logging. Fournissez un identifiant de ressource valide dans chacun des noms de journaux. Par exemple, si votre requête inclut un ID de projet, l'identifiant de projet que vous fournissez doit faire référence au nom du projet actuellement sélectionné.

Pour lire les entrées de journal d'audit relatives aux règles d'administration en cas de non-respect du mode de simulation, exécutez la commande suivante:

gcloud logging read protoPayload.metadata.dryRunResult = "DENIED" AND \
      protoPayload.metadata.liveResult = "ALLOWED" \
    --RESOURCE_TYPE=RESOURCE_ID \

Remplacez les éléments suivants :

  • RESOURCE_TYPE avec organization, folder ou project.

  • RESOURCE_ID par l'ID de votre organisation, de votre dossier, de votre projet ou de votre numéro de projet, en fonction du type de ressource spécifié dans RESOURCE_TYPE.

Ajoutez l'option --freshness à votre commande pour lire les journaux datant de plus d'un jour.

Pour en savoir plus sur l'utilisation de gcloud CLI, consultez la page gcloud logging read.

Si votre organisation compte de nombreux projets, vous pouvez utiliser des récepteurs agrégés pour agréger et acheminer les entrées de journal d'audit de tous les projets de votre organisation vers une table BigQuery. Pour en savoir plus sur la création de récepteurs agrégés, consultez la section Rassembler et acheminer les journaux au niveau de l'organisation vers les destinations compatibles.

Étapes suivantes

Pour en savoir plus sur la création et la gestion des contraintes de règles d'administration, consultez la section Utiliser des contraintes.