Questa pagina mostra come utilizzare i vincoli personalizzati del servizio Organization Policy per limitare operazioni specifiche sulle seguenti risorse Google Cloud :
aiplatform.googleapis.com/MetadataStore
Per saperne di più sul criterio dell'organizzazione, consulta Criteri dell'organizzazione personalizzati.
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 dei criteri dell'organizzazione, puoi definire un criterio dell'organizzazione, ovvero un insieme di restrizioni chiamate vincoli che si applicano alle Google Cloud risorse e ai relativi discendenti nella Google Cloud gerarchia delle risorse. Puoi applicare i criteri dell'organizzazione a livello di organizzazione, cartella o progetto.
Organization Policy fornisce vincoli gestiti integrati per vari servizi Google Cloud . Tuttavia, se vuoi un controllo più granulare e personalizzabile sui campi specifici limitati nelle norme dell'organizzazione, puoi anche creare vincoli personalizzati e utilizzarli in una norma dell'organizzazione.
Ereditarietà delle norme
Per impostazione predefinita, i criteri dell'organizzazione vengono ereditati dai discendenti delle risorse su cui applichi il criterio. Ad esempio, se applichi un criterio a una cartella, Google Cloud il criterio viene applicato a tutti i progetti nella cartella. Per scoprire di più su questo comportamento e su come modificarlo, consulta le regole di valutazione della gerarchia.
Vantaggi
Puoi utilizzare un criterio dell'organizzazione personalizzato per consentire o negare operazioni specifiche sulle risorse Vertex ML Metadata. Ad esempio, se una richiesta di creazione o aggiornamento della descrizione di una risorsa MetadataStore non soddisfa un insieme di convalida dei vincoli personalizzato impostato dalle norme della tua organizzazione, la richiesta non va a buon fine e viene restituito un errore al chiamante.
Prima di iniziare
1. Configurare il progetto- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Vertex AI API.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init -
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Vertex AI API.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init - Recupera l'ID risorsa dell'organizzazione.
-
Per gestire le policy dell'organizzazione:
Amministratore criteri organizzazione (
roles/orgpolicy.policyAdmin) sulla risorsa organizzazione -
Crea o aggiorna un archivio metadati:
Vertex AI Admin (
roles/aiplatform.admin) o Vertex AI User (roles/aiplatform.user) nella risorsa del progetto ORGANIZATION_ID: l'ID organizzazione, ad esempio123456789.CONSTRAINT_NAME: il nome che vuoi assegnare al nuovo vincolo personalizzato. Un vincolo personalizzato deve iniziare concustom.e può includere solo lettere maiuscole, minuscole o numeri. Ad esempio,custom.denyMetadataStoreDescription. La lunghezza massima di questo campo è 70 caratteri.RESOURCE_NAME: il nome completo della risorsaGoogle Cloud contenente l'oggetto e il campo che vuoi limitare. Ad esempio:aiplatform.googleapis.com/MetadataStore/resource.Description.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 saperne di più sulle risorse disponibili per scrivere condizioni, consulta Risorse supportate. Ad esempio,"resource.displayName.startsWith('Test')"ACTION: l'azione da intraprendere se la condizioneconditionè soddisfatta. I valori possibili sonoALLOWeDENY.DISPLAY_NAME: un nome facile da ricordare per il vincolo. Questo campo ha una lunghezza massima di 200 caratteri.DESCRIPTION: una descrizione comprensibile del vincolo da visualizzare come messaggio di errore in caso di violazione della policy. Questo campo ha una lunghezza massima di 2000 caratteri.- Nella console Google Cloud , vai alla pagina Policy dell'organizzazione.
- Nel selettore di progetti, seleziona il progetto per cui vuoi impostare il criterio dell'organizzazione.
- Dall'elenco nella pagina Criteri organizzazione, seleziona il vincolo per visualizzare la pagina Dettagli criterio relativa a quel vincolo.
- Per configurare la policy dell'organizzazione per questa risorsa, fai clic su Gestisci policy.
- Nella pagina Modifica policy, seleziona Esegui override della policy dell'unità organizzativa principale.
- Fai clic su Aggiungi una regola.
- Nella sezione Applicazione, seleziona se l'applicazione di questa policy dell'organizzazione è attiva o disattivata.
- (Facoltativo) Per rendere la policy dell'organizzazione condizionale in base a 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 incondizionata o la policy non può essere salvata. Per saperne di più, vedi Impostazione di un criterio dell'organizzazione con tag.
- 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 saperne di più, consulta Testare le modifiche alle policy dell'organizzazione con Policy Simulator.
- Per completare e applicare la policy dell'organizzazione, fai clic su Imposta policy. L'applicazione del criterio richiede fino a 15 minuti.
-
PROJECT_ID: il progetto su cui vuoi applicare il vincolo. -
CONSTRAINT_NAME: il nome che hai definito per il vincolo personalizzato. Ad esempio,custom.denyMetadataStoreDescription. - L'ID organizzazione
- Un ID progetto
Salva il seguente file come
constraint-validate-displayname-test.yaml:name: organizations/ORGANIZATION_ID/customConstraints/custom.denyMetadataStoreDescription resourceTypes: - resource.Description methodTypes: - CREATE condition:"resource.displayName.startsWith('Test')"actionType: DENY displayName: Deny metadata store descriptions that start with 'test' description: Only allow metadata store descriptions that don't start with 'test'Definisce un vincolo in base al quale la descrizione dei nuovi archivi di metadati non può iniziare con "test".
Applica il vincolo:
gcloud org-policies set-custom-constraint ~/constraint-validate-displayname-test.yamlVerifica che il vincolo esista:
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_IDL'output è simile al seguente:
CUSTOM_CONSTRAINT ACTION_TYPE METHOD_TYPES RESOURCE_TYPES DISPLAY_NAME custom.denyMetadataStoreDescription DENY CREATE resource.Description Deny metadata store descriptions that start with 'test' ...
Salva il seguente file come
policy-validate-displayname-test.yaml:name: projects/PROJECT_ID/policies/custom.denyMetadataStoreDescription spec: rules: - enforce: trueSostituisci
PROJECT_IDcon l'ID progetto.Applica le norme:
gcloud org-policies set-policy ~/policy-validate-displayname-test.yamlVerifica che il criterio esista:
gcloud org-policies list --project=PROJECT_IDL'output è simile al seguente:
CONSTRAINT LIST_POLICY BOOLEAN_POLICY ETAG custom.denyMetadataStoreDescription - SET COCsm5QGENiXi2E=Dopo aver applicato il criterio, attendi circa due minuti prima che Google Cloud inizi a applicarlo.
- LOCATION: la regione in cui vuoi creare l'archivio metadati. Per saperne di più sulle regioni in cui è disponibile Vertex ML Metadata, consulta la guida alle località di Vertex ML Metadata.
- PROJECT_ID: Il progetto Google Cloud in cui vuoi creare l'archivio dei metadati.
- Scopri di più sul Servizio Criteri dell'organizzazione.
- Scopri di più su come creare e gestire le norme dell'organizzazione.
- Consulta l'elenco completo dei vincoli delle policy dell'organizzazione gestiti.
Ruoli obbligatori
Per ottenere le autorizzazioni necessarie per gestire le policy dell'organizzazione, chiedi all'amministratore di concederti i seguenti ruoli IAM:
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.
Creare un vincolo personalizzato
Un vincolo personalizzato viene definito in un file YAML dalle risorse, dai metodi, dalle condizioni e dalle azioni supportati dal servizio su cui stai applicando il criterio dell'organizzazione. Le condizioni per i vincoli personalizzati sono definite utilizzando Common Expression Language (CEL). Per ulteriori informazioni su come creare condizioni nei vincoli personalizzati utilizzando CEL, consulta la sezione 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:
Per saperne di più su come creare un vincolo personalizzato, consulta Definizione di vincoli personalizzati.
Configurare un vincolo personalizzato
Dopo aver creato il file YAML per un nuovo vincolo personalizzato, devi configurarlo per renderlo disponibile per i criteri dell'organizzazione nella tua organizzazione. Per configurare un vincolo personalizzato, utilizza il comandogcloud org-policies set-custom-constraint:
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
CONSTRAINT_PATH con il percorso completo del tuo file di vincoli personalizzati. Ad esempio: /home/user/customconstraint.yaml.
Una volta completati, i vincoli personalizzati sono disponibili come policy dell'organizzazione
nell'elenco delle 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
ORGANIZATION_ID con l'ID della risorsa dell'organizzazione.
Per saperne di più, consulta Visualizzare le policy dell'organizzazione.
Applicare una policy dell'organizzazione personalizzata
Puoi applicare un vincolo creando un criterio dell'organizzazione che lo fa riferimento e poi applicando questo criterio dell'organizzazione a una risorsa. Google CloudConsole
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:
Per applicare il criterio dell'organizzazione contenente il vincolo, esegui questo comando:
gcloud org-policies set-policy POLICY_PATH
Sostituisci POLICY_PATH con il percorso completo del file YAML del criterio dell'organizzazione. L'applicazione del criterio richiede fino a 15 minuti.
Testa il criterio dell'organizzazione personalizzato
L'esempio seguente crea un vincolo e una norma personalizzati che non consentono che la descrizione di un archivio metadati inizi con "test".
Prima di iniziare, devi sapere quanto segue:
Crea il vincolo
Crea la policy
Testare la policy
Prova a creare un archivio di metadati con la descrizione "test_metadata_store".
REST
Per creare una risorsa MetadataStore, invia una richiesta POST utilizzando il metodo metadataStores/create.
Prima di utilizzare i dati della richiesta, apporta le seguenti sostituzioni:
Metodo HTTP e URL:
POST https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/metadataStores?metadata_store_id=default
Corpo JSON della richiesta:
{
"description":"test_metadata_store",
"encryptionSpec": {
"kmsKeyName":""
},
"dataplexConfig":{"enabledPipelinesLineage":"false"}
}
Per inviare la richiesta, scegli una di queste opzioni:
curl
Salva il corpo della richiesta in un file denominato request.json,
quindi esegui il comando seguente:
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/metadataStores?metadata_store_id=default"
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/metadataStores?metadata_store_id=default" | 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.denyMetadataStoreDescription\": \"Only allow metadata store descriptions that don't start with '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.denyMetadataStoreDescription"
}
}
]
}
}
Risorse supportate da Vertex ML Metadata
La tabella seguente elenca le risorse Vertex ML Metadata a cui puoi fare riferimento nei vincoli personalizzati.| Risorsa | Campo |
|---|---|
| aiplatform.googleapis.com/MetadataStore |
resource.dataplexConfig.enabledPipelinesLineage
|
resource.description
| |
resource.encryptionSpec.kmsKeyName
|