Utiliser des règles d'administration personnalisées

Cette page 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:

  • bigtableadmin.googleapis.com/AppProfile
  • bigtableadmin.googleapis.com/Backup
  • bigtableadmin.googleapis.com/Cluster
  • bigtableadmin.googleapis.com/Instance
  • bigtableadmin.googleapis.com/Table

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

À propos des règles et des contraintes de l'organisation

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 une règle d'administration, c'est-à-dire un ensemble de restrictions appelées Contraintes qui s'appliquent aux ressourcesGoogle Cloud et aux descendants de ces ressources dans la Hiérarchie des ressourcesGoogle Cloud . 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 prédéfinies pour divers services Google Cloud . Toutefois, si vous souhaitez exercer un contrôle plus précis et personnalisable sur les champs spécifiques restreints dans vos règles d'administration 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 la section Règles d'évaluation hiérarchique.

Limites

Règles d'administration personnalisées ne sont pas encore appliquées aux éléments suivants:

Avant de commencer

  1. 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.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.
  5. To initialize the gcloud CLI, run the following command:

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

    Go to project selector

  7. Make sure that billing is enabled for your Google Cloud project.

  8. Install the Google Cloud CLI.
  9. To initialize the gcloud CLI, run the following command:

    gcloud init
  10. 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 via 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 sur lequel 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 : custom.requireDeletionProtectionOnTable. 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, bigtableadmin.googleapis.com/bigtableadmin.googleapis.com/Table.

  • CONDITION : condition CEL écrite pour une représentation d'une ressource de service acceptée. 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.deletionProtection == true.

  • 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 la page Définir des contraintes personnalisées.

Configurer une contrainte personnalisée

Après avoir créé le fichier YAML pour une nouvelle contrainte personnalisée, vous devez le configurer de sorte qu'il soit disponible pour les règles d'administration de votre organisation. Pour configurer une contrainte personnalisée, utilisez la commande gcloud org-policies set-custom-constraint :
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
Remplacez CONSTRAINT_PATH par le chemin d'accès complet à votre fichier de contrainte personnalisée. Par exemple, /home/user/customconstraint.yaml. Une fois terminée, vos contraintes personnalisées sont disponibles en tant que règles d'administration dans votre liste de règles d'administration Google Cloud . Pour vérifier que la contrainte personnalisée existe, utilisez la commande gcloud org-policies list-custom-constraints:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
Remplacez ORGANIZATION_ID par l'ID de votre ressource d'organisation. Pour en savoir plus, consultez la page Afficher les règles d'administration.

Appliquer une règle d'administration personnalisée

Vous pouvez appliquer une contrainte booléenne en créant une règle d'administration qui la référence, puis en appliquant cette règle d'administration à une ressource Google Cloud .

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 le projet pour lequel vous souhaitez définir la règle d'administration.
  3. Dans la liste de la page Règles d'administration, sélectionnez votre contrainte pour afficher la page Détails de la règle associée.
  4. Pour configurer la règle d'administration pour cette ressource, cliquez sur Gérer la règle.
  5. Sur la page Modifier la stratégie, sélectionnez Remplacer la stratégie parente.
  6. Cliquez sur Ajouter une règle.
  7. Dans la section Application, indiquez si l'application de cette règle d'administration doit être activée ou désactivée.
  8. Facultatif : Pour rendre la règle d'administration conditionnelle sur un tag, cliquez sur Ajouter une condition. Notez que si vous ajoutez une règle conditionnelle à une règle d'administration, vous devez ajouter au moins une règle inconditionnelle, sinon la règle ne pourra pas être enregistrée. Pour en savoir plus, consultez la section Définir une règle d'administration avec des tags.
  9. 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 la section Tester les modifications apportées aux règles d'administration à l'aide de Policy Simulator.
  10. Pour finaliser et appliquer la règle d'administration, cliquez sur Définir la règle. La prise en compte de la règle peut prendre jusqu'à 15 minutes.

gcloud

Pour créer une règle d'administration qui applique une contrainte booléenne, créez un fichier YAML de règle qui référence la contrainte :

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

Remplacez les éléments suivants :

  • PROJECT_ID : projet sur lequel vous souhaitez appliquer votre contrainte.
  • CONSTRAINT_NAME : nom que vous avez défini pour la contrainte personnalisée Par exemple, custom.requireDeletionProtectionOnTable.

Pour appliquer la règle d'administration contenant la contrainte, exécutez la commande suivante :

    gcloud org-policies set-policy POLICY_PATH
    

Remplacez POLICY_PATH par le chemin d'accès complet au fichier YAML de votre règle d'administration. La prise en compte de la règle peut prendre jusqu'à 15 minutes.

Tester la règle d'administration personnalisée

L'exemple suivant crée une contrainte et une règle personnalisées qui exigent que la protection contre la suppression soit activée pour toutes les nouvelles tables d'un projet spécifique.

Avant de commencer, vous devez connaître les éléments suivants :

  • ID de votre organisation
  • Un ID de projet.

