Gérer les ressources BigQuery à l'aide de contraintes 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 Trusted Cloud by S3NS suivantes:

• bigquery.googleapis.com/Dataset

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 Trusted Cloud service de règles d'administration 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 ressourcesTrusted Cloud et aux descendants de ces ressources dans la Hiérarchie des ressourcesTrusted Cloud by S3NS . 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 Trusted 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 stratégie au niveau d'un dossier, Trusted Cloud l'applique à tous les projets du dossier. Pour mieux comprendre ce comportement et savoir comment le modifier, consultez la page Règles d'évaluation hiérarchique.

Limites

• PolicyViolationInfo n'est pas publié dans les journaux d'audit BigQuery lorsque l'accès est refusé en raison de contraintes personnalisées. Le message d'erreur fournit l'constraintId qui a refusé l'opération.

Avant de commencer

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

   Go to project selector

2. Make sure that billing is enabled for your Trusted Cloud project.

3. Install the Google Cloud CLI.

4. Configure the gcloud CLI to use your federated identity.

   For more information, see Sign in to the gcloud CLI with your federated identity.

5. To initialize the gcloud CLI, run the following command:

   gcloud init

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

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer les règles d'administration, demandez à votre administrateur de vous accorder les rôles IAM suivants:

• Administrateur des règles d'administration (roles/orgpolicy.policyAdmin) sur la ressource d'organisation
• Pour créer ou mettre à jour un ensemble de données BigQuery : Administrateur ou éditeur BigQuery (roles/bigquery.admin ou roles/bigquery.editor) sur la ressource du projet

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

Ces rôles prédéfinis contiennent 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.* sur la ressource d'organisation
• Pour créer ou mettre à jour un ensemble de données BigQuery :
  • bigquery.datasets.create sur la ressource du projet
  • bigquery.datasets.get sur la ressource du projet
  • bigquery.datasets.list sur la ressource du projet
  • bigquery.datasets.update sur la ressource du projet

Vous pouvez également obtenir ces autorisations 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 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.enforceDatasetId. La longueur maximale de ce champ est de 70 caractères.

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

• 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, "datasetReference.datasetId.startsWith('test')".

• 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 l'opération terminée, vos contraintes personnalisées sont disponibles en tant que règles d'administration dans votre liste de règles d'administration Trusted Cloud by S3NS . 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 en créant une règle d'administration qui la référence, puis en appliquant cette règle d'administration à une ressource Trusted Cloud by S3NS .

Console

1. Dans la console Trusted 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. Cliquez sur Tester les modifications pour simuler l'effet de la règle d'administration. La simulation de règles n'est pas disponible pour les anciennes contraintes gérées. 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 avec des règles booléennes, 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. Exemple : custom.enforceDatasetId.

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 interdisent à tous les nouveaux ID d'ensemble de données d'un projet spécifique de commencer par test.

Avant de commencer, vous devez disposer des éléments suivants:

• ID de votre organisation
• Un ID de projet.

Créer la contrainte

Pour créer une contrainte personnalisée, procédez comme suit:

1. Créez le fichier YAML suivant et enregistrez-le sous le nom constraint-enforce-datasetId.yaml:

   name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceDatasetId
   resourceTypes:
   - bigquery.googleapis.com/Dataset
   methodTypes:
   - CREATE
   condition: "datasetReference.datasetId.startsWith('test')"
   actionType: DENY
   displayName: Reject test datasets
   description: All new datasets can't begin with 'test'.
   

   Remplacez ORGANIZATION_ID par votre ID d'organisation.

   Cela définit une contrainte qui refuse les opérations de création d'ensemble de données si l'ID de l'ensemble de données commence par test.

2. Appliquez la contrainte :

   gcloud org-policies set-custom-constraint ~/constraint-enforce-datasetId
   

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                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
   custom.enforceDatasetId                 DENY         CREATE         bigquery.googleapis.com/Dataset    Reject test datasets
   ...
   

Créer la règle

Créez maintenant une règle et appliquez-la à la contrainte personnalisée que vous avez créée.

1. Enregistrez le fichier suivant sous le nom policy-enforce-datasetId.yaml :

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

   Remplacez PROJECT_ID par l'ID de votre projet.

2. Appliquez la règle :

   gcloud org-policies set-policy ~/policy-enforce-datasetId.yaml
   

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

   gcloud org-policies list --project=PROJECT_ID
   

   Le résultat ressemble à ce qui suit :

   CONSTRAINT                  LIST_POLICY    BOOLEAN_POLICY    ETAG
   custom.enforceDatasetId     -              SET               COCsm5QGENiXi2E=
   

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

Tester la stratégie

Essayez de créer un ensemble de données BigQuery dans le projet:

bq --location=US mk -d \
    --default_table_expiration 3600 \
    --description "This is my dataset." \
    testdataset

Le résultat est le suivant :

Operation denied by custom org policies: ["customConstraints/custom.enforceDatasetId": "All new datasets can't begin with 'test'."]

Ressources compatibles avec BigQuery

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

Ressource	Champ
bigquery.googleapis.com/Dataset	resource.datasetReference.datasetId
	resource.defaultCollation
	resource.defaultEncryptionConfiguration.kmsKeyName
	resource.defaultPartitionExpirationMs
	resource.defaultRoundingMode
	resource.defaultTableExpirationMs
	resource.description
	resource.externalCatalogDatasetOptions.defaultStorageLocationUri
	resource.externalCatalogDatasetOptions.parameters
	resource.externalDatasetReference.connection
	resource.externalDatasetReference.externalSource
	resource.friendlyName
	resource.isCaseInsensitive
	resource.linkedDatasetSource.sourceDataset.datasetId
	resource.location
	resource.maxTimeTravelHours
	resource.storageBillingModel

Étapes suivantes

• Découvrez comment mettre à jour les propriétés d'un ensemble de données.
• En savoir 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.