Gestire le risorse Cloud Build con vincoli personalizzati

Il servizio Policy dell'organizzazione offre un controllo centralizzato e programmatico sulle risorse della tua organizzazione. In qualità di amministratore della policy dell'organizzazione, puoi definire una policy dell'organizzazione, ovvero un insieme di limitazioni chiamate vincoli che si applicano alle risorse Cloud Build e ai discendenti di queste risorse nella Google Cloud gerarchia delle risorse. Puoi applicare le policy dell'organizzazione a livello di organizzazione, cartella o progetto.

Il servizio Organization Policy fornisce vincoli predefiniti per vari servizi Cloud Build. Tuttavia, se cerchi un controllo più granulare e personalizzabile sui campi specifici limitati nelle policy dell'organizzazione, puoi anche creare policy dell'organizzazione personalizzate.

Vantaggi

Puoi utilizzare un criterio dell'organizzazione personalizzato per consentire o negare risorse Cloud Build specifiche. Ad esempio, se una richiesta di creazione o aggiornamento di un trigger di build non soddisfa la convalida dei vincoli personalizzati come impostato dalle norme dell'organizzazione, la richiesta non andrà a buon fine e verrà restituito un errore al chiamante.

Ereditarietà delle policy

Per impostazione predefinita, le policy dell'organizzazione vengono ereditate dai discendenti delle risorse su cui applichi la policy. Ad esempio, se applichi una policy a una cartella, Cloud Build applica la policy a tutti i progetti contenuti nella cartella. Per scoprire di più su questo comportamento e su come modificarlo, consulta Regole di valutazione della gerarchia.

Prezzi

Il servizio relativo alle policy dell'organizzazione, incluse le policy predefinite e personalizzate, viene fornito senza costi aggiuntivi.

