Créer des contraintes personnalisées liées aux règles d'administration

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 :

  • aiplatform.googleapis.com/NotebookExecutionJob
  • aiplatform.googleapis.com/NotebookRuntime
  • aiplatform.googleapis.com/NotebookRuntimeTemplate

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.

Avantages

Vous pouvez utiliser des règles d'administration personnalisées pour autoriser ou refuser des valeurs spécifiques pour les ressources Colab Enterprise. Par exemple, si une demande de création d'un modèle d'exécution Colab Enterprise ne satisfait pas la validation des contraintes personnalisées définies par votre règle d'administration, la requête échoue et une erreur est renvoyée à l'appelant.

Limites

Comme pour toutes les contraintes des règles d'administration, les modifications apportées aux règles ne s'appliquent pas rétroactivement aux ressources existantes.

  • Une nouvelle règle n'a aucune incidence sur les configurations de ressources existantes.
  • Une configuration de ressource existante reste valide même si elle comporte des valeurs non conformes, sauf si elle est mise à jour.
  • Les règles d'administration personnalisées ne sont pas appliquées aux exécutions de notebooks planifiées, sauf si l'exécution du notebook est planifiée directement à l'aide de l'API.

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. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. 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.

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

    gcloud init

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

    Go to project selector

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. 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.

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

    gcloud init
  12. Assurez-vous de connaître votre ID d'organisation.

    13. 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 : custom.restrictMachineSpecForNotebookRuntimeTemplate. 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, aiplatform.googleapis.com/NotebookRuntimeTemplate.

    • 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.machineSpec.machineType != \"n1-standard-2\"".

    • 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

    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. 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 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 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 y fait référence, puis en appliquant cette règle à 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 de cette contrainte.
    4. Pour personnaliser 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 Ignorer la règle parente.
    6. Cliquez sur Ajouter une règle.
    7. Dans la section Application, indiquez si l'application de cette règle d'administration est activée ou désactivée.
    8. Facultatif : pour rendre la règle d'administration conditionnelle à 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 non conditionnelle, sinon la règle ne pourra pas être enregistrée. Pour en savoir plus, consultez 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 Tester les modifications apportées aux règles d'administration à l'aide de Policy Simulator.
    10. Pour terminer et appliquer la règle d'administration, cliquez sur Définir des règles. L'application 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 fait 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.restrictMachineSpecForNotebookRuntimeTemplate.

    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. L'application 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 bloquent la création de modèles d'environnement d'exécution de notebooks qui n'utilisent pas le type de machine n1-standard-2.

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

    • L'ID de votre organisation
    • Un ID de projet

    Créer la contrainte

    1. Enregistrez le fichier suivant sous le nom constraint-notebook-runtime-template.yaml :

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMachineSpecForNotebookRuntimeTemplate
resourceTypes:
- aiplatform.googleapis.com/NotebookRuntimeTemplate
methodTypes:
- CREATE
condition: "resource.machineSpec.machineType != \"n1-standard-2\""
actionType: DENY
displayName: Restrict machine type for notebook runtime templates
description: All new notebook runtime templates must use n1-standard-2 machines

      Cela définit une contrainte selon laquelle chaque nouveau modèle de runtime de notebook doit utiliser le type de machine n1-standard-2. Dans le cas contraire, la création du modèle de runtime est refusée.

    2. Appliquez la contrainte :

      gcloud org-policies set-custom-constraint ~/constraint-notebook-runtime-template.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                                     ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                                     DISPLAY_NAME
custom.restrictMachineSpecForNotebookRuntimeTemplate  DENY         CREATE         aiplatform.googleapis.com/NotebookRuntimeTemplate  Restrict machine type for notebook runtime templates
...

    Créer la règle

    1. Enregistrez le fichier suivant sous le nom policy-deny-machine-type.yaml :

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

      Remplacez PROJECT_ID par l'ID du projet.

    2. Appliquez la règle :

      gcloud org-policies set-policy ~/policy-deny-machine-type.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.restrictMachineSpecForNotebookRuntimeTemplate  -            SET                   CPHYssIGEOi23pAB-

    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 un modèle d'exécution Colab Enterprise avec un type de machine limité dans le projet :

    gcloud colab runtime-templates create --display-name="DISPLAY_NAME" \
    --project=PROJECT_ID \
    --region=LOCATION \
    --machine-type=n1-standard-4 \
    --accelerator-type=ACCELERATOR_TYPE \
    --accelerator-count=ACCELERATOR_COUNT

    Le résultat est le suivant :

    Operation denied by custom org policies: ["customConstraints/custom.restrictMachineSpecForNotebookRuntimeTemplate": "All new notebook runtime templates must use n1-standard-2 machines."]

    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.

    Description Syntaxe de la contrainte
    Restreindre le type de machine pour les modèles d'exécution Colab Enterprise 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.
      restrictMachineSpecForNotebookRuntimeTemplate
      resourceTypes:
      - aiplatform.googleapis.com/NotebookRuntimeTemplate
      methodTypes:
      - CREATE
      condition: "resource.machineSpec.machineType != "n1-standard-2""
      actionType: DENY
      displayName: Restrict machine type for notebook runtime templates
      description: All new notebook runtime templates must use n1-standard-2 machines.

    Ressources compatibles avec Colab Enterprise

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

    Ressource Champ
    aiplatform.googleapis.com/NotebookExecutionJob resource.customEnvironmentSpec.machineSpec.acceleratorCount
    resource.customEnvironmentSpec.machineSpec.acceleratorType
    resource.customEnvironmentSpec.machineSpec.machineType
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.key
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.reservationAffinityType
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.values
    resource.customEnvironmentSpec.machineSpec.tpuTopology
    resource.customEnvironmentSpec.networkSpec.enableInternetAccess
    resource.customEnvironmentSpec.networkSpec.network
    resource.customEnvironmentSpec.networkSpec.subnetwork
    resource.customEnvironmentSpec.persistentDiskSpec.diskSizeGb
    resource.customEnvironmentSpec.persistentDiskSpec.diskType
    resource.dataformRepositorySource.commitSha
    resource.dataformRepositorySource.dataformRepositoryResourceName
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.executionTimeout
    resource.executionUser
    resource.gcsNotebookSource.generation
    resource.gcsNotebookSource.uri
    resource.gcsOutputUri
    resource.kernelName
    resource.notebookRuntimeTemplateResourceName
    resource.scheduleResourceName
    resource.serviceAccount
    aiplatform.googleapis.com/NotebookRuntime resource.description
    resource.displayName
    resource.runtimeUser
    aiplatform.googleapis.com/NotebookRuntimeTemplate resource.dataPersistentDiskSpec.diskSizeGb
    resource.dataPersistentDiskSpec.diskType
    resource.description
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.eucConfig.eucDisabled
    resource.idleShutdownConfig.idleShutdownDisabled
    resource.idleShutdownConfig.idleTimeout
    resource.machineSpec.acceleratorCount
    resource.machineSpec.acceleratorType
    resource.machineSpec.machineType
    resource.machineSpec.reservationAffinity.key
    resource.machineSpec.reservationAffinity.reservationAffinityType
    resource.machineSpec.reservationAffinity.values
    resource.machineSpec.tpuTopology
    resource.networkSpec.enableInternetAccess
    resource.networkSpec.network
    resource.networkSpec.subnetwork
    resource.networkTags
    resource.notebookRuntimeType
    resource.reservationAffinity.consumeReservationType
    resource.reservationAffinity.key
    resource.reservationAffinity.values
    resource.shieldedVmConfig.enableSecureBoot
    resource.softwareConfig.colabImage.releaseName

    Étapes suivantes