Creare vincoli personalizzati dei criteri dell'organizzazione

Questa pagina mostra come utilizzare i vincoli personalizzati del servizio Organization Policy per limitare operazioni specifiche sulle seguenti risorse Google Cloud :

  • dataform.googleapis.com/Repository

Per saperne di più sulle policy dell'organizzazione, consulta Policy dell'organizzazione personalizzate.

Informazioni sui criteri e sui vincoli dell'organizzazione

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

La policy dell'organizzazione fornisce vincoli gestiti integrati per vari servizi Google Cloud . Tuttavia, se cerchi un controllo più granulare e personalizzabile sui campi specifici limitati nelle policy dell'organizzazione, puoi anche creare vincoli personalizzati e utilizzarli in una policy dell'organizzazione.

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, Google Cloud 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.

Vantaggi

Puoi utilizzare le policy dell'organizzazione personalizzate per consentire o negare valori specifici per le risorse Dataform. Ad esempio, se una richiesta di creazione o aggiornamento di una risorsa dataform.googleapis.com/Repository non supera la convalida del vincolo personalizzato impostato dai criteri dell'organizzazione, la richiesta non va a buon fine e viene restituito un errore al chiamante.

L'utilizzo di policy dell'organizzazione personalizzate aggiunge un ulteriore livello di sicurezza, conformità e governance. Ad esempio, puoi definire criteri che consentano la creazione di risorse solo in una determinata regione o che vietino l'utilizzo di repository Git remoti al di fuori della tua organizzazione.

Limitazioni

Come tutti i vincoli dei criteri dell'organizzazione, le modifiche ai criteri non vengono applicate retroattivamente alle risorse esistenti:

  • Un nuovo criterio non influisce sulle risorse esistenti.
  • Se modifichi il criterio, una risorsa esistente rimane valida, a meno che tu non modifiche la risorsa da un valore conforme a uno non conforme utilizzando la consoleGoogle Cloud o una RPC.

Ti consigliamo di rendere tutte le risorse esistenti conformi a una norma prima di applicarne una nuova. Per verificare quali risorse esistenti non saranno conformi dopo l'applicazione forzata di una policy, utilizza Policy Simulator per le policy dell'organizzazione.

Prima di iniziare

  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. Install the Google Cloud CLI.

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

  6. Per inizializzare gcloud CLI, esegui questo comando: 

    gcloud init

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

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

  9. Install the Google Cloud CLI.

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

  11. Per inizializzare gcloud CLI, esegui questo comando: 

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

    13. Ruoli obbligatori

    Per ottenere le autorizzazioni necessarie per gestire le policy dell'organizzazione personalizzate, 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.

    Crea un vincolo personalizzato

    Un vincolo personalizzato è definito in un file YAML dalle risorse, dai metodi, dalle condizioni e dalle azioni supportate dal servizio a cui stai applicando la policy dell'organizzazione. Le condizioni per i vincoli personalizzati vengono definite utilizzando il 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.

    Per creare un vincolo personalizzato, crea un file YAML utilizzando il seguente formato:

    name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- 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.restrictRepositoryLocation. La lunghezza massima di questo campo è di 70 caratteri.

    • RESOURCE_NAME: il nome completo della risorsaGoogle Cloud contenente l'oggetto e il campo che vuoi limitare. Ad esempio: dataform.googleapis.com/Repository.

    • 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.name.contains('/locations/us-central1/')".

    • ACTION: l'azione da eseguire se condition è soddisfatta. I valori possibili sono ALLOW e 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 Definizione di vincoli personalizzati.

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

    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.

    Testa il criterio dell'organizzazione personalizzato

    L'esempio seguente crea un vincolo e un criterio personalizzati che richiedono la creazione di tutte le risorse dataform.googleapis.com/Repository in una regione specifica.

    Prima di iniziare, devi disporre di quanto segue:

    • L'ID organizzazione
    • Un ID progetto

    Crea il vincolo

    Per creare un vincolo personalizzato:

    1. Salva il seguente file come constraint-restrict-repository-location.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
