Gestire le risorse Firestore utilizzando vincoli personalizzati

Gestire le risorse Firestore utilizzando vincoli personalizzati

Questa pagina mostra come utilizzare i vincoli personalizzati del servizio Criteri dell'organizzazione per limitare operazioni specifiche sulle seguenti risorse Google Cloud:

• firestore.googleapis.com/Database

Per scoprire di più sui criteri dell'organizzazione, consulta Criteri dell'organizzazione personalizzati.

Informazioni sui criteri e sui vincoli dell'organizzazione

Il servizio Criteri dell'organizzazione di Google Cloud 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 Google Cloud e ai relativi discendenti nella gerarchia delle risorse Google Cloud. Puoi applicare i criteri dell'organizzazione a livello di organizzazione, cartella o progetto.

I criteri dell'organizzazione forniscono vincoli predefiniti per diversi servizi Google Cloud. Tuttavia, se vuoi un controllo più granulare e personalizzabile sui campi specifici limitati nei criteri dell'organizzazione, puoi anche creare vincoli personalizzati e utilizzarli in un criterio 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 lo applica a tutti i progetti nella cartella. Per scoprire di più su questo comportamento e su come modificarlo, consulta Regole di valutazione della gerarchia.

Vantaggi

• Sicurezza, conformità e governance: puoi utilizzare i criteri personalizzati per l'organizzazione come segue:

  • Per applicare i requisiti di ripristino di emergenza, puoi richiedere impostazioni specifiche per ripristino di emergenza sui database, come la protezione eliminazione e il recupero point-in-time.

  • Puoi limitare la creazione del database solo a determinate località.

  • Puoi richiedere una chiave di crittografia gestita dal cliente (CMEK) per i database.

• Controllo: i vincoli dei criteri dell'organizzazione personalizzati vengono registrati nel log di controllo. Qualsiasi operazione, incluse le modifiche e i controlli dei vincoli, genererà Cloud Audit Logs corrispondenti.

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.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Install the Google Cloud CLI.

5. To initialize the gcloud CLI, run the following command:

   gcloud init

6. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

7. Make sure that billing is enabled for your Google Cloud project.

8. Install the Google Cloud CLI.

9. To initialize the gcloud CLI, run the following command:

   gcloud init

10. Assicurati di conoscere il ID organizzazione.

Ruoli obbligatori

Per ottenere le autorizzazioni necessarie per gestire i criteri dell'organizzazione personalizzati, chiedi all'amministratore di concederti il ruolo IAM Amministratore dei criteri dell'organizzazione (roles/orgpolicy.policyAdmin) nella 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 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 supportate dal servizio su cui stai applicando il criterio dell'organizzazione. Le condizioni per i vincoli personalizzati vengono definite utilizzando Common Expression Language (CEL). Per ulteriori informazioni su come creare condizioni nei vincoli personalizzati utilizzando CEL, consulta la sezione CEL di Creare e gestire vincoli personalizzati.

Per creare una limitazione personalizzata, 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.deleteProtectionRequired. La lunghezza massima di questo campo è di 70 caratteri.

• RESOURCE_NAME: il nome completo della risorsa Google Cloud contenente l'oggetto e il campo che vuoi limitare. Ad esempio, firestore.googleapis.com/Database.

• 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. Consulta la sezione Risorse supportate per ulteriori informazioni sulle risorse disponibili per la scrittura delle condizioni. Ad esempio, "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\"".

• ACTION: l'azione da intraprendere se viene soddisfatto il criterio condition. I valori possibili sono ALLOW e DENY.

• DISPLAY_NAME: un nome facile da ricordare per la limitazione. 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 del criterio. Questo campo ha una lunghezza massima di 2000 caratteri.

Per saperne di più su come creare un vincolo personalizzato, consulta Definire 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 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 delle limitazioni personalizzate. Ad esempio: /home/user/customconstraint.yaml. Al termine, i vincoli personalizzati sono disponibili come criteri dell'organizzazione nell'elenco dei criteri dell'organizzazione di Google Cloud. Per verificare che la limitazione personalizzata 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 Visualizzare i criteri dell'organizzazione.

Applicare un criterio dell'organizzazione personalizzato

Puoi applicare un vincolo booleano creando un criterio dell'organizzazione che lo richiami e poi applicando questo criterio dell'organizzazione a una risorsa Google Cloud.

Console

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

   Vai a Criteri dell'organizzazione

2. Nel selettore di progetti, seleziona il progetto per cui vuoi impostare il criterio dell'organizzazione.
3. Nell'elenco della pagina Criteri organizzazione, seleziona il vincolo per visualizzare la pagina Dettagli 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 Ignora criterio della risorsa padre.
6. Fai clic su Aggiungi una regola.
7. Nella sezione Applicazione, seleziona se l'applicazione di questo criterio dell'organizzazione è attivata o disattivata.
8. (Facoltativo) Per rendere il criterio dell'organizzazione condizionale su 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 Prova modifiche per simulare l'effetto di questo criterio dell'organizzazione. Per ulteriori informazioni, consulta Testare le modifiche ai criteri dell'organizzazione con Policy Simulator.
10. Per completare e applicare il criterio dell'organizzazione, fai clic su Imposta criterio. L'applicazione del criterio può richiedere fino a 15 minuti.

gcloud

Per creare un criterio dell'organizzazione che applichi un vincolo booleano, crea un file YAML del criterio 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.deleteProtectionRequired.

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 file YAML del criterio dell'organizzazione. L'applicazione del criterio può richiedere fino a 15 minuti.

Testa il criterio dell'organizzazione personalizzato

Prima di iniziare, devi sapere quanto segue:

• Il tuo ID organizzazione

1. Crea il file deleteProtectionRequired.yaml nel seguente modo:

    name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired
    resourceTypes:
    - firestore.googleapis.com/Database
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.deleteProtectionState == \"DELETE_PROTECTION_ENABLED\""
    actionType: ALLOW
    displayName: Firestore Delete Protection Required
    description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
   

   In questo modo, tutti i metodi CREATE e UPDATE in un database Firestoresoddisfano il vincolo che deleteProtectionState siaDELETE_PROTECTION_ENABLED. Di conseguenza, tutte le operazioni di creazione/aggiornamento/ripristino/clonazione dei database senza l'attivazione esplicita della Protezione eliminazione vengono rifiutate.

2. Configura il vincolo personalizzato a livello di organizzazione:

   gcloud org-policies set-custom-constraint deleteProtectionRequired.yaml
   

Testa il criterio

Prova a creare un database senza impostare il flag --delete-protection in un progetto dell'organizzazione:

gcloud firestore database create \
   --project=PROJECT_ID \
   --database=DATABASE_ID \

L'output è il seguente:

Operation denied by custom org policies: ["customConstraints/custom.deleteProtectionRequired": "To ensure the data security, Delete Protection is required to be enabled for Firestore databases"]

Testare e analizzare le modifiche ai criteri dell'organizzazione

Ti consigliamo di testare e eseguire prove di tutte le modifiche ai criteri della tua organizzazione per comprendere meglio lo stato del tuo ambiente e in che modo le modifiche lo influenzano.

Policy Simulator per i criteri dell'organizzazione ti aiuta a comprendere l'effetto di un vincolo e di un criterio dell'organizzazione sul tuo ambiente attuale. Con questo strumento, puoi esaminare tutte le configurazioni delle risorse per vedere dove si verificano le violazioni prima che vengano applicate nel tuo ambiente di produzione. Per istruzioni dettagliate, consulta Testare le modifiche ai criteri dell'organizzazione con Policy Simulator.

Una volta compreso l'effetto attuale, puoi creare un criterio dell'organizzazione in modalità di prova per comprendere l'impatto e le potenziali violazioni di un criterio nei prossimi 30 giorni. Un criterio dell'organizzazione in modalità di prova è un tipo di criterio dell'organizzazione in cui le violazioni del criterio vengono registrate durante il controllo, ma le azioni in violazione non vengono negate. Puoi creare un criterio dell'organizzazione in modalità di prova da un vincolo personalizzato utilizzando la console Google Cloud o Google Cloud CLI. Per istruzioni dettagliate, consulta Creare un criterio dell'organizzazione in modalità di prova.

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

La tabella seguente fornisce la sintassi di alcuni vincoli personalizzati per i casi d'uso comuni:

Descrizione	Sintassi dei vincoli
I nomi dei database devono seguire un determinato pattern. Tieni presente che il formato di un nome di database nei criteri dell'organizzazione personalizzata è projects/project-id/databases/database-id, mentre nelle operazioni di gestione del database viene specificato solo database-id.	name: organizations/ORGANIZATION_ID/customConstraints/custom.nameSuffixMobile resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.name.endsWith('-mobile')" actionType: ALLOW displayName: Firestore database names end with "-mobile" description: Only allow the creation of database names ending with suffix "-mobile"
I database possono essere creati solo in località specifiche.	name: organizations/ORGANIZATION_ID/customConstraints/custom.locationUsCentral1 resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE condition: "resource.locationId == 'us-central1'" actionType: ALLOW displayName: Firestore database location id us-central1 description: Only allow the creation of databases in region us-central1
I database devono essere del tipo specificato.	name: organizations/ORGANIZATION_ID/customConstraints/custom.typeFirestore resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.type=="FIRESTORE_NATIVE"" actionType: ALLOW displayName: Firestore database type Firestore_Native description: Only allow creation and updating of databases if the type is Firestore in native mode.
I database devono utilizzare la modalità di concorrenza specificata.	name: organizations/ORGANIZATION_ID/customConstraints/custom.concurrencyNotPessimistic resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.concurrencyMode == 'PESSIMISTIC'" actionType: DENY displayName: Firestore database concurrencyMode not pessimistic description: Disallow the creation and updating of databases with pessimistic concurrency mode.
I database devono abilitare il point-in-time-recovery.	name: organizations/ORGANIZATION_ID/customConstraints/custom.pitrEnforce resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.pointInTimeRecoveryEnablement == "POINT_IN_TIME_RECOVERY_ENABLED"" actionType: ALLOW displayName: Firestore database enables PiTR description: Only allow the creation and updating of a databases if PiTR is enabled.
I database devono utilizzare la modalità di integrazione di App Engine specificata.	name: organizations/ORGANIZATION_ID/customConstraints/custom.enableAppEngineIntegrationMode resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.appEngineIntegrationMode == 'ENABLED'" actionType: ALLOW displayName: Firestore Database App Engine integration mode enabled description: Only allow the creation and updating of databases with App Engine Integration Mode enabled.
Non consentire la creazione di database, a meno che non sia abilitata la protezione da eliminazione.	name: organizations/ORGANIZATION_ID/customConstraints/custom.deleteProtectionRequired resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.deleteProtectionState == "DELETE_PROTECTION_ENABLED"" actionType: ALLOW displayName: Firestore Delete Protection Required description: To ensure the data security, Delete Protection is required to be enabled for Firestore databases.
I database devono utilizzare la configurazione CMEK (chiave di crittografia gestita dal cliente) specificata.	name: organizations/ORGANIZATION_ID/customConstraints/custom.cmekKeyNotDev resourceTypes: - firestore.googleapis.com/Database methodTypes: - CREATE - UPDATE condition: "resource.cmekConfig.kmsKeyName.matches('dev$')" actionType: DENY displayName: Firestore database CMEK key not dev description: Disallow the creation and updating of databases with CMEK KMS keys ending with "dev".

Risorse supportate da Firestore

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

Risorsa	Campo
firestore.googleapis.com/Database	resource.appEngineIntegrationMode
	resource.cmekConfig.kmsKeyName
	resource.concurrencyMode
	resource.deleteProtectionState
	resource.locationId
	resource.name
	resource.pointInTimeRecoveryEnablement
	resource.type

Passaggi successivi

• Scopri di più sul Servizio Criteri dell'organizzazione.
• Scopri di più su come creare e gestire i criteri dell'organizzazione.
• Consulta l'elenco completo dei vincoli dei criteri dell'organizzazione predefiniti.