Crea vincoli personalizzati delle policy dell'organizzazione

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

  • aiplatform.googleapis.com/NotebookExecutionJob
  • aiplatform.googleapis.com/NotebookRuntime
  • aiplatform.googleapis.com/NotebookRuntimeTemplate

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

Informazioni sui criteri e sui vincoli dell'organizzazione

Il servizio Google Cloud 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 Colab Enterprise. Ad esempio, se una richiesta di creazione di un modello di runtime Colab Enterprise non soddisfa la convalida dei vincoli personalizzati impostata dalla policy dell'organizzazione, la richiesta non va a buon fine e viene restituito un errore al chiamante.

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 configurazioni delle risorse esistenti.
  • Una configurazione delle risorse esistente rimane valida anche se ha valori non conformi, a meno che non venga aggiornata.
  • I criteri dell'organizzazione personalizzati non vengono applicati alle esecuzioni pianificate dei blocchi note, a meno che l'esecuzione del blocco note non venga pianificata utilizzando direttamente l'API.

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.

    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.

    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 dell'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.restrictMachineSpecForNotebookRuntimeTemplate. 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: aiplatform.googleapis.com/NotebookRuntimeTemplate.

    • 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.machineSpec.machineType != \"n1-standard-2\"".

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

    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 una policy personalizzati che bloccano la creazione di modelli di runtime del notebook che non utilizzano il tipo di macchina n1-standard-2.

    Prima di iniziare, devi sapere quanto segue:

    • L'ID organizzazione
    • Un ID progetto

    Crea il vincolo

    1. Salva il seguente file come constraint-notebook-runtime-template.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictMachineSpecForNotebookRuntimeTemplate
resourceTypes:
- aiplatform.googleapis.com/NotebookRuntimeTemplate
methodTypes:
- CREATE
condition: "resource.machineSpec.machineType != \"n1-standard-2\""
actionType: DENY
displayName: Restrict machine type for notebook runtime templates
description: All new notebook runtime templates must use n1-standard-2 machines

      Definisce un vincolo in cui ogni nuovo modello di runtime del notebook deve utilizzare il tipo di macchina n1-standard-2, altrimenti la creazione del modello di runtime viene negata.

    2. Applica il vincolo:

      gcloud org-policies set-custom-constraint ~/constraint-notebook-runtime-template.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.restrictMachineSpecForNotebookRuntimeTemplate  DENY         CREATE         aiplatform.googleapis.com/NotebookRuntimeTemplate  Restrict machine type for notebook runtime templates
...

    Crea la policy

    1. Salva il seguente file come policy-deny-machine-type.yaml:

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

      Sostituisci PROJECT_ID con l'ID progetto.

    2. Applica la norma:

      gcloud org-policies set-policy ~/policy-deny-machine-type.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.restrictMachineSpecForNotebookRuntimeTemplate  -            SET                   CPHYssIGEOi23pAB-

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

    Testare la policy

    Prova a creare un modello di runtime Colab Enterprise con un tipo di macchina con limitazioni nel progetto:

    gcloud colab runtime-templates create --display-name="DISPLAY_NAME" \
    --project=PROJECT_ID \
    --region=LOCATION \
    --machine-type=n1-standard-4 \
    --accelerator-type=ACCELERATOR_TYPE \
    --accelerator-count=ACCELERATOR_COUNT

    L'output è il seguente:

    Operation denied by custom org policies: ["customConstraints/custom.restrictMachineSpecForNotebookRuntimeTemplate": "All new notebook runtime templates must use n1-standard-2 machines."]

    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
    Limita il tipo di macchina per i modelli di runtime di Colab Enterprise 
          name: organizations/ORGANIZATION_ID/customConstraints/custom.
      restrictMachineSpecForNotebookRuntimeTemplate
      resourceTypes:
      - aiplatform.googleapis.com/NotebookRuntimeTemplate
      methodTypes:
      - CREATE
      condition: "resource.machineSpec.machineType != "n1-standard-2""
      actionType: DENY
      displayName: Restrict machine type for notebook runtime templates
      description: All new notebook runtime templates must use n1-standard-2 machines.

    Risorse supportate da Colab Enterprise

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

    Risorsa Campo
    aiplatform.googleapis.com/NotebookExecutionJob resource.customEnvironmentSpec.machineSpec.acceleratorCount
    resource.customEnvironmentSpec.machineSpec.acceleratorType
    resource.customEnvironmentSpec.machineSpec.machineType
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.key
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.reservationAffinityType
    resource.customEnvironmentSpec.machineSpec.reservationAffinity.values
    resource.customEnvironmentSpec.machineSpec.tpuTopology
    resource.customEnvironmentSpec.networkSpec.enableInternetAccess
    resource.customEnvironmentSpec.networkSpec.network
    resource.customEnvironmentSpec.networkSpec.subnetwork
    resource.customEnvironmentSpec.persistentDiskSpec.diskSizeGb
    resource.customEnvironmentSpec.persistentDiskSpec.diskType
    resource.dataformRepositorySource.commitSha
    resource.dataformRepositorySource.dataformRepositoryResourceName
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.executionTimeout
    resource.executionUser
    resource.gcsNotebookSource.generation
    resource.gcsNotebookSource.uri
    resource.gcsOutputUri
    resource.kernelName
    resource.notebookRuntimeTemplateResourceName
    resource.scheduleResourceName
    resource.serviceAccount
    aiplatform.googleapis.com/NotebookRuntime resource.description
    resource.displayName
    resource.runtimeUser
    aiplatform.googleapis.com/NotebookRuntimeTemplate resource.dataPersistentDiskSpec.diskSizeGb
    resource.dataPersistentDiskSpec.diskType
    resource.description
    resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.eucConfig.eucDisabled
    resource.idleShutdownConfig.idleShutdownDisabled
    resource.idleShutdownConfig.idleTimeout
    resource.machineSpec.acceleratorCount
    resource.machineSpec.acceleratorType
    resource.machineSpec.machineType
    resource.machineSpec.reservationAffinity.key
    resource.machineSpec.reservationAffinity.reservationAffinityType
    resource.machineSpec.reservationAffinity.values
    resource.machineSpec.tpuTopology
    resource.networkSpec.enableInternetAccess
    resource.networkSpec.network
    resource.networkSpec.subnetwork
    resource.networkTags
    resource.notebookRuntimeType
    resource.reservationAffinity.consumeReservationType
    resource.reservationAffinity.key
    resource.reservationAffinity.values
    resource.shieldedVmConfig.enableSecureBoot
    resource.softwareConfig.colabImage.releaseName

    Passaggi successivi