Gérer les ressources de gestion de services à l'aide de 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 :

• servicemanagement.googleapis.com/Service

Pour en savoir plus sur les règles d'administration, consultez 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 gérées intégrées 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 stratégie à un dossier, Google 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.

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.

Go to project selector

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

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

gcloud init

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

Go to project selector

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

Install the Google Cloud CLI.

If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

To initialize the gcloud CLI, run the following command:

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 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.authorizationCheck. 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, servicemanagement.googleapis.com/Service.

• 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.name == \"test-service-name\".

• 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 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 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 est 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 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.authorizationCheck.

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 personnalisée basée sur les attributs de la ressource Service. Ces règles peuvent être utilisées pour autoriser ou refuser certaines requêtes CreateServiceConfig.

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-file-name.yaml :

       name: organizations/ORGANIZATION_ID/customConstraints/custom.authorizationCheck
       resourceTypes:
       -  servicemanagement.googleapis.com/Service
       methodTypes:
       -   CREATE
       -   UPDATE
       condition: resource.name == \"test-service-name\"
       actionType: ALLOW
       displayName: Check Configuration time policy enforcement
       description: Organization policies, defined with CEL and enforced via service manager APIs, allow admins to control service configurations through inheritable and granular rules.
   

   Cela définit une contrainte selon laquelle le nom de service de chaque Service Management doit être égal à test-service-name.

2. Appliquez la contrainte :

   gcloud org-policies set-custom-constraint ~/constraint-file-name.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.configTimeEnforcement ALLOW CREATE,UPDATE servicemanagement.googleapis.com/Service Configuration time policy enforcement
   

Créer la règle

1. Enregistrez le fichier suivant sous le nom policy-file-name.yaml :

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

   Remplacez PROJECT_ID par l'ID de votre projet.

2. Appliquez la règle :

   gcloud org-policies set-policy ~/policy-file-name.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.configTimeEnforcement - SET COCsm5QGENiXi2E=
   

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

Tester la stratégie

Exécutez la commande suivante pour créer la configuration de service permettant de vérifier les contraintes.

  gcloud endpoints services deploy policy-file-name.yaml

Le résultat ressemble à ce qui suit :

  Operation denied by custom org policies: ["customConstraints/custom.authorizationCheck": "error Message"]

Ressources compatibles avec la gestion des services

Le tableau suivant répertorie les ressources de gestion des services auxquelles vous pouvez faire référence dans les contraintes personnalisées.

Ressource	Champ
servicemanagement.googleapis.com/Service	resource.authentication.providers.audiences
	resource.authentication.providers.authorizationUrl
	resource.authentication.providers.issuer
	resource.authentication.providers.jwksUri
	resource.authentication.providers.jwtLocations.cookie
	resource.authentication.providers.jwtLocations.header
	resource.authentication.providers.jwtLocations.query
	resource.authentication.providers.jwtLocations.valuePrefix
	resource.authentication.rules.allowWithoutCredential
	resource.authentication.rules.oauth.canonicalScopes
	resource.authentication.rules.requirements.audiences
	resource.authentication.rules.requirements.providerId
	resource.authentication.rules.selector
	resource.backend.rules.address
	resource.backend.rules.deadline
	resource.backend.rules.disableAuth
	resource.backend.rules.jwtAudience
	resource.backend.rules.operationDeadline
	resource.backend.rules.pathTranslation
	resource.backend.rules.protocol
	resource.backend.rules.selector
	resource.billing.consumerDestinations.metrics
	resource.billing.consumerDestinations.monitoredResource
	resource.context.rules.allowedRequestExtensions
	resource.context.rules.allowedResponseExtensions
	resource.context.rules.provided
	resource.context.rules.requested
	resource.context.rules.selector
	resource.control.environment
	resource.control.methodPolicies.requestPolicies.resourcePermission
	resource.control.methodPolicies.requestPolicies.resourceType
	resource.control.methodPolicies.requestPolicies.selector
	resource.control.methodPolicies.selector
	resource.customError.rules.isErrorType
	resource.customError.rules.selector
	resource.customError.types
	resource.endpoints.aliases
	resource.endpoints.allowCors
	resource.endpoints.name
	resource.endpoints.target
	resource.logging.consumerDestinations.logs
	resource.logging.consumerDestinations.monitoredResource
	resource.logging.producerDestinations.logs
	resource.logging.producerDestinations.monitoredResource
	resource.logs.description
	resource.logs.displayName
	resource.logs.name
	resource.metrics.description
	resource.metrics.displayName
	resource.metrics.launchStage
	resource.metrics.metadata.ingestDelay
	resource.metrics.metadata.samplePeriod
	resource.metrics.metadata.timeSeriesResourceHierarchyLevel
	resource.metrics.metricKind
	resource.metrics.monitoredResourceTypes
	resource.metrics.name
	resource.metrics.type
	resource.metrics.unit
	resource.metrics.valueType
	resource.monitoredResources.description
	resource.monitoredResources.displayName
	resource.monitoredResources.launchStage
	resource.monitoredResources.name
	resource.monitoredResources.type
resource.monitoring.consumerDestinations.metrics
resource.monitoring.consumerDestinations.monitoredResource
resource.monitoring.producerDestinations.metrics
resource.monitoring.producerDestinations.monitoredResource
resource.name
resource.producerProjectId
resource.publishing.apiShortName
resource.publishing.codeownerGithubTeams
resource.publishing.docTagPrefix
resource.publishing.documentationUri
resource.publishing.githubLabel
resource.publishing.librarySettings.cppSettings.common.destinations
resource.publishing.librarySettings.cppSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.dotnetSettings.common.destinations
resource.publishing.librarySettings.dotnetSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.dotnetSettings.forcedNamespaceAliases
resource.publishing.librarySettings.dotnetSettings.handwrittenSignatures
resource.publishing.librarySettings.dotnetSettings.ignoredResources
resource.publishing.librarySettings.dotnetSettings.renamedResources
resource.publishing.librarySettings.dotnetSettings.renamedServices
resource.publishing.librarySettings.goSettings.common.destinations
resource.publishing.librarySettings.goSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.javaSettings.common.destinations
resource.publishing.librarySettings.javaSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.javaSettings.libraryPackage
resource.publishing.librarySettings.javaSettings.serviceClassNames
resource.publishing.librarySettings.launchStage
resource.publishing.librarySettings.nodeSettings.common.destinations
resource.publishing.librarySettings.nodeSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.phpSettings.common.destinations
resource.publishing.librarySettings.phpSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.pythonSettings.common.destinations
resource.publishing.librarySettings.pythonSettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.pythonSettings.experimentalFeatures.restAsyncIoEnabled
resource.publishing.librarySettings.restNumericEnums
resource.publishing.librarySettings.rubySettings.common.destinations
resource.publishing.librarySettings.rubySettings.common.selectiveGapicGeneration.methods
resource.publishing.librarySettings.version
resource.publishing.methodSettings.autoPopulatedFields
resource.publishing.methodSettings.longRunning.initialPollDelay
resource.publishing.methodSettings.longRunning.maxPollDelay
resource.publishing.methodSettings.longRunning.pollDelayMultiplier
resource.publishing.methodSettings.longRunning.totalPollTimeout
resource.publishing.methodSettings.selector
resource.publishing.newIssueUri
resource.publishing.organization
resource.publishing.protoReferenceDocumentationUri
resource.publishing.restReferenceDocumentationUri
resource.quota.limits.defaultLimit
resource.quota.limits.description
resource.quota.limits.displayName
resource.quota.limits.duration
resource.quota.limits.freeTier
resource.quota.limits.maxLimit
resource.quota.limits.metric
resource.quota.limits.name
resource.quota.limits.unit
resource.quota.limits.values
resource.quota.metricRules.metricCosts
resource.quota.metricRules.selector
resource.systemParameters.rules.parameters.httpHeader
resource.systemParameters.rules.parameters.name
resource.systemParameters.rules.parameters.urlQueryParameter
resource.systemParameters.rules.selector
resource.title
resource.usage.producerNotificationChannel
resource.usage.requirements
resource.usage.rules.allowUnregisteredCalls
resource.usage.rules.selector
resource.usage.rules.skipServiceControl

Étapes suivantes

• Pour en savoir plus sur les options de gestion des services, consultez la présentation de la gestion des services.
• Pour vous aider à résoudre les problèmes courants que vous pouvez rencontrer lors de l'utilisation de Service Management, consultez la page Dépannage.
• Consultez les contraintes prédéfinies liées aux règles d'administration pour Service Management.
• 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.