Gestire le risorse Cloud Build con vincoli personalizzati

Il servizio Criteri dell'organizzazione offre un controllo centralizzato e programmatico sulle risorse della tua organizzazione. In qualità di amministratore dei criteri dell'organizzazione, puoi definire un criterio dell'organizzazione, ovvero un insieme di limitazioni chiamate vincoli che si applicano alle risorse Cloud Build e ai relativi discendenti nella gerarchia delle risorse Google Cloud. Puoi applicare i criteri dell'organizzazione all'indirizzo a livello di organizzazione, cartella o progetto.

Il servizio Organization Policy fornisce limitazioni predefinite per vari servizi Cloud Build. Tuttavia, se vuoi più granulare, personalizzabile controllo sui campi specifici con restrizioni nella tua organizzazione criteri, puoi anche creare criteri dell'organizzazione personalizzati.

Vantaggi

Puoi utilizzare un criterio dell'organizzazione personalizzato per consentire o negare specifiche risorse di Cloud Build. Ad esempio, se una richiesta di creazione o aggiornamento di un attivatore di compilazione non soddisfa la convalida dei vincoli personalizzati impostata dai criteri dell'organizzazione, la richiesta non andrà a buon fine e verrà restituito un errore all'autore della chiamata.

Ereditarietà dei criteri

Per impostazione predefinita, i criteri dell'organizzazione vengono ereditati dai discendenti dei e le risorse a cui applichi il criterio. Ad esempio, se applichi un criterio su una cartella, Cloud Build applica il criterio su tutti . Per scoprire di più su questo comportamento e su come modificarlo, consulta Regole di valutazione della gerarchia.

Prezzi

Il servizio Criteri dell'organizzazione, inclusi i criteri predefiniti e personalizzati dell'organizzazione, è offerto senza costi aggiuntivi.

Prima di iniziare

  1. Configurare 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.

      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. Assicurati di conoscere il ID organizzazione.

Ruoli obbligatori

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

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

Devi anche aggiungere i ruoli necessari per creare Cloud Build al tuo account utente. Vedi Configurazione dell'accesso alle risorse Cloud Build. A Per saperne 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. Sono specifici del servizio su cui applichi i criteri dell'organizzazione. Le condizioni per i vincoli personalizzati devono essere definite utilizzando il linguaggio Common Expression Language. Consulta la pagina GitHub su CEL (Common Expression Language). Per ulteriori informazioni su come creare condizioni nei vincoli personalizzati utilizzando CEL, consulta la sezione Creazione e gestione di vincoli personalizzati.

Utilizza il seguente modello per creare un file YAML per una limitazione personalizzata:

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 per il tuo nuovo un 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 esempioorganizations/123456789/customConstraints/custom.allowConstraint.

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

  • CONDITION: una condizione CEL scritta in base a una rappresentazione di una risorsa di servizio supportata. Questo ha una lunghezza massima di 1000 caratteri. Consulta Risorse supportate per ulteriori informazioni sugli e risorse disponibili per scrivere le condizioni. Ad esempio: "resource.github.name.contains('cloudbuild')".

  • ACTION: l'azione da intraprendere se viene soddisfatto il criterio condition. Può essere ALLOW o DENY.

  • DISPLAY_NAME: un nome semplice per di blocco. Questo campo ha una lunghezza massima di 200 caratteri.

  • DESCRIPTION: una descrizione del del vincolo che viene visualizzato come messaggio di errore quando il criterio viene violato. Questo ha una lunghezza massima di 2000 caratteri.

Per saperne di più su come creare un vincolo personalizzato, consulta Creare e gestire criteri dell'organizzazione personalizzati.

Configura un vincolo personalizzato

Dopo aver creato il file YAML per un nuovo vincolo personalizzato, devi configurarlo per disponibile per i criteri dell'organizzazione nella tua organizzazione. Per configurare 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 delle limitazioni personalizzate. Ad esempio: /home/user/customconstraint.yaml. Al termine, i vincoli personalizzati saranno disponibili come criteri dell'organizzazione nel tuo elenco di criteri dell'organizzazione di Google Cloud. Per verificare che il vincolo personalizzato esista, utilizza il metodo 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, vedi Visualizzazione dei criteri dell'organizzazione.

Applica un criterio dell'organizzazione personalizzato

Puoi applicare un vincolo booleano creando un criterio dell'organizzazione che vi faccia riferimento. e applicare il criterio dell'organizzazione a una risorsa Google Cloud.

Console

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

    Vai a Criteri dell'organizzazione

  2. Dal selettore di progetti, scegli il progetto per il quale vuoi impostare criterio dell'organizzazione.
  3. Nell'elenco della pagina Criteri dell'organizzazione, seleziona il vincolo per visualizzare la pagina Dettagli dei criteri relativa al vincolo in questione.
  4. Per configurare il criterio dell'organizzazione per questa risorsa, fai clic su Gestisci criterio.
  5. Nella pagina Modifica criterio, seleziona Sostituisci criterio della risorsa padre.
  6. Fai clic su Aggiungi una regola.
  7. Nella sezione Applicazione, scegli se applicare questo criterio dell'organizzazione sia attivato o disattivato.
  8. (Facoltativo) Per rendere condizionale il criterio dell'organizzazione a un tag, fai clic su Aggiungi condizione. Tieni presente che se aggiungi una regola condizionale a un criterio dell'organizzazione, devi aggiungere almeno una regola non condizionale, altrimenti il criterio non può essere salvato. Per ulteriori informazioni, consulta Impostare un criterio dell'organizzazione con tag.
  9. Se si tratta di un vincolo personalizzato, puoi fare clic su Testa modifiche per simulare l'effetto di questo criterio dell'organizzazione. Per ulteriori informazioni, vedi Testa le modifiche ai criteri dell'organizzazione con Policy Simulator.
  10. Per completare e applicare il criterio dell'organizzazione, fai clic su Imposta criterio. Le norme sono necessari fino a 15 minuti prima che le modifiche diventino effettive.

gcloud

Per creare un criterio dell'organizzazione che applichi un vincolo booleano, crea un criterio File YAML che fa 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. Per ad esempio custom.enableBuildTrigger.

Per applicare il criterio dell'organizzazione contenente la limitazione, esegui il seguente comando: 

    gcloud org-policies set-policy POLICY_PATH

Sostituisci POLICY_PATH con il percorso completo del criterio dell'organizzazione YAML. L'applicazione del criterio richiede fino a 15 minuti.

Testa 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 una limitazione richieda che i nomi degli attivatori GitHub contengano "cloudbuild". Puoi testare questa limitazione eseguendo il comando gcloud builds triggers create github con un altro nome di trigger, come mostrato nello snippet seguente:

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 dei vincoli personalizzati di Cloud Build sono disponibili per l'uso quando crei o aggiorni una risorsa Cloud Build.

Tieni presente che il vincolo sulle build non viene applicato in modo forzato alle build attivate dal trigger.

  • 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 del pool di worker di 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
  • Configurazione di BuildTrigger di 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
  • Configurazione GitHubEnterpriseConfig di Cloud Build
    • 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

Esempi di criteri dell'organizzazione personalizzati per i casi d'uso comuni

La tabella seguente fornisce la sintassi di alcuni criteri dell'organizzazione personalizzati che potrebbero esserti 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