Gestire le risorse utilizzando Data Catalog

Questa pagina spiega come cercare e gestire le risorse Spanner utilizzando Data Catalog.

Data Catalog è un servizio di gestione dei metadati completamente gestito e scalabile all'interno di Knowledge Catalog. Cataloga automaticamente i seguenti metadati relativi a istanze, database, tabelle, colonne e visualizzazioni Spanner:

  • Nome e nome completo
  • Località (regione)
  • Data di creazione e data dell'ultima modifica
  • Schema (per tabelle e visualizzazioni)
  • Descrizione

I metadati di Spanner vengono sincronizzati automaticamente con Data Catalog a intervalli regolari, in genere ogni poche ore. Puoi utilizzare Data Catalog per scoprire e comprendere i metadati di Spanner. Utilizza Data Catalog per le seguenti attività:

  • Analisi, incluse dipendenze e idoneità per un caso d'uso
  • Gestione dei cambiamenti
  • Movimento dei dati (pipeline)
  • Evoluzione dello schema

Con Data Catalog, puoi curare i metadati collegando i tag alle voci dei metadati di Spanner. Ogni tag può avere più campi di metadati e può essere basato su un modello di tag predefinito o personalizzato.

Ad esempio, puoi collegare il seguente tag a una colonna che contiene un numero di codice fiscale, che è un'informazione che consente l'identificazione personale (PII):

pii:true
pii_type:SSN

Quando sposti un'istanza che utilizza i tag, questi non vengono spostati automaticamente nell'istanza di destinazione. Devi invece esportare i tag dall'istanza di origine prima di spostarla e importarli nell'istanza di destinazione. Per saperne di più, consulta Esportare e importare i tag.

Per saperne di più su Data Catalog, consulta Che cos'è Data Catalog.

Prima di iniziare

  1. Accedi al tuo Google Cloud account. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti senza costi per l'esecuzione, il test e il deployment dei workload.
  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 role (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. 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 role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

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

  6. Abilita l'API Data Catalog per il progetto.

    Abilita l'API Data Catalog

  7. Controlla le autorizzazioni.

    Per cercare e collegare i tag agli asset Spanner, devi disporre di determinati ruoli e autorizzazioni di Identity and Access Management (IAM). Per maggiori dettagli, consulta Ruoli e autorizzazioni IAM richiesti per Data Catalog.

Creare modelli di tag

I modelli di tag sono strutture riutilizzabili per creare rapidamente nuovi tag. I modelli ti aiutano a evitare la duplicazione del lavoro e i tag incompleti. Crea tutti i modelli di tag che ti servono.

Per saperne di più, consulta Tag e modelli di tag.

Collegare i tag agli asset Spanner

Il collegamento dei tag agli asset Spanner ti consente di:

  • Aggiungere metadati aziendali agli asset.
  • Cercare gli asset in base ai metadati aziendali e ad altri metadati personalizzati.

Per saperne di più, consulta Tag e modelli di tag.

Cercare gli asset Spanner

Utilizza la pagina di ricerca di Knowledge Catalog nella Google Cloud console per cercare gli asset Spanner.

  1. Vai alla pagina di ricerca di Knowledge Catalog.

    Vai a Cerca

  2. Nel riquadro Filtri, in Sistemi, seleziona Spanner.

    Knowledge Catalog mostra tutti gli asset Spanner noti.

  3. (Facoltativo) Esegui una delle seguenti operazioni per restringere la ricerca:

    • Utilizza la ricerca per categorie nella pagina Cerca. Seleziona le caselle di controllo in Tipi di dati, Progetti e Tag.

    • Nel campo di ricerca, aggiungi un parametro di ricerca dopo system=cloud_spanner. Separa i parametri con spazi.

    Ad esempio, per visualizzare solo i database, inserisci il seguente testo nel campo di ricerca e poi premi Enter.

     system=cloud_spanner type=database
    

    Puoi anche utilizzare le parentesi e gli operatori logici and e or per espressioni complesse. Per saperne di più sulle espressioni che puoi utilizzare nel campo di ricerca, consulta Sintassi di ricerca di Data Catalog.

  4. Nella tabella dei risultati, fai clic sul nome di un asset per visualizzarne i metadati.

  5. (Facoltativo) Esegui una delle seguenti operazioni:

    • Fai clic su AGGIUNGI PANORAMICA per aggiungere una descrizione in RTF dell'asset.
    • Fai clic su COLLEGA TAG per aggiungere un tag all'asset.
    • Per una tabella, fai clic sulla scheda SCHEMA per visualizzare le colonne della tabella.
    • Per un'istanza (SERVIZIO), per visualizzare i database membri, fai clic sulla scheda ELENCO VOCI, quindi su VISUALIZZA LE VOCI SECONDARIE NELLA RICERCA. (Se la scheda ELENCO VOCI non viene visualizzata, l'istanza non ha database.)

Flusso di lavoro di esempio: visualizzare in dettaglio dall'istanza alle colonne