Prima di iniziare

  1. Configura il progetto
    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.

      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

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

    4. Enable the Cloud Build API.

      Roles required to enable APIs

      To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

      Enable the API

    5. Install the Google Cloud CLI.

    6. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

    7. Per inizializzare gcloud CLI, esegui questo comando: 

      gcloud init

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

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

    10. Enable the Cloud Build API.

      Roles required to enable APIs

      To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

      Enable the API

    11. Install the Google Cloud CLI.

    12. Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.

    13. Per inizializzare gcloud CLI, esegui questo comando: 

      gcloud init
    14. Assicurati di conoscere il tuo ID organizzazione.

      15. Ruoli obbligatori

      Per ottenere le autorizzazioni necessarie per gestire le policy dell'organizzazione, chiedi all'amministratore di concederti il ruolo IAM Amministratore policy dell'organizzazione (roles/orgpolicy.policyAdmin) sulla risorsa organizzazione. Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

      Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

      Devi anche aggiungere i ruoli richiesti per creare Cloud Build al tuo account utente. Consulta Configurazione dell'accesso alle risorse Cloud Build. Per scoprire di più sui ruoli IAM associati a Cloud Build, consulta Ruoli e autorizzazioni IAM.

      Crea un vincolo personalizzato

      Puoi creare un vincolo personalizzato utilizzando un file YAML per definire le risorse, i metodi, le condizioni e le azioni soggette al vincolo. Questi sono specifici del servizio su cui stai applicando la policy dell'organizzazione. Le condizioni per i vincoli personalizzati devono essere definite utilizzando Common Expression Language. Consulta la pagina di GitHub su Common Expression Language (CEL). Per ulteriori informazioni su come creare condizioni nei vincoli personalizzati utilizzando il CEL, consulta la sezione relativa al CEL di Creazione e gestione di vincoli personalizzati.

      Utilizza il seguente modello per creare un file YAML per un vincolo personalizzato:

      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

      Sostituisci quanto segue:

      • ORGANIZATION_ID: l'ID della tua organizzazione, ad esempio 123456789.

      • CONSTRAINT_NAME: il nome che vuoi assegnare al nuovo vincolo personalizzato. Un vincolo personalizzato deve iniziare con custom. e può includere solo lettere maiuscole, lettere minuscole o numeri, ad esempio custom.enableBuildTrigger. La lunghezza massima di questo campo è di 70 caratteri, senza contare il prefisso, ad esempio organizations/123456789/customConstraints/custom.allowConstraint.

      • RESOURCE_NAME: il nome (non l'URI) della risorsa Cloud Build contenente l'oggetto e il campo che vuoi limitare. Ad esempio, BuildTrigger.

      • CONDITION: una condizione CEL scritta in base a una rappresentazione di una risorsa di servizio supportata. Questo campo ha una lunghezza massima di 1000 caratteri. Per ulteriori informazioni sulle risorse disponibili in base a cui scrivere condizioni, consulta la sezione Risorse supportate. Ad esempio "resource.github.name.contains('cloudbuild')".

      • ACTION: l'azione da eseguire se condition è soddisfatta. Può essere ALLOW o DENY.

      • DISPLAY_NAME: un nome facile da ricordare per il vincolo. Questo campo ha una lunghezza massima di 200 caratteri.

      • DESCRIPTION: una descrizione chiara del vincolo da visualizzare come messaggio di errore in caso di violazione della policy. Questo campo ha una lunghezza massima di 2000 caratteri.

      Per saperne di più su come creare un vincolo personalizzato, consulta Creazione e gestione delle policy dell'organizzazione personalizzate.

      Configura un vincolo personalizzato

      Dopo aver creato il file YAML per un nuovo vincolo personalizzato, devi configurarlo per renderlo disponibile per le policy dell'organizzazione. Per impostare un vincolo personalizzato, utilizza il comando gcloud org-policies set-custom-constraint: 
      gcloud org-policies set-custom-constraint CONSTRAINT_PATH
       Sostituisci CONSTRAINT_PATH con il percorso completo del file del vincolo personalizzato. Ad esempio: /home/user/customconstraint.yaml. Al termine, i vincoli personalizzati sono disponibili come policy dell'organizzazione nel tuo elenco di policy dell'organizzazione Google Cloud . Per verificare che il vincolo personalizzato esista, utilizza il comando gcloud org-policies list-custom-constraints: 
      gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
       Sostituisci ORGANIZATION_ID con l'ID della risorsa della tua organizzazione. Per ulteriori informazioni, consulta Visualizzazione delle policy dell'organizzazione.

      Applicare una policy dell'organizzazione personalizzata

      Puoi applicare un vincolo creando una policy dell'organizzazione che lo richiami e poi applicando questa policy dell'organizzazione a una risorsa Google Cloud .

      Console

      1. Nella console Google Cloud , vai alla pagina Policy dell'organizzazione.

        Vai a Policy dell'organizzazione

      2. Nel selettore di progetti, seleziona il progetto per cui vuoi impostare la policy dell'organizzazione.
      3. Nell'elenco della pagina Policy dell'organizzazione, seleziona il vincolo per visualizzare la pagina Dettagli policy relativa al vincolo in questione.
      4. Per configurare la policy dell'organizzazione per questa risorsa, fai clic su Gestisci policy.
      5. Nella pagina Modifica policy, seleziona Esegui override della policy dell'unità organizzativa principale.
      6. Fai clic su Aggiungi una regola.
      7. Nella sezione Applicazione, seleziona se attivare o meno l'applicazione di questa policy dell'organizzazione
      8. (Facoltativo) Per rendere la policy dell'organizzazione condizionale su un tag, fai clic su Aggiungi condizione. Tieni presente che se aggiungi una regola condizionale a una policy dell'organizzazione, devi aggiungere almeno una regola non condizionale, altrimenti la policy non può essere salvata. Per ulteriori informazioni, consulta Impostazione di una policy dell'organizzazione con tag.
      9. Fai clic su Testa modifiche per simulare l'effetto della policy dell'organizzazione. La simulazione delle policy non è disponibile per i vincoli gestiti legacy. Per ulteriori informazioni, consulta Testa le modifiche alla policy dell'organizzazione con Policy Simulator.
      10. Per completare e applicare la policy dell'organizzazione, fai clic su Imposta policy. L'applicazione della policy può richiedere fino a 15 minuti.

      gcloud

      Per creare una policy dell'organizzazione con regole booleane, crea un file YAML della policy che faccia riferimento al vincolo: 

            name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
      spec:
        rules:
        - enforce: true

      Sostituisci quanto segue:

      • PROJECT_ID: il progetto su cui vuoi applicare il vincolo.
      • CONSTRAINT_NAME: il nome definito per il vincolo personalizzato. Ad esempio: custom.enableBuildTrigger.

      Per applicare la policy dell'organizzazione contenente il vincolo, esegui il seguente comando: 

          gcloud org-policies set-policy POLICY_PATH

      Sostituisci POLICY_PATH con il percorso completo del file YAML della policy dell'organizzazione. L'applicazione della policy può richiedere fino a 15 minuti.

      Testare un vincolo personalizzato

      Per testare un vincolo personalizzato, esegui un comando gcloud che tenta di completare un'attività bloccata dal vincolo.

      Ad esempio, supponiamo che un vincolo richieda che i nomi dei trigger GitHub contengano "cloudbuild". Puoi testare questo vincolo eseguendo il comando gcloud builds triggers create github con un altro nome di trigger, come mostrato nel seguente snippet:

      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 \

      L'output è simile al seguente:

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

      Risorse e operazioni supportate da Cloud Build

      I seguenti campi di vincoli personalizzati di Cloud Build sono disponibili per l'utilizzo quando crei o aggiorni le risorse Cloud Build.

      Tieni presente che il vincolo relativo alle build non viene applicato alle build attivate dal trigger.

      • Configurazione della build di Cloud Build
        • resource.source.storageSource.bucket
        • resource.source.storageSource.object
        • resource.source.storageSource.generation
        • resource.source.storageSource.sourceFetcher
        • resource.source.repoSource.projectId
        • resource.source.repoSource.repoName
        • resource.source.repoSource.branchName
        • resource.source.repoSource.tagName
        • resource.source.repoSource.commitSha
        • resource.source.repoSource.dir
        • resource.source.repoSource.invertRegex
        • resource.source.repoSource.substitutions
        • resource.source.gitSource.url
        • resource.source.gitSource.dir
        • resource.source.gitSource.revision
        • resource.source.storageSourceManifest.bucket
        • resource.source.storageSourceManifest.object
        • resource.source.storageSourceManifest.generation
        • resource.source.connectedRepository.repository
        • resource.source.connectedRepository.dir
        • resource.source.connectedRepository.revision
        • resource.source.developerConnectConfig.gitRepositoryLink
        • resource.source.developerConnectConfig.dir
        • resource.source.developerConnectConfig.revision
        • resource.steps.name
        • resource.steps.env
        • resource.steps.args
        • resource.steps.dir
        • resource.steps.id
        • resource.steps.waitFor
        • resource.steps.entryPoints
        • resource.steps.secretEnv
        • resource.steps.volumes.name
        • resource.steps.volumes.path
        • resource.steps.timeout
        • resource.steps.allowFailure
        • resource.steps.allowExitCodes
        • resource.steps.script
        • resource.steps.automapSubstitutions
        • resource.timeout
        • resource.images
        • resource.queueTtl
        • resource.artifacts.images
        • resource.artifacts.objects.location
        • resource.artifacts.objects.paths
        • resource.logsBucket
        • resource.options.sourceProvenanceHash
        • resource.options.requestedVerifyOption
        • resource.options.machineType
        • resource.options.diskSizeGb
        • resource.options.substitutionOption
        • resource.options.dynamicSubstitutions
        • resource.options.autoMapSubstitutions
        • resource.options.logStreamingOption
        • resource.options.pool.name
        • resource.options.logging
        • resource.options.env
        • resource.options.secretEnv
        • resource.options.volumes.name
        • resource.options.volumes.path
        • resource.options.defaultLogsBucketBehavior
        • resource.substitutions
        • resource.tags
        • resource.secrets.kmsKeyName
        • resource.secrets.secretEnv
        • resource.serviceAccount
        • resource.availableSecrets.secretManager.versionName
        • resource.availableSecrets.secretManager.env
        • resource.availableSecrets.inline.kmsKeyName
        • resource.availableSecrets.inline.envMap
        • resource.gitConfig.proxySecretVersionName
        • resource.gitConfig.proxySslCaInfo
        • resource.gitConfig.http
      • 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
      • Configurazione di Cloud Build WorkerPool
        • resource.displayName
        • resource.annotations
        • resource.privatePoolV1Config.workerConfig.machineType
        • resource.privatePoolV1Config.workerConfig.diskSizeGb
        • resource.privatePoolV1Config.networkConfig.peeredNetwork
        • resource.privatePoolV1Config.networkConfig.egressOption
        • resource.privatePoolV1Config.networkConfig.peeredNetworkIpRange
      • Configurazione di Cloud Build BuildTrigger
        • 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
      • Configurazione di Cloud Build GitHubEnterpriseConfig
        • resource.name
        • resource.hostUrl
        • resource.appId
        • resource.name
        • resource.webhookKey
        • resource.peeredNetwork
        • resource.secrets.privateKeyVersionName
        • resource.secrets.webhookSecretVersionName
        • resource.secrets.oauthSecretVersionName
        • resource.secrets.oauthClientIdVersionName
        • resource.displayName
        • resource.sslCa
      • Configurazione della connessione Cloud Build
        • resource.name
        • resource.githubConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.githubConfig.appInstallationId
        • resource.githubEnterpriseConfig.hostUri
        • resource.githubEnterpriseConfig.apiKey
        • resource.githubEnterpriseConfig.appId
        • resource.githubEnterpriseConfig.appSlug
        • resource.githubEnterpriseConfig.privateKeySecretVersion
        • resource.githubEnterpriseConfig.webhookSecretSecretVersion
        • resource.githubEnterpriseConfig.oauthSecretSecretVersion
        • resource.githubEnterpriseConfig.oauthClientIdSecretVersion
        • resource.githubEnterpriseConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.githubEnterpriseConfig.appInstallationId
        • resource.githubEnterpriseConfig.serviceDirectoryConfig.service
        • resource.githubEnterpriseConfig.sslCa
        • resource.gitlabConfig.hostUri
        • resource.gitlabConfig.webhookSecretSecretVersion
        • resource.gitlabConfig.readAuthorizerCredential.oauthTokenSecretVersionName
        • resource.gitlabConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.gitlabConfig.serviceDirectoryConfig.service
        • resource.gitlabConfig.sslCa
        • resource.gitlabConfig.serviceDirectoryConfig.service
        • resource.bitbucketDataCenterConfig.hostUri
        • resource.bitbucketDataCenterConfig.webhookSecretSecretVersion
        • resource.bitbucketDataCenterConfig.readAuthorizerCredential.oauthTokenSecretVersionName
        • resource.bitbucketDataCenterConfig.authorizerCredential.oauthTokenSecretVersionName
        • resource.bitbucketDataCenterConfig.sslCa
        • resource.bitbucketDataCenterConfig.serviceDirectoryConfig.service
        • resource.bitbucketCloudConfig.workspace
        • resource.bitbucketCloudConfig.webhookSecretSecretVersion
        • resource.bitbucketCloudConfig.readAuthorizerCredential.oauthTokenSecretVersionName
        • resource.bitbucketCloudConfig.authorizerCredential.oauthTokenSecretVersionName
      • Configurazione del repository Cloud Build
        • resource.name
        • resource.remoteUri
        • resource.annotations

      Esempi di norme personalizzate dell'organizzazione per casi d'uso comuni

      La seguente tabella fornisce la sintassi di alcune policy dell'organizzazione personalizzate che potresti trovare utili:

      Descrizione Sintassi del vincolo
      Consenti solo la creazione di trigger Pub/Sub che ascoltano gli argomenti contenenti "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: l'ID della tua organizzazione, ad esempio 123456789.

      Passaggi successivi