Créer la contrainte

  1. Enregistrez le fichier suivant sous le nom constraint-require-table-deletion-protection.yaml :

    name: organizations/ORGANIZATION_ID/customConstraints/custom.requireDeletionProtectionOnTable
    resourceTypes:
    - bigtableadmin.googleapis.com/Table
    methodTypes:
    - CREATE
    condition: "resource.deletionProtection == true"
    actionType: ALLOW
    displayName: Only allow tables with deletion_protection set to true.
    description: All tables must have deletion_protection set to true.
    

    Cela définit une contrainte selon laquelle deletion_protection doit être défini sur "true" pour chaque table.

  2. Appliquez la contrainte :

    gcloud org-policies set-custom-constraint constraint-require-table-deletion-protection.yaml
    
  3. Vérifiez que la contrainte existe :

    gcloud org-policies describe-custom-constraint custom.requireDeletionProtectionOnTable  --organization=ORGANIZATION_ID
    

    Le résultat doit afficher la contrainte que vous venez de définir.

Créer la règle

  1. Définissez PROJECT_ID sur l'ID de votre projet et enregistrez le fichier suivant sous le nom policy-require-table-deletion-protection.yaml:

    name: projects/PROJECT_ID/policies/custom.requireDeletionProtectionOnTable
    spec:
      rules:
      - enforce: true
    
  2. Appliquez la règle :

    
    gcloud org-policies set-policy policy-require-table-deletion-protection.yaml
    
    
  3. Vérifiez que la règle existe :

    gcloud org-policies describe custom.requireDeletionProtectionOnTable --project=PROJECT_ID
    

    Le résultat doit afficher la stratégie que vous venez de définir.

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

Tester la stratégie

gcloud bigtable tables create TABLE_ID --instance=INSTANCE_NAME --column-families="my-family" --no-deletion-protection

Cette création de table échoue en raison de la contrainte en place qui exige que la protection contre la suppression soit activée pour toutes les nouvelles tables.

Le résultat ressemble à ce qui suit :

Operation denied by custom org policy: ["customConstraints/custom.requireDeletionProtectionOnTable": All tables must have deletion_protection set to true.]

Pour résoudre l'erreur précédente, créez la table avec la protection contre la suppression activée. Consultez l'exemple ci-dessous.

gcloud bigtable tables create TABLE_ID --instance=INSTANCE_NAME --column-families="my-family" --deletion-protection

La table est créée avec la protection contre la suppression activée.

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

Le tableau suivant fournit la syntaxe de certaines contraintes personnalisées pour les cas d'utilisation courants:

Description Syntaxe de la contrainte
Refuser les profils d'application pour lesquels les transactions à ligne unique ne sont pas activées
name: organizations/ORGANIZATION_ID/customConstraints/custom.denyAppProfilesWithoutTransactionalWrites
resourceTypes:
- bigtableadmin.googleapis.com/AppProfile
methodTypes:
- CREATE
- UPDATE
condition: "resource.singleClusterRouting.allowTransactionalWrites != true"
actionType: DENY
displayName: Deny app profiles where AllowTransactionalWrites is not enabled.
        description: All app profiles must have AllowTransactionalWrites enabled.
      
Forcer la création de clusters aux États-Unis uniquement
  name: organizations/ORGANIZATION_ID/customConstraints/custom.requireClustersToBeInUS
  resourceTypes:
  - bigtableadmin.googleapis.com/Cluster
  methodTypes:
  - CREATE
  condition: "resource.location.contains('/locations/us-')"
  actionType: ALLOW
  displayName: Require all clusters to be in the US.
  description: Clusters must be in the US.
      

Ressources compatibles avec Bigtable

Le tableau suivant répertorie les ressources Bigtable que vous pouvez référencer dans des contraintes personnalisées.

Ressource Champ
bigtableadmin.googleapis.com/AppProfile resource.dataBoostIsolationReadOnly.computeBillingOwner
resource.description
resource.multiClusterRoutingUseAny.clusterIds
resource.name
resource.singleClusterRouting.allowTransactionalWrites
resource.singleClusterRouting.clusterId
resource.standardIsolation.priority
bigtableadmin.googleapis.com/Backup resource.expireTime
resource.name
resource.sourceTable
bigtableadmin.googleapis.com/Cluster resource.clusterConfig.clusterAutoscalingConfig.autoscalingLimits.maxServeNodes
resource.clusterConfig.clusterAutoscalingConfig.autoscalingLimits.minServeNodes
resource.clusterConfig.clusterAutoscalingConfig.autoscalingTargets.cpuUtilizationPercent
resource.clusterConfig.clusterAutoscalingConfig.autoscalingTargets.storageUtilizationGibPerNode
resource.defaultStorageType
resource.encryptionConfig.kmsKeyName
resource.location
resource.name
resource.nodeScalingFactor
resource.serveNodes
bigtableadmin.googleapis.com/Instance resource.displayName
resource.name
bigtableadmin.googleapis.com/Table resource.automatedBackupPolicy.frequency
resource.automatedBackupPolicy.retentionPeriod
resource.changeStreamConfig.retentionPeriod
resource.columnFamilies
resource.deletionProtection
resource.name

Étape suivante