In questo flusso di lavoro di esempio, inizi cercando un'istanza Spanner, poi visualizzi un database membro, poi una tabella in quel database e infine le colonne della tabella.

  1. Vai alla pagina di ricerca di Knowledge Catalog.

    Vai a Cerca

  2. Nel riquadro Filtri, in Sistemi, seleziona Spanner.

  3. Per visualizzare tutte le istanze Spanner in Data Catalog, seleziona la casella di controllo Servizio in Tipi di dati oppure inserisci il seguente testo nel campo di ricerca e premi Enter.

    system=cloud_spanner type=service
    
  4. Seleziona il nome di un'istanza.

  5. Nella pagina Dettagli servizio Spanner, fai clic sulla scheda ELENCO VOCI, quindi su VISUALIZZA LE VOCI SECONDARIE NELLA RICERCA.

    Knowledge Catalog mostra i database nell'istanza.

  6. Nella pagina Dettagli database Spanner, fai clic sulla scheda ELENCO VOCI, quindi su VISUALIZZA LE VOCI SECONDARIE NELLA RICERCA.

    Knowledge Catalog mostra le tabelle nel database.

  7. Seleziona il nome di una tabella, quindi nella pagina Dettagli tabella Spanner, fai clic su SCHEMA per visualizzare le colonne della tabella.

  8. (Facoltativo) Per aggiungere un tag a una colonna, fai clic sul segno più in Tag colonna.

Esportare e importare i tag

Quando sposti un'istanza Spanner, la procedura di spostamento elimina i tag dell'istanza che hai creato in Data Catalog. Per conservare i tag, devi:

  • Eseguire una query sui tag associati all'istanza.
  • Copiare i dettagli dei tag.
  • Creare i tag nell'istanza spostata.

I dati di Spanner vengono sincronizzati ogni 6 ore. La propagazione a Data Catalog di eventuali modifiche ai metadati apportate agli asset Spanner, come istanze, database, tabelle, visualizzazioni o colonne, potrebbe richiedere circa 6 ore.

Esportare i tag dalla configurazione dell'istanza di origine

Per elencare i tag di un'istanza (voce o gruppo di voci), utilizza il comando di Google Cloud CLI gcloud data-catalog tags list come segue:

curl \
'https://datacatalog.googleapis.com/v1/projects/PROJECT/locations/LOCATION/entryGroups/ENTRY_GROUP/tags?key=API_KEY' \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  --header 'Accept: application/json' \
  --compressed

Sostituisci quanto segue:

  • PROJECT: progetto contenente i tag.
  • LOCATION: località dei tag.
  • API_KEY: una stringa univoca che ti consente di accedere a un'API.
  • ACCESS_TOKEN: il token di accesso utilizzato dall'applicazione per l'autenticazione al servizio.

Importare i tag nella configurazione di destinazione

Prima di completare questa procedura:

Per copiare un tag, crea i tag nell'istanza spostata utilizzando il gcloud data-catalog tags create comando come segue:

curl --request POST \
'https://datacatalog.googleapis.com/v1/entries:lookup?fullyQualifiedName=FQN&location=LOCATION&project=PROJECT&key=API_KEY' \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"column":"myColumnName","name":"myTagName","template":"myTemplateName","fields":{"myDoubleField":{"doubleValue":0}}}' \
  --compressed

Sostituisci quanto segue:

  • FQN: nome completo (FQN) della risorsa. I nomi completi hanno due forme:

    Per le risorse non regionalizzate: {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    Per le risorse regionalizzate: {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    Esempio per una tabella DPMS:

    dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

  • LOCATION: località in cui viene eseguita la ricerca.

  • PROJECT: progetto in cui viene eseguita la ricerca.

  • API_KEY: una stringa univoca che ti consente di accedere a un'API.

  • ACCESS_TOKEN: il token di accesso utilizzato dall'applicazione per l'autenticazione al servizio.

Ruoli e autorizzazioni IAM richiesti per Data Catalog

La tabella seguente mostra i ruoli e le autorizzazioni IAM richiesti per le varie operazioni di Data Catalog.

Operazione di Data Catalog Risorsa Spanner Ruoli o autorizzazioni richiesti
Creare un modello di tag N/D roles/datacatalog.tagTemplateCreator
Cercare le risorse Spanner Istanza spanner.instances.get
Database spanner.databases.get
Tabella spanner.databases.get
Visualizzazioni spanner.databases.get
Visualizzare i tag pubblici Istanza spanner.instances.get
Database spanner.databases.get
Tabella spanner.databases.get
Visualizzazioni spanner.databases.get
Visualizzare i tag privati Istanze datacatalog.tagTemplates.getTag + spanner.instances.get
Database datacatalog.tagTemplates.getTag + spanner.databases.get
Tabelle datacatalog.tagTemplates.getTag + spanner.databases.get
Visualizzazioni datacatalog.tagTemplates.getTag + spanner.databases.get
Collegare un tag a una risorsa Spanner utilizzando un modello di tag Istanze datacatalog.tagTemplates.use + spanner.instances.updateTag
Database datacatalog.tagTemplates.use + spanner.databases.updateTag
Tabelle datacatalog.tagTemplates.use + spanner.databases.updateTag
Visualizzazioni datacatalog.tagTemplates.use + spanner.databases.updateTag

L'autorizzazione spanner.instances.UpdateTag è inclusa nel seguente ruolo:

  • roles/spanner.admin

L'autorizzazione spanner.databases.UpdateTag è inclusa nei seguenti ruoli:

  • roles/spanner.admin
  • roles/spanner.databaseAdmin
  • roles/spanner.databaseUser

Per saperne di più, consulta Ruoli predefiniti.

Passaggi successivi