Utilizzare vincoli personalizzati con le pipeline

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

  • aiplatform.googleapis.com/PipelineJob

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 una policy dell'organizzazione personalizzata per consentire o negare operazioni specifiche sulle risorse Vertex AI Pipelines. Ad esempio, se l'URI del modello specificato per creare una risorsa PipelineJob non soddisfa un insieme di convalida dei vincoli personalizzati impostato dalla policy dell'organizzazione, la richiesta non va a buon fine e viene restituito un errore al chiamante.

Limitazioni

I criteri dell'organizzazione personalizzati non vengono applicati alle esecuzioni della pipeline pianificate utilizzando l'API Scheduler.

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 Vertex AI, Compute Engine, and Cloud Storage APIs.

    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 APIs

  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 Vertex AI, Compute Engine, and Cloud Storage APIs.

    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 APIs

  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. Recupera l'ID risorsa dell'organizzazione.
  15. Definisci e compila una pipeline che puoi utilizzare per testare il vincolo personalizzato.

    16. Ruoli obbligatori

    Per ottenere le autorizzazioni necessarie per gestire le policy dell'organizzazione, chiedi all'amministratore di concederti i seguenti ruoli IAM:

    Per ulteriori informazioni 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
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.denyPipelineTemplate. 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/PipelineJob/resource.templateUri.

    • 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.templateUri.contains("test")".

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

    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 norma personalizzati che non consentono la creazione di esecuzioni della pipeline specificando un URI del modello che contiene "test".

    Prima di iniziare, devi sapere quanto segue:

    • L'ID organizzazione
    • Un ID progetto

    Crea il vincolo

    1. Salva il seguente file come constraint-validate-pipeline-template-uri.yaml:

      name: organizations/ORGANIZATION_ID/customConstraints/custom.denyPipelineTemplate
resourceTypes:
- resource.templateUri
methodTypes:
  - CREATE
  condition: "resource.templateUri.contains("test")"
  actionType: DENY
  displayName: Deny pipeline runs if the template URI contains 'test'
  description: Deny the creation of a new pipeline run if it's based on a template URI containing 'test'

      Definisce un vincolo in cui l'URI del modello di pipeline non può contenere test.

      1. Applica il vincolo:

        gcloud org-policies set-custom-constraint ~/constraint-validate-pipeline-template-uri.yaml

      2. 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.denyPipelineTemplate                DENY         CREATE         resource.templateUri    Deny pipeline runs if the template URI contains 'test'
...

    Crea la policy

    1. Salva il seguente file come policy-validate-pipeline-template-uri.yaml:

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

      Sostituisci PROJECT_ID con l'ID progetto.

    2. Applica la norma:

        gcloud org-policies set-policy ~/policy-validate-pipeline-template-uri.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.denyPipelineTemplate   -              SET               COCsm5QGENiXi2E=

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

    Testare la policy

    Prova a creare una pipeline ML con l'URI del modello contenente test.

    REST

    Per creare una risorsa PipelineJob, invia una richiesta POST utilizzando il metodo pipelineJobs/create.

    Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:

    • LOCATION: la regione in cui vuoi creare l'esecuzione della pipeline. Per ulteriori informazioni sulle regioni in cui è disponibile Vertex AI Pipelines, consulta la guida alle località di Vertex AI Pipelines.
    • PROJECT_ID: Il progetto Google Cloud in cui vuoi creare l'esecuzione della pipeline.
    • DISPLAY_NAME: il nome dell'esecuzione della pipeline. Verrà visualizzato nella console Google Cloud .

    Metodo HTTP e URL: 

    POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs

    Corpo JSON della richiesta: 

    {
  "displayName":"DISPLAY_NAME",
  "templateUri":"test_pipeline_template.json"
}

    Per inviare la richiesta, scegli una di queste opzioni:

    curl

    Salva il corpo della richiesta in un file denominato request.json, ed esegui questo comando: 

    curl -X POST \
         -H "Authorization: Bearer $(gcloud auth print-access-token)" \
         -H "Content-Type: application/json; charset=utf-8" \
         -d @request.json \
         "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs"

    PowerShell

    Salva il corpo della richiesta in un file denominato request.json, quindi esegui il comando seguente: 

    $cred = gcloud auth print-access-token
    $headers = @{ "Authorization" = "Bearer $cred" }

    Invoke-WebRequest `
        -Method POST `
        -Headers $headers `
        -ContentType: "application/json; charset=utf-8" `
        -InFile request.json `
        -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/pipelineJobs" | Select-Object -Expand Content

    Dovresti ricevere una risposta JSON simile alla seguente:

    {
  "error": {
    "code": 400,
    "message": "Operation denied by org policy on resource 'projects/PROJECT_ID/locations/LOCATION': [\"customConstraints/custom.denyPipelineTemplate\": \"Deny the creation of a new pipeline run if it's based on a template URI containing 'test'\"]",
    "status": "FAILED_PRECONDITION",
    "details": [
      {
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "CUSTOM_ORG_POLICY_VIOLATION",
        "domain": "googleapis.com",
        "metadata": {
          "service": "aiplatform.googleapis.com",
          "customConstraints": "customConstraints/custom.denyPipelineTemplate"
        }
      }
    ]
  }
}

    Risorse supportate da Vertex AI Pipelines

    La tabella seguente elenca le risorse Vertex AI Pipelines a cui puoi fare riferimento nei vincoli personalizzati.

    Risorsa Campo
    aiplatform.googleapis.com/PipelineJob resource.displayName
    resource.encryptionSpec.kmsKeyName
    resource.network
    resource.pipelineSpec
    resource.preflightValidations
    resource.pscInterfaceConfig.networkAttachment
    resource.reservedIpRanges
    resource.runtimeConfig.failurePolicy
    resource.runtimeConfig.gcsOutputDirectory
    resource.runtimeConfig.inputArtifacts[*].artifactId
    resource.runtimeConfig.parameterValues[*].boolValue
    resource.runtimeConfig.parameterValues[*].listValue.values
    resource.runtimeConfig.parameterValues[*].nullValue
    resource.runtimeConfig.parameterValues[*].numberValue
    resource.runtimeConfig.parameterValues[*].stringValue
    resource.runtimeConfig.parameterValues[*].structValue
    resource.serviceAccount
    resource.templateUri

    Passaggi successivi