resourceTypes:
- dataform.googleapis.com/Repository
methodTypes:
- CREATE
- UPDATE
condition: "resource.name.contains('/locations/us-central1/')"
actionType: ALLOW
displayName: Only us-central1 region is allowed.
description: All resources must be created in the us-central1 region.

      Sostituisci ORGANIZATION_ID con l'ID organizzazione.

      Questo file definisce un vincolo in cui per ogni operazione di creazione o aggiornamento della risorsa dataform.googleapis.com/Repository, l'operazione è consentita solo se la regione selezionata per la risorsa è us-central1.

    2. Applica il vincolo:

      gcloud org-policies set-custom-constraint ~/constraint-restrict-repository-location.yaml

    3. Verifica che il vincolo esista:

      gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID

      L'output è simile al seguente:

      CUSTOM_CONSTRAINT                       ACTION_TYPE  METHOD_TYPES   RESOURCE_TYPES                     DISPLAY_NAME
custom.restrictRepositoryLocation       ALLOW        CREATE,UPDATE  dataform.googleapis.com/Repository Only us-central1 region is allowed.
...

    Crea la policy

    Ora crea una norma e applicala al vincolo personalizzato che hai creato.

    1. Salva il seguente file come policy-restrict-repository-location.yaml:

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

      Sostituisci PROJECT_ID con l'ID progetto.

    2. Applica la norma:

      gcloud org-policies set-policy ~/policy-restrict-repository-location.yaml

    3. Verifica che il criterio esista:

      gcloud org-policies list --project=PROJECT_ID

      L'output è simile al seguente:

      CONSTRAINT                           LIST_POLICY    BOOLEAN_POLICY    ETAG
custom.restrictRepositoryLocation    -              SET               ETAG

    Dopo aver applicato il criterio, attendi circa due minuti affinché Google Cloud inizi a applicarlo.

    Testare la policy

    Segui i passaggi descritti in Creare un repository per creare una risorsa dataform.googleapis.com/Repository nel tuo progetto. Scegli una regione diversa da quella specificata nel vincolo personalizzato.

    L'output è il seguente:

    Operation denied by custom org policies: ["customConstraints/custom.restrictRepositoryLocation": "All resources must be created in the us-central1 region."]

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

    Questa tabella fornisce esempi di sintassi per alcuni vincoli personalizzati comuni.

    Descrizione Sintassi del vincolo
    Tutte le risorse devono essere create nella regione us-central1. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictRepositoryLocation
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.name.contains('/locations/us-central1/')"
    actionType: ALLOW
    displayName: Only us-central1 region is allowed.
    description: All resources must be created in the us-central1 region.
    Consente solo la configurazione di un repository Git remoto per la connessione tramite HTTPS ai repository nell'organizzazione Google su GitHub. 
        name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictGitRemote
    resourceTypes:
    - dataform.googleapis.com/Repository
    methodTypes:
    - CREATE
    - UPDATE
    condition: |-
      resource.gitRemoteSettings.url == ""
      || resource.gitRemoteSettings.url.startsWith('https://github.com/google/')
    actionType: ALLOW
    displayName:  Only allow the https://github.com/google/ Git remote.
    description: Only allow configuration of a Git remote to connect using HTTPS to repositories in the Google organization on GitHub.

    Risorse supportate da Dataform

    La tabella seguente elenca le risorse Dataform a cui puoi fare riferimento nei vincoli personalizzati.

    Risorsa Campo
    dataform.googleapis.com/Repository resource.displayName
    resource.gitRemoteSettings.authenticationTokenSecretVersion
    resource.gitRemoteSettings.defaultBranch
    resource.gitRemoteSettings.sshAuthenticationConfig.hostPublicKey
    resource.gitRemoteSettings.sshAuthenticationConfig.userPrivateKeySecretVersion
    resource.gitRemoteSettings.url
    resource.kmsKeyName
    resource.name
    resource.npmrcEnvironmentVariablesSecretVersion
    resource.serviceAccount
    resource.setAuthenticatedUserAdmin
    resource.workspaceCompilationOverrides.defaultDatabase
    resource.workspaceCompilationOverrides.schemaSuffix
    resource.workspaceCompilationOverrides.tablePrefix

    Passaggi successivi