Créer des contraintes de règles d'administration personnalisées pour Eventarc

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 :

  • eventarc.googleapis.com/Channel
  • eventarc.googleapis.com/ChannelConnection
  • eventarc.googleapis.com/Enrollment
  • eventarc.googleapis.com/GoogleApiSource
  • eventarc.googleapis.com/GoogleChannelConfig
  • eventarc.googleapis.com/MessageBus
  • eventarc.googleapis.com/Pipeline
  • eventarc.googleapis.com/Trigger

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.

Limites

  • Pour appliquer une contrainte de règle d'administration personnalisée à un sujet Pub/Sub créé par Eventarc et utilisé comme couche de transport d'un déclencheur (resource.transport.pubsub.topic), vous devez appliquer la contrainte à la ressource de sujet Pub/Sub au lieu du déclencheur Eventarc Standard. Toutefois, si vous utilisez un sujet Pub/Sub existant, vous pouvez appliquer la contrainte via le déclencheur Eventarc Standard.

  • Pour les ressources eventarc.googleapis.com/ChannelConnection, les règles d'administration personnalisées ne peuvent être appliquées que dans la méthode CREATE.

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. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

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

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

  9. Install the Google Cloud CLI.

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

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

    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 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.eventarcPipelineNoErrorLog. 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, eventarc.googleapis.com/Pipeline.

    • 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.loggingConfig.logSeverity=='ERROR'".

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

    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.

    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
    Exiger une clé CMEK 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.eventarcCMEKOrgPolicy
    resourceTypes:
    - eventarc.googleapis.com/Channel
    methodTypes:
    - CREATE
    condition: "resource.cryptoKeyName.contains('projects/my-project/')"
    actionType: ALLOW
    displayName: Enforce the use of a CMEK key from my-project
    description: All Eventarc channels must be created with
    a CMEK key from my-project
    Refuser la clé CMEK 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.eventarcGoogleChannelKey
    resourceTypes:
    - eventarc.googleapis.com/GoogleChannelConfig
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.cryptoKeyName.contains('projects/my-project/')"
    actionType: DENY
    displayName: Constrain the use of CMEK keys from my-project
    description: CMEK keys from a specific project are denied when creating or
    updating the configuration that supports using a Google Cloud service as an
    event source
    Niveau de gravité de la journalisation requis 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.eventarcPipelineErrorLog
    resourceTypes:
    - eventarc.googleapis.com/Pipeline
    methodTypes:
    - CREATE
    condition: "resource.loggingConfig.logSeverity=='ERROR'"
    actionType: ALLOW
    displayName: Enforce minimum severity for log entries
    description: All Eventarc Advanced pipelines must be configured
    with a logging level of ERROR applied
    Refuser la destination 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.eventarcTriggerNoTestDestination
    resourceTypes:
    - eventarc.googleapis.com/Trigger
    methodTypes:
    - CREATE
    condition: "resource.destination.cloudRun.service.contains('test')"
    actionType: DENY
    displayName: Constrain Cloud Run service destinations
    description: Specific Cloud Run service destinations are denied
    when creating an Eventarc Standard trigger

    Ressources compatibles avec Eventarc

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

    Ressource Champ
    eventarc.googleapis.com/Channel resource.cryptoKeyName
    resource.name
    resource.provider
    eventarc.googleapis.com/ChannelConnection resource.activationToken
    resource.channel
    resource.name
    eventarc.googleapis.com/Enrollment resource.annotations
    resource.celMatch
    resource.destination
    resource.displayName
    resource.messageBus
    resource.name
    eventarc.googleapis.com/GoogleApiSource resource.annotations
    resource.cryptoKeyName
    resource.destination
    resource.displayName
    resource.loggingConfig.logSeverity
    resource.name
    eventarc.googleapis.com/GoogleChannelConfig resource.cryptoKeyName
    resource.name
    eventarc.googleapis.com/MessageBus resource.annotations
    resource.cryptoKeyName
    resource.displayName
    resource.loggingConfig.logSeverity
    resource.name
    eventarc.googleapis.com/Pipeline resource.annotations
    resource.cryptoKeyName
    resource.destinations.authenticationConfig.googleOidc.audience
    resource.destinations.authenticationConfig.googleOidc.serviceAccount
    resource.destinations.authenticationConfig.oauthToken.scope
    resource.destinations.authenticationConfig.oauthToken.serviceAccount
    resource.destinations.httpEndpoint.messageBindingTemplate
    resource.destinations.httpEndpoint.uri
    resource.destinations.messageBus
    resource.destinations.networkConfig.networkAttachment
    resource.destinations.outputPayloadFormat.avro.schemaDefinition
    resource.destinations.outputPayloadFormat.protobuf.schemaDefinition
    resource.destinations.topic
    resource.destinations.workflow
    resource.displayName
    resource.inputPayloadFormat.avro.schemaDefinition
    resource.inputPayloadFormat.protobuf.schemaDefinition
    resource.loggingConfig.logSeverity
    resource.mediations.transformation.transformationTemplate
    resource.name
    resource.retryPolicy.maxAttempts
    resource.retryPolicy.maxRetryDelay
    resource.retryPolicy.minRetryDelay
    eventarc.googleapis.com/Trigger resource.channel
    resource.destination.cloudFunction
    resource.destination.cloudRun.path
    resource.destination.cloudRun.region
    resource.destination.cloudRun.service
    resource.destination.gke.cluster
    resource.destination.gke.location
    resource.destination.gke.namespace
    resource.destination.gke.path
    resource.destination.gke.service
    resource.destination.httpEndpoint.uri
    resource.destination.networkConfig.networkAttachment
    resource.destination.workflow
    resource.eventDataContentType
    resource.eventFilters.attribute
    resource.eventFilters.operator
    resource.eventFilters.value
    resource.name
    resource.serviceAccount
    resource.transport.pubsub.topic

    Étapes suivantes