Gérer les ressources Cloud Build à l'aide de contraintes personnalisées

Grâce au service de règles d'administration, vous disposez d'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 ressources Cloud Build et aux descendants de ces ressources dans la Hiérarchie des ressources Google Cloud. Vous pouvez appliquer des règles d'administration au niveau d'une organisation, d'un dossier ou d'un projet.

Le service de règles d'administration fournit des contraintes prédéfinies pour différentes services Cloud Build. 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, vous pouvez également créer des règles d'administration personnalisées.

Avantages

Vous pouvez utiliser une règle d'administration personnalisée pour autoriser ou refuser des ressources Cloud Build spécifiques. Par exemple, si une requête de création ou de mise à jour d'un déclencheur de compilation ne répond pas la validation d'une contrainte personnalisée telle qu'elle est définie par votre règle d'administration, la requête échoue et une erreur est renvoyée à l'appelant.

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 sur un dossier, Cloud Build applique la règle à tous les projets du . Pour mieux comprendre ce comportement et savoir comment le modifier, consultez la section Règles d'évaluation hiérarchique.

Tarifs

Le service de règles d'administration, y compris les règles d'administration prédéfinies et personnalisées, est proposé gratuitement.

Avant de commencer

  1. Configurer votre projet
    1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

    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. Enable the Cloud Build API.

      Enable the API

    5. Install the Google Cloud CLI.

    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. Enable the Cloud Build API.

      Enable the API

    10. Install the Google Cloud CLI.

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

      gcloud init
    12. 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, demandez à votre administrateur de vous accorder le rôle IAM Administrateur des règles d'administration (roles/orgpolicy.policyAdmin) sur la ressource de l'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 via des rôles personnalisés ou d'autres rôles prédéfinis.

Vous devez également ajouter les rôles requis pour créer Cloud Build dans votre compte utilisateur. Consultez Configurer l'accès aux ressources Cloud Build. Pour en savoir plus sur les rôles IAM associés à Cloud Build, consultez la page Rôles et autorisations IAM.

Créer une contrainte personnalisée

Vous pouvez créer une contrainte personnalisée à l'aide d'un fichier YAML pour définir les ressources, les méthodes, les conditions et les actions soumises à la contrainte. Elles sont spécifiques au service sur lequel vous appliquez la règle d'administration. Les conditions de vos contraintes personnalisées doivent être défini à l'aide du Common Expression Language. Consultez la page GitHub sur le Common Expression Language (CEL). 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.

Utilisez le modèle suivant afin de créer un fichier YAML pour une contrainte personnalisée:

name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- cloudbuild.googleapis.com/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, comme par exemple custom.enableBuildTrigger. La longueur maximale de ce champ est de 70 caractères, sans compter le préfixe, comme par exemple organizations/123456789/customConstraints/custom.allowConstraint.

  • RESOURCE_NAME : nom (pas l'URI) de la ressource Cloud Build contenant l'objet et le champ que vous souhaitez restreindre. Exemple :BuildTrigger

  • 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.github.name.contains('cloudbuild')".

  • ACTION : action à effectuer si la condition est remplie. Peut être défini sur ALLOW ou 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 Créer et gérer des règles d'administration personnalisées.

Configurer une contrainte personnalisée

Après avoir créé le fichier YAML pour une nouvelle contrainte personnalisée, vous devez la configurer pour 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 terminées, 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 booléenne 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 la contrainte à afficher. la page Détails de la règle pour cette contrainte.
  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 Définir une règle d'administration avec des tags.
  9. S'il s'agit d'une contrainte personnalisée, vous pouvez cliquer sur Tester les modifications pour simuler l'effet de cette règle d'administration. 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 qui applique une contrainte booléenne, 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 Par exemple, custom.enableBuildTrigger.

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 une contrainte personnalisée

Pour tester une contrainte personnalisée, exécutez une commande gcloud qui tente d'effectuer une tâche bloquée par votre contrainte.

Par exemple, supposons qu'une contrainte exige que les noms de déclencheurs GitHub contiennent "cloudbuild". Vous pouvez tester cette contrainte en exécutant la commande gcloud builds triggers create github avec un autre nom de déclencheur, comme illustré dans l'extrait suivant:

gcloud builds triggers create github --name=github-trigger \
    --repo-owner=some-owner \
    --repo-name=some-repo \
    --branch-pattern=main \
    --build-config=cloudbuild.yaml \
    --project=my-project \

Le résultat ressemble à ce qui suit :

Operation denied by custom org policies: ["customConstraints/custom.enableBuildTrigger": "GitHub trigger name must include "cloudbuild"."]

Ressources et opérations compatibles avec Cloud Build

Les champs de contrainte personnalisée Cloud Build suivants sont disponibles lorsque vous créez ou mettez à jour des ressources Cloud Build.

Notez que la contrainte sur les builds n'est pas appliquée aux builds déclenchés par un déclencheur.

  • Cloud Build BitbucketServerConfig
    • resource.name
    • resource.hostUrl
    • resource.secrets.adminAccessTokenVersionName
    • resource.secrets.readAccessTokenVersionName
    • resource.secrets.webhookSecretVersionName
    • resource.username
    • resource.apiKey
    • resource.peeredNetwork
    • resource.sslCa
    • resource.peeredNetworkIpRange
  • Configuration du pool de nœuds de calcul Cloud Build
    • resource.displayName
    • resource.annotations
    • resource.privatePoolV1Config.workerConfig.machineType
    • resource.privatePoolV1Config.workerConfig.diskSizeGb
    • resource.privatePoolV1Config.networkConfig.peeredNetwork
    • resource.privatePoolV1Config.networkConfig.egressOpetion
    • resource.privatePoolV1Config.networkConfig.peeredNetworkIpRange
  • Configuration de BuildTrigger dans Cloud Build
    • resource.tags
    • resource.resourceName
    • resource.description
    • resource.name
    • resource.tags
    • resource.triggerTemplate.projectId
    • resource.triggerTemplate.repoName
    • resource.triggerTemplate.branchName
    • resource.triggerTemplate.tagName
    • resource.triggerTemplate.commitSha
    • resource.triggerTemplate.dir
    • resource.triggerTemplate.invertRegex
    • resource.triggerTemplate.substitutions
    • resource.github.owner
    • resource.github.name
    • resource.github.enterpriseConfigResourceName
    • resource.pubsubConfig.topic
    • resource.pubsubConfig.serviceAccountEmail
    • resource.webhookConfig.secret
    • resource.bitbucketServerTriggerConfig.repoSlug
    • resource.bitbucketServerTriggerConfig.projectKey
    • resource.bitbucketServerTriggerConfig.pullRequest.branch
    • resource.bitbucketServerTriggerConfig.pullRequest.commentControl
    • resource.bitbucketServerTriggerConfig.pullRequest.invertRegex
    • resource.bitbucketServerTriggerConfig.push.branch
    • resource.bitbucketServerTriggerConfig.push.tag
    • resource.bitbucketServerTriggerConfig.push.invertRegex
    • resource.gitlabEnterpriseEventsConfig.projectNamespace
    • resource.gitlabEnterpriseEventsConfig.pullRequest.branch
    • resource.gitlabEnterpriseEventsConfig.pullRequest.commentControl
    • resource.gitlabEnterpriseEventsConfig.pullRequest.invertRegex
    • resource.gitlabEnterpriseEventsConfig.push.branch
    • resource.gitlabEnterpriseEventsConfig.push.tag
    • resource.gitlabEnterpriseEventsConfig.push.invertRegex
    • resource.gitlabEnterpriseEventsConfig.gitlabConfigResource
    • resource.disabled
    • resource.substitutions
    • resource.ignoredFiles
    • resource.includedFiles
    • resource.sourceToBuild.uri
    • resource.sourceToBuild.repository
    • resource.sourceToBuild.ref
    • resource.sourceToBuild.repoType
    • resource.sourceToBuild.githubEnterpriseConfig
    • resource.approvalConfig.approvalRequired
    • resource.filter
    • resource.serviceAccount
    • resource.eventType
    • resource.includeBuildLogs
    • resource.repositoryEventConfig.repository
    • resource.repositoryEventConfig.pullRequest.branch
    • resource.repositoryEventConfig.pullRequest.commentControl
    • resource.repositoryEventConfig.pullRequest.invertRegex
    • resource.repositoryEventConfig.push.branch
    • resource.repositoryEventConfig.push.tag
    • resource.repositoryEventConfig.push.invertRegex

Exemples de règles d'administration personnalisées pour des cas d'utilisation courants

Le tableau suivant indique la syntaxe de certaines règles d'administration personnalisées qui pourraient vous être utiles:

Description Syntaxe de la contrainte
Autoriser uniquement la création de déclencheurs Pub/Sub qui écoutent les sujets contenant "cloud-builds" 
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enableCloudBuildPubsubTrigger
    resourceTypes:
    - cloudbuild.googleapis.com/BuildTrigger
    methodTypes:
    - CREATE
    condition: "resource.pubsubConfig != null && resource.pubsubConfig.topic.contains('cloud-builds')"
    actionType: ALLOW
    displayName: Enable creating Pub/Sub trigger that listens on topics that contain "cloud-builds".
    description: Only allow creating Pub/Sub trigger that listens on topics that contain "cloud-builds".
  • ORGANIZATION_ID : ID de votre organisation (par exemple, 123456789).

Étape suivante