Knowledge Catalog (in precedenza Dataplex Universal Catalog) supporta la pianificazione dell'esecuzione di codice personalizzato, come esecuzione una tantum, in base a una pianificazione regolare o on demand. On demand è in anteprima ed è disponibile solo tramite API. Puoi pianificare le trasformazioni dei dati dei clienti utilizzando Spark (Java), PySpark (limitato alla versione 3.2 di Spark) o Spark SQL. Knowledge Catalog esegue il codice utilizzando l'elaborazione Spark serverless e uno scheduler serverless integrato.
Terminologia
- Attività
- Un'attività Knowledge Catalog rappresenta il lavoro che vuoi che Knowledge Catalog esegua in base a una pianificazione. Contiene il codice, i parametri e la pianificazione.
- Job
Un job rappresenta una singola esecuzione di un'attività Knowledge Catalog. Ad esempio, se un'attività è pianificata per essere eseguita quotidianamente, Knowledge Catalog creerà un job ogni giorno.
Per i job creati a partire dal 10 maggio 2023, il campo Trigger mostra il tipo di trigger di esecuzione del job.
Di seguito sono riportati i tipi di trigger di esecuzione dei job:
RUN_REQUEST: indica che il job è stato eseguito a causa della chiamata all'API
RunTask.TASK_CONFIG: indica che il job è stato eseguito a causa della
TriggerSpecconfigurazione dell'attività.
Modalità di pianificazione
Knowledge Catalog supporta le seguenti modalità di pianificazione:
- Esegui una volta
- Utilizza questa modalità per eseguire l'attività una sola volta. Puoi scegliere di eseguirlo immediatamente o in un orario futuro prestabilito. Se esegui l'attività immediatamente, l'esecuzione potrebbe comunque richiedere fino a due minuti.
- Esegui in base a una programmazione
- Utilizza questa modalità per eseguire l'attività con una frequenza ripetuta. Le ripetizioni supportate sono giornaliera, settimanale, mensile o personalizzata.
- Esegui on demand
Utilizza questa modalità per eseguire un'attività creata in precedenza su richiesta. La modalità di esecuzione on demand è supportata solo dall'API
RunTask. Quando il job viene eseguito on demand, Knowledge Catalog utilizza i parametri esistenti per creare un job. Puoi specificare gli argomentiExecutionSpece le etichette per eseguire il job.
Prima di iniziare
Abilita l'API Managed Service for Apache Spark.
Abilita l'accesso privato Google per la tua rete e la tua subnet. Abilita l'accesso privato Google sulla rete che utilizzi con le attività Knowledge Catalog. Se non specifichi una rete o una subnet quando crei l'attività Knowledge Catalog, Knowledge Catalog utilizza la subnet predefinita e devi abilitare l'accesso privato Google per la subnet predefinita.
Crea un service account. Per pianificare le attività di Knowledge Catalog è necessario un account di servizio. Il account di servizio deve appartenere al progetto in cui esegui le attività. Il account di servizio deve disporre delle seguenti autorizzazioni:
Accesso ai dati BigQuery e Cloud Storage in fase di elaborazione.
Ruolo di worker di Managed Service for Apache Spark sul progetto in cui esegui l'attività.
Se l'attività deve leggere o aggiornare l'istanza del metastore di Managed Service for Apache Spark collegata al lake, il account di servizio deve disporre del ruolo Visualizzatore o Editor del metastore di Managed Service for Apache Spark. Questo ruolo deve essere concesso nel progetto in cui è configurato il Knowledge Catalog lake.
Se l'attività è un job Spark SQL, devi concedere all'account di servizio il ruolo Sviluppatore Dataplex. Questo ruolo deve essere concesso nel progetto in cui è configurato il lake Knowledge Catalog.
Se l'attività è un job Spark SQL, devi disporre delle autorizzazioni di amministratore Cloud Storage sul bucket in cui vengono scritti i risultati.
Per pianificare ed eseguire Spark SQL e attività Spark personalizzate, devi disporre dei ruoli IAM Lettore metadati Dataplex (
roles/dataplex.metadataReader), Visualizzatore Dataplex (roles/dataplex.viewer) e Utente metadati metastore di Managed Service for Apache Spark (roles/metastore.metadataUser) per il tuo account di servizio.
Concedi all'utente che invia il job il ruolo Service Account User (
roles/iam.serviceAccountUser) nel account di servizio. Per le istruzioni, vedi Gestire l'accesso agli account di servizio.Concedi al account di servizio del data lake Knowledge Catalog le autorizzazioni per utilizzare il account di servizio. Puoi trovare il service account del lake Knowledge Catalog nella pagina Dettagli lake della consoleGoogle Cloud .
Se il progetto contenente il tuo lake Knowledge Catalog è diverso dal progetto in cui deve essere eseguita l'attività, concedi all'account di servizio del lake Knowledge Catalog il ruolo Editor di Managed Service for Apache Spark nel progetto in cui esegui l'attività.
Inserisci gli artefatti di codice richiesti (file JAR, Python o script SQL) o i file archiviati (
.jar,.tar,.tar.gz,.tgz,.zip) in un percorso Cloud Storage.Assicurati che il account di servizio disponga dell'autorizzazione
storage.objects.getnecessaria per il bucket Cloud Storage che archivia questi artefatti di codice.
Pianifica un'attività Spark (Java o Python)
Console
Nella console Google Cloud , vai alla pagina Processo di Knowledge Catalog.
Fai clic su Crea attività.
In Crea attività Spark personalizzata, fai clic su Crea attività.
Scegli un lake Knowledge Catalog.
Fornisci un nome per l'attività.
Crea un ID per l'attività.
Nella sezione Configurazione attività, per Tipo, seleziona Spark o PySpark.
Inserisci gli argomenti pertinenti.
Nel campo Service account, inserisci un account di servizio utente con cui può essere eseguita l'attività Spark personalizzata.
Fai clic su Continua.
(Facoltativo) Imposta pianificazione: seleziona Esegui una volta o Ripeti. Compila i campi obbligatori.
Fai clic su Continua.
(Facoltativo) Personalizza le risorse e aggiungi impostazioni aggiuntive.
Fai clic su Crea.
gcloud
Puoi pianificare un'attività Spark (Java / Python) utilizzando il comando gcloud CLI. La tabella seguente elenca i parametri obbligatori e facoltativi da utilizzare:
| Parametro | Descrizione |
|---|---|
--lake |
L'ID lake per la risorsa lake del servizio Knowledge Catalog. |
--location |
La posizione del servizio Knowledge Catalog. |
--spark-main-class |
La classe principale di conducente. Il file jar che
contiene la classe deve trovarsi nella cartella CLASSPATH predefinita.
|
--spark-main-jar-file-uri |
L'URI Cloud Storage del file jar che contiene
la classe principale.
|
--spark-archive-uris |
(Facoltativo) URI Cloud Storage degli archivi da estrarre nella directory di lavoro di ciascun esecutore. Tipi di file supportati:
.jar, .tar, .tar.gz,
.tgz e .zip.
|
--spark-file-uris |
(Facoltativo) URI Cloud Storage dei file da inserire nella directory di lavoro di ciascun esecutore. |
--batch-executors-count |
(Facoltativo) Il numero totale di esecutori job. Il valore predefinito è 2. |
--batch-max-executors-count |
(Facoltativo) Il numero massimo di esecutori configurabili. Il valore predefinito è 1000. Se batch-max-executors-count è maggiore di
batch-executors-count, Knowledge Catalog abilita
la scalabilità automatica.
|
--container-image-java-jars |
(Facoltativo) Un elenco di JAR Java da aggiungere al classpath. L'input valido include gli URI Cloud Storage ai file binari Jar. Ad esempio, gs://bucket-name/my/path/to/file.jar.
|
--container-image-properties |
(Facoltativo) Chiavi delle proprietà, specificate in formato prefix:property.Ad esempio, core:hadoop.tmp.dir.Per saperne di più, consulta Proprietà del cluster. |
--vpc-network-tags |
(Facoltativo) Un elenco di tag di rete da applicare al job. |
--vpc-network-name |
(Facoltativo) La rete Virtual Private Cloud in cui viene eseguito il job. Per
impostazione predefinita, Knowledge Catalog utilizza la rete VPC
denominata Default all'interno del progetto. Devi utilizzare solo una delle seguenti proprietà: --vpc-network-name o --vpc-sub-network-name.
|
--vpc-sub-network-name |
(Facoltativo) La subnet VPC in cui viene eseguito il job.
Devi utilizzare solo una delle proprietà --vpc-sub-network-name
o --vpc-network-name.
|
--trigger-type |
Tipo di attivatore dell'attività specificata dall'utente. I valori devono essere uno dei seguenti:ON_DEMAND: l'attività viene eseguita una volta poco dopo la creazione.RECURRING: l'attività viene eseguita periodicamente in base a una pianificazione.
|
--trigger-start-time |
(Facoltativo) L'ora della prima esecuzione dell'attività. Il formato
è `{year}-{month}-{day}T{hour}:{min}:{sec}Z`, dove il fuso orario è
UTC. Ad esempio, "2017-01-15T01:30:00Z" codifica le ore 01:30 UTC del
15 gennaio 2017. Se questo valore non è specificato, l'attività verrà eseguita
dopo l'invio se il tipo di trigger è ON_DEMAND oppure
in base alla pianificazione specificata se il tipo di trigger è
RECURRING.
|
--trigger-disabled |
(Facoltativo) Impedisce l'esecuzione dell'attività. Questo parametro non
annulla le attività già in esecuzione, ma disattiva temporaneamente le
attività RECURRING.
|
--trigger-max-retires |
(Facoltativo) Il numero di tentativi prima di interrompere l'operazione. Imposta il valore su zero per non tentare mai di ripetere un'attività non riuscita. |
--trigger-schedule |
Pianificazione cron per l'esecuzione periodica delle attività. |
--description |
(Facoltativo) Descrizione dell'attività. |
--display-name |
(Facoltativo) Nome visualizzato dell'attività. |
--labels |
(Facoltativo) Elenco di coppie di etichette KEY=VALUE da aggiungere. |
--execution-args |
(Facoltativo) Gli argomenti da passare all'attività. Gli argomenti possono essere un mix di
coppie chiave-valore. Puoi passare un elenco separato da virgole di coppie chiave-valore come
argomenti di esecuzione. Per passare argomenti posizionali, imposta la chiave su
TASK_ARGS e il valore su una stringa separata da virgole di
tutti gli argomenti posizionali. Per utilizzare un delimitatore diverso dalla virgola, consulta la sezione relativa all'escape.Se vengono passati insieme key-value e gli argomenti posizionali, TASK_ARGS verrà passato come ultimo argomento.
|
--execution-service-account |
Service account da utilizzare per eseguire un'attività. |
--max-job-execution-lifetime |
(Facoltativo) La durata massima prima della scadenza dell'esecuzione del job. |
--container-image |
(Facoltativo) Immagine container personalizzata per l'ambiente di runtime del job. Se non specificata, verrà utilizzata un'immagine container predefinita. |
--kms-key |
(Facoltativo) La chiave Cloud KMS da utilizzare per la crittografia, nel formato:projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}
|
Esempio Java:
glcoud dataplex tasks create --project=<project-name> --location=<location> --lake=<lake-id> --trigger-type=ON_DEMAND –spark-main-jar-file-uri=<gcs location to java file> --execution-service-account=<service-account-email> --trigger-start-time=<timestamp after which job starts ex. 2099-01-01T00:00:00Z> --labels=key1=value1,key2=value3,key3=value3 --execution-args=arg1=value1,arg2=value3,arg3=value3 <task-id>
Esempio PySpark:
gcloud dataplex tasks create --project=<project-name> --location=<location> --lake=<lake-id> --trigger-type=RECURRING --trigger-schedule=<Cron schedule https://en.wikipedia.org/wiki/Cron> --spark-python-script-file=<gcs location to python script> --execution-service-account=<service-account-email> --execution-args=^::^arg1=value1::arg2=value2::TASK_ARGS="pos-arg1, pos-arg2" <task-id>
REST
Per creare un'attività, utilizza Explorer API.
Pianifica un'attività Spark SQL
gcloud
Per pianificare un'attività Spark SQL, esegui lo stesso comando gcloud CLI di Pianificare un'attività Spark (Java o Python), con i seguenti parametri aggiuntivi:
| Parametro | Descrizione |
|---|---|
--spark-sql-script |
Il testo della query SQL. È obbligatorio specificare spark-sql-script o
spark-sql-script-file. |
--spark-sql-script-file |
Un riferimento a un file di query. Questo valore può essere l'URI Cloud Storage
del file di query o il percorso dei contenuti dello script SQL.
È obbligatorio specificare spark-sql-script o
spark-sql-script-file. |
--execution-args |
Per le attività Spark SQL, i seguenti argomenti sono obbligatori e devono essere
trasmessi come argomenti posizionali:--output_location, <GCS uri of the output directory>--output_format, <output file format>.I formati supportati sono file CSV, file JSON, Parquet e ORC. |
gcloud dataplex tasks create --project=<project-name> --location=<location> --lake=<lake-id> --execution-service-account=<service-account-email> --trigger-type=ON_DEMAND --spark-sql-script=<sql-script> --execution-args=^::^TASK_ARGS="--output_location, <gcs folder location>, --output_format, json" <sql-task-id>
REST
Per creare un'attività, utilizza Explorer API.
Monitorare l'attività
Console
Nella console Google Cloud , vai alla pagina Processo di Knowledge Catalog.
Nella scheda Attività, è presente un elenco di attività, filtrate per tipi di modelli di attività.
Nella colonna Nome, fai clic su qualsiasi attività che vuoi visualizzare.
Fai clic sull'ID job dell'attività che vuoi visualizzare.
Si apre la pagina Managed Service for Apache Spark nella consoleGoogle Cloud , che consente di visualizzare i dettagli di monitoraggio e output.
gcloud
La tabella seguente elenca i comandi gcloud CLI per monitorare le attività.
| Azione | Comando gcloud CLI |
|---|---|
| Elenco delle attività | gcloud dataplex tasks list --project=<project-name> --location=<location> --lake=<lake-id> |
| Visualizzare i dettagli dell'attività | gcloud dataplex tasks describe --project=<project-name> --location=<location> --lake=<lake-id> <task-id> |
| Elenco dei job di un'attività | gcloud dataplex tasks jobs list --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> |
| Visualizzazione dei dettagli del job | gcloud dataplex tasks jobs describe --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> <job-id> |
Knowledge Catalog esegue i job su Managed Service for Apache Spark (batch). Per visualizzare i log di esecuzione di un job Knowledge Catalog:
Recupera l'ID job Managed Service for Apache Spark Serverless (batch). Esegui questo comando:
gcloud dataplex tasks jobs describe --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> <job-id>Visualizza i log. Esegui questo comando utilizzando l'ID job ottenuto dall'esecuzione del comando precedente:
gcloud beta dataproc batches wait --project=<project-name> --region=<location> <job-id>
REST
Gestire la programmazione
Nella console Google Cloud , all'interno di Knowledge Catalog, puoi modificare la pianificazione di un'attività, eliminarla o annullare un job in corso. La tabella seguente elenca i comandi gcloud CLI per queste azioni.
| Azione | Comando gcloud CLI |
|---|---|
| Modificare la pianificazione delle attività | gcloud dataplex tasks update --project=<project-name> --location=<location> --lake=<lake-id> --trigger-schedule=<updated-schedule> <task-id> |
| Eliminare un'attività | gcloud dataplex tasks delete --project=<project-name> --location=<location> --lake=<lake-id> <task-id> |
| Annullare un job | gcloud dataplex tasks jobs cancel --project=<project-name> --location=<location> --lake=<lake-id> --task=<task-id> <job-id> |
Passaggi successivi
- Consulta Modelli Managed Service for Apache Spark.
- Prova un modello predefinito per spostare i dati in modo incrementale dagli asset Cloud Storage di Knowledge Catalog a BigQuery.
- Consulta Configurare avvisi e notifiche per le attività di Knowledge Catalog.