Créer et gérer des contraintes 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 :

• gkeonprem.googleapis.com/BareMetalAdminCluster
• gkeonprem.googleapis.com/BareMetalCluster
• gkeonprem.googleapis.com/BareMetalNodePool
• gkeonprem.googleapis.com/VmwareAdminCluster
• gkeonprem.googleapis.com/VmwareCluster
• gkeonprem.googleapis.com/VmwareNodePool

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 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.denyHighNumvCPUs. 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, gkeonprem.googleapis.com/gkeonprem.googleapis.com/VmwareNodePool.

• 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.config.cpus > 4.

• ACTION : action à effectuer si la condition est remplie. Ne peut être que ALLOW.

• 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.denyHighNumvCPUs.

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 montre comment refuser la mise à jour d'un pool de nœuds avec plus de quatre vCPU dans un cluster d'utilisateur Google Distributed Cloud (logiciel uniquement) pour VMware.

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-node-pool-vcpus.yaml :

   name: organizations/ORGANIZATION_ID/customConstraints/custom.denyHighNumvCPUs resourceTypes: - gkeonprem.googleapis.com/VmwareNodePool methodTypes: - CREATE - UPDATE condition: resource.config.cpus > 4 actionType: DENY displayName: Node pool vCPU constraint description: Node pools must have 4 or fewer vCPUs. 

   Cela définit une contrainte qui limite le nombre de processeurs virtuels dans un pool de nœuds à quatre ou moins. Si le nombre de processeurs virtuels est supérieur à 4 lors de la création ou de la mise à jour d'un pool de nœuds, l'opération est refusée.

2. Appliquez la contrainte :

   gcloud org-policies set-custom-constraint ~/constraint-node-pool-vcpus.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.denyHighNumvCPUs   DENY         CREATE         gkeonprem.googleapis.com/VmwareNodePool   Node pool vCPU constraint ... 

Créer la règle

1. Enregistrez le fichier suivant sous le nom policy-deny-node-pool-high-vcpus.yaml :

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

   Remplacez PROJECT_ID par l'ID du projet.

2. Appliquez la règle :

   gcloud org-policies set-policy ~/policy-deny-node-pool-high-vcpus.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.denyHighNumvCPUs  -              SET               COCsm5QGENiXi2E= 

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

Tester la stratégie

Essayez de mettre à jour un pool de nœuds qui ne respecte pas le règlement.

1. Vous pouvez également lister les clusters d'utilisateur pour obtenir le nom et la région du cluster :

    gcloud container vmware clusters list \     --project=PROJECT_ID\     --location=- 

   Lorsque vous définissez --location=-, cela signifie que vous souhaitez lister tous les clusters d'utilisateur de toutes les régions. Si vous devez limiter la liste, définissez --location sur la région que vous avez spécifiée lorsque vous avez créé le cluster ou l'avez inscrit dans l'API GKE On-Prem.

2. Si vous le souhaitez, listez les pools de nœuds pour obtenir le nom de celui que vous souhaitez mettre à jour :

    gcloud container vmware node-pools list \     --cluster=USER_CLUSTER_NAME \     --project=PROJECT_ID \     --location=REGION 

   Remplacez les éléments suivants :

   • USER_CLUSTER_NAME : nom du cluster d'utilisateur contenant le pool de nœuds.

   • REGION : région Google Cloud associée au cluster d'utilisateurs.

3. Exécutez la commande suivante pour tenter de définir le nombre de vCPU sur 6 :

    gcloud container vmware node-pools update NODE_POOL_NAME \     --cluster=USER_CLUSTER_NAME  \     --project=PROJECT_ID \     --location=REGION \     --cpus=6  

   Remplacez NODE_POOL_NAME par le nom du pool de nœuds.

L'opération est refusée. Le résultat est le suivant :

Operation denied by custom org policy on resource 'projects/PROJECT_ID/locations/REGION/entryGroups/org-policy-test': ["customConstraints/custom.denyHighNumvCPUs"] 

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
Refuser une version	name: organizations/ORGANIZATION_ID/customConstraints/custom.VersionDeny resourceTypes: - gkeonprem.googleapis.com/BareMetalCluster methodTypes: - CREATE - UPDATE condition: resource.bareMetalVersion.startsWith("1.29") actionType: DENY displayName: Bare metal user cluster version denied description: The bare metal user cluster version is no longer supported
Autoriser uniquement si une clé est présente	name: organizations/ORGANIZATION_ID/customConstraints/custom.AllowAnnotation resourceTypes: - gkeonprem.googleapis.com/BareMetalAdminCluster methodTypes: - CREATE - UPDATE condition: '"allowKey" in resource.annotations' actionType: ALLOW displayName: Bare metal admin cluster annotation keys allowed description: Annotation keys are allowed on bare metal admin clusters

Ressources compatibles avec l'API GKE On-Prem

Le tableau suivant répertorie les ressources de l'API GKE On-Prem que vous pouvez référencer dans des contraintes personnalisées.

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