Configurazione di Dataproc Hub

---

Dataproc Hub e i notebook gestiti dall'utente di Vertex AI Workbench sono deprecati. Il 30 gennaio 2025 verrà interrotto il supporto per i blocchi note gestiti dall'utente e la possibilità di creare istanze di blocchi note gestiti dall'utente verrà rimossa. Per soluzioni di notebook alternative su Google Cloud, consulta:

• Installa il componente Jupyter sul tuo cluster Dataproc.
• Crea un'istanza di Vertex AI Workbench abilitata per Dataproc.

Dataproc Hub è un server JupyterHub personalizzato. Gli amministratori configurano e creano istanze di Dataproc Hub che possono generare cluster Dataproc per un solo utente per ospitare ambienti di notebook Jupyter e JupyterLab (consulta Utilizzare Dataproc Hub).

Lanciare Notebook per più utenti. Puoi creare un'istanza Vertex AI Workbench abilitata per Dataproc o installare il plug-in JupyterLab di Dataproc su una VM per fornire i notebook a più utenti.

Obiettivi

1. Definisci una configurazione del cluster Dataproc (o utilizza uno tra i file di configurazione predefiniti).

2. Imposta le variabili di ambiente dell'istanza Dataproc Hub.

3. Crea un'istanza Dataproc Hub.

Prima di iniziare

Se non l'hai ancora fatto, crea un progetto Google Cloud e un bucket Cloud Storage.

1. Configurazione del 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.

      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. Enable the Dataproc, Compute Engine, and Cloud Storage APIs.

      Enable the APIs

   5. Install the Google Cloud CLI.

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

      gcloud init

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

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

   9. Enable the Dataproc, Compute Engine, and Cloud Storage APIs.

      Enable the APIs

   10. Install the Google Cloud CLI.

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

       gcloud init

2. Crea un bucket Cloud Storage nel tuo progetto per contenere i dati utilizzati in questo tutorial.

   1. In the Google Cloud console, go to the Cloud Storage Buckets page.

      Go to Buckets page

   2. Click Create bucket.
   3. On the Create a bucket page, enter your bucket information. To go to the next step, click Continue.
      • For Name your bucket, enter a name that meets the bucket naming requirements.
      • For Choose where to store your data, do the following:
        • Select a Location type option.
        • Select a Location option.
      • For Choose a default storage class for your data, select a storage class.
      • For Choose how to control access to objects, select an Access control option.
      • For Advanced settings (optional), specify an encryption method, a retention policy, or bucket labels.
   4. Click Create.

Definisci una configurazione del cluster

Un'istanza Dataproc Hub crea un cluster dai valori di configurazione contenuti in un file di configurazione del cluster YAML.

Configurazioni di cluster predefinite: puoi utilizzare i seguenti file di configurazione predefiniti in Cloud Storage:

• example-cluster config: configura un cluster di componenti Jupyter standard con un nodo master e 2 nodi worker
• example-single-node config: configura un cluster di componenti Jupyter con un nodo

Per visualizzare questi file di configurazione pubblici di Cloud Storage, esegui:

gcloud storage cat gs://dataproc-spawner-dist/example-configs/example-cluster.yaml
gcloud storage cat gs://dataproc-spawner-dist/example-configs/example-single-node.yaml

Crea un hub di guida rapida. Per creare un hub utilizzando le configurazioni dei cluster predefinite, vai a Creare un'istanza Dataproc Hub. La posizione Cloud Storage delle configurazioni del cluster predefinite elencate sopra è il valore predefinito del campo della variabile di ambiente DATAPROC_CONFIGS.

La configurazione del cluster può specificare qualsiasi funzionalità o componente disponibile per i cluster Dataproc (ad esempio tipo di macchina, azioni di inizializzazione e componenti facoltativi). La versione dell'immagine del cluster deve essere almeno 1.4.13. Il tentativo di generare un cluster con una versione dell'immagine precedente alla 1.4.13 causerà un errore e non andrà a buon fine.

Nota: gli amministratori possono consentire agli utenti di eseguire l'override di alcuni dei parametri di configurazione del cluster predefiniti. Per ulteriori informazioni, consulta DATAPROC_ALLOW_CUSTOM_CLUSTERS in Impostare i valori dell'ambiente dell'istanza Dataproc Hub.

File di configurazione del cluster YAML di esempio

clusterName: cluster-name
config:
  softwareConfig:
    imageVersion: 2.2-ubuntu22
    optionalComponents:
    - JUPYTER

Ogni configurazione deve essere salvata in Cloud Storage. Puoi creare e salvare più file di configurazione per offrire agli utenti una scelta quando utilizzano Dataproc Hub per creare il proprio ambiente di notebook del cluster Dataproc.

Esistono due modi per creare un file di configurazione del cluster YAML:

1. Creare un file di configurazione del cluster YAML dalla console

2. Esportare un file di configurazione del cluster YAML da un cluster esistente

Creare un file di configurazione del cluster YAML dalla console

1. Apri la pagina Crea un cluster nella console Google Cloud, quindi seleziona e compila i campi per specificare il tipo di cluster che Dataproc Hub creerà per gli utenti.
   Le impostazioni della regione e della zona verranno sostituite quando viene generato il cluster dell'utente: la regione del cluster generato sarà la regione in cui si trova Dataproc Hub e l'utente selezionerà una zona all'interno di questa regione.
   1. Nella parte inferiore del riquadro di sinistra, seleziona "Equivalente REST".
   2. Copia il blocco JSON generato, esclusa la riga di richiesta POST iniziale, quindi incollalo in un convertitore da JSON a YAML online (cerca online "Converti JSON in YAML").
      Alcuni convertitori da JSON a YAML generano una prima riga contenente "---". L'inclusione di questa riga nel file YAML è facoltativa.
   3. Copia il file YAML convertito in un file cluster-config-filename.yaml locale.

Esportare un file di configurazione del cluster YAML da un cluster esistente

1. Crea un cluster adatto alle tue esigenze.
2. Esporta la configurazione del cluster in un file cluster-config-filename.yaml locale.

   gcloud dataproc clusters export cluster-name \
       --destination cluster-config-filename.yaml  \
       --region region
    

Salva il file di configurazione YAML in Cloud Storage

Copia il file di configurazione del cluster YAML locale nel tuo bucket Cloud Storage.

gcloud storage cp cluster-config-filename.yaml gs://bucket-name/

Impostare le variabili di ambiente dell'istanza Dataproc Hub

L'amministratore può impostare le variabili di ambiente dell'hub elencate nella tabella di seguito per impostare gli attributi dei cluster Dataproc che verranno generati dagli utenti dell'hub.

Nota: se le variabili di ambiente dell'hub non sono impostate, Dataproc utilizzerà i valori predefiniti, inclusa l'impostazione di DATAPROC_CONFIGS sulla posizione Cloud Storage delle configurazioni del cluster predefinite (consulta Definire una configurazione del cluster).

Variabile	Descrizione	Esempio
NOTEBOOKS_LOCATION	Bucket o cartella bucket Cloud Storage contenente i notebook dell'utente. Il prefisso "gs://" è facoltativo. Valore predefinito: il bucket di gestione temporanea di Dataproc.	gs://bucket-name/
DATAPROC_CONFIGS	Elenco delimitato da virgole contenente le stringhe dei percorsi Cloud Storage dei file di configurazione del cluster YAML. Il prefisso "gs://" è facoltativo. Valore predefinito: gs://dataproc-spawner-dist/example-configs/. che contiene example-cluster.yaml e example-single-node.yaml predefiniti.	gs://cluster-config-filename.yaml
DATAPROC_LOCATIONS_LIST	I suffissi di zona nella regione in cui si trova l'istanza Dataproc Hub. Gli utenti possono selezionare una di queste zone come zona in cui verrà generato il loro cluster Dataproc. Valore predefinito: "b".	b,c,d
DATAPROC_DEFAULT_SUBNET	Subnet su cui l'istanza Dataproc Hub genera i cluster Dataproc. Valore predefinito:la subnet dell'istanza Dataproc Hub.	https://www.googleapis.com/compute/v1/projects/project-id/regions/region/subnetworks/subnet-name
DATAPROC_SERVICE_ACCOUNT	Account di servizio con cui verranno eseguite le VM Dataproc. Valore predefinito: se non impostato, viene utilizzato il service account Dataproc predefinito.	[e-mail]
SPAWNER_DEFAULT_URL	Specifica se visualizzare la UI Jupyter o JupyterLab sui cluster Dataproc generati per impostazione predefinita. Valore predefinito: "/lab".	"/" o "/lab", rispettivamente per Jupyter o JupyterLab.
DATAPROC_ALLOW_CUSTOM_CLUSTERS	Specifica se consentire agli utenti di personalizzare i cluster Dataproc. Valore predefinito: false.	"true" o "false"
DATAPROC_MACHINE_TYPES_LIST	Elenco dei tipi di macchina tra cui gli utenti possono scegliere per i propri cluster Dataproc generati, se la personalizzazione dei cluster (DATAPROC_ALLOW_CUSTOM_CLUSTERS) è abilitata. Valore predefinito:vuoto (sono consentiti tutti i tipi di macchine).	n1-standard-4,n1-standard-8,e2-standard-4,n1-highcpu-4
NOTEBOOKS_EXAMPLES_LOCATION	Percorso Cloud Storage del bucket o della cartella bucket dei notebook da scaricare nel cluster Dataproc generato all'avvio del cluster. Valore predefinito:vuoto.	gs://bucket-name/

Impostazione delle variabili di ambiente dell'hub

Esistono due modi per impostare le variabili di ambiente dell'hub:

1. Impostare le variabili di ambiente dell'hub dalla console

2. Impostare le variabili di ambiente dell'hub in un file di testo

Impostare le variabili di ambiente dell'hub dalla console

Quando crei un'istanza di Dataproc Hub dalla scheda Notebook gestiti dall'utente nella pagina Dataproc→Workbench nella console Google Cloud, puoi fare clic sul pulsante Compila per aprire un modulo Compila Dataproc Hub che ti consente di impostare ogni variabile di ambiente.

Impostare le variabili di ambiente dell'hub in un file di testo

1. Crea il file. Puoi utilizzare un editor di testo per impostare le variabili di ambiente dell'istanza Dataproc Hub in un file locale. In alternativa, puoi creare il file eseguendo il seguente comando dopo aver inserito i valori segnaposto e aver modificato o aggiunto le variabili e i relativi valori.

   cat <<EOF > environment-variables-file
   DATAPROC_CONFIGS=gs://bucket/cluster-config-filename.yaml
   NOTEBOOKS_LOCATION=gs://bucket/notebooks
   DATAPROC_LOCATIONS_LIST=b,c
   EOF
   

2. Salva il file in Cloud Storage. Copia il file delle variabili di ambiente dell'istanza Dataproc Hub locale nel tuo bucket Cloud Storage.

   gcloud storage cp environment-variable-filename gs://bucket-name/folder-name/
   

Impostare i ruoli IAM (Identity and Access Management)

Dataproc Hub include le seguenti identità con le seguenti funzionalità:

• Amministratore: crea un'istanza Dataproc Hub
• Utente di dati e ML: accede all'interfaccia utente di Dataproc Hub
• Account di servizio Dataproc Hub: rappresenta Dataproc Hub
• Account di servizio Dataproc: rappresenta il cluster Dataproc creato da Dataproc Hub.

Ogni identità richiede ruoli o autorizzazioni specifici per svolgere le attività associate. La tabella seguente riassume i ruoli e le autorizzazioni IAM richiesti da ogni identità.

Identità	Tipo	Ruolo o autorizzazione
Amministratore di Dataproc Hub	Account utente o di servizio	roles/notebooks.admin
Utente Dataproc Hub	Utente	notebooks.instances.use, dataproc.clusters.use
Dataproc Hub	Service account	roles/dataproc.hubAgent
Dataproc	Service account	roles/dataproc.worker

Per impostazione predefinita, l'istanza Dataproc Hub e i nodi del cluster Dataproc vengono eseguiti come account di servizio Compute Engine predefinito del progetto.

Crea un'istanza Dataproc Hub

1. Prima di iniziare:per creare un'istanza di Dataproc Hub dalla console Google Cloud, il tuo account utente deve disporre dell'autorizzazione compute.instances.create. Inoltre, il service account dell'istanza, ovvero il service account predefinito di Compute Engine o il service account specificato dall'utente elencato in IAM e amministrazione > Account di servizio (vedi Service account VM Dataproc), deve disporre dell'autorizzazione iam.serviceAccounts.actAs.

2. Vai alla pagina Dataproc→Workbench nella console Google Cloud e seleziona la scheda Notebook gestiti dall'utente.

3. Se non è preselezionato come filtro, fai clic nella casella Filtro e seleziona **Ambiente:Dataproc Hub"".

4. Fai clic su Nuovo blocco note→Dataproc Hub.

5. Nella pagina Crea un notebook gestito dall'utente, fornisci le seguenti informazioni:

   1. Nome del notebook: nome dell'istanza Dataproc Hub.
   2. Regione: seleziona una regione per l'istanza Dataproc Hub. Anche i cluster Dataproc generati da questa istanza Dataproc Hub verranno creati in questa regione.
      Per ottenere le migliori prestazioni, seleziona una regione geograficamente vicina.
   3. Zona: seleziona una zona all'interno della regione selezionata.
   4. Ambiente:
      1. Environment: seleziona Dataproc Hub.
      2. Select a script to run after creation (facoltativo): puoi inserire o selezionare uno script o un eseguibile di azione di inizializzazione da eseguire sul cluster Dataproc generato.
      3. Populate Dataproc Hub (optional): fai clic su Completa per aprire un modulo che consente di impostare ciascuna delle variabili di ambiente dell'hub (consulta Impostare le variabili di ambiente dell'istanza Dataproc Hub per una descrizione di ciascuna variabile). Dataproc utilizza i valori predefiniti per le variabili di ambiente non impostate. In alternativa, puoi impostare coppie di metadati key:value per impostare le variabili di ambiente (vedi l'elemento successivo).
      4. Metadata:
         1. Se hai creato un file di testo che contiene le impostazioni variabile di ambiente dell'hub (vedi Impostare le variabili di ambiente dell'hub), fornisci il nome del file come key e la posizione del file in Cloud Storage come value.gs://bucket-name/folder-name/environment-variable-filename Dataproc utilizza i valori predefiniti per le eventuali variabili di ambiente non impostate.
   5. Configurazione macchina:
      1. Machine Type: seleziona il tipo di macchina Compute Engine.
      2. Impostare altre opzioni di configurazione della macchina.
   6. Altre opzioni:
      1. Puoi espandere e impostare o sostituire i valori predefiniti nelle sezioni Dischi, Networking, Autorizzazioni, Sicurezza e Upgrade dell'ambiente e integrità del sistema.
   7. Fai clic su Crea per avviare l'istanza Dataproc Hub.

6. Il link Apri JupyterLab per l'istanza Dataproc Hub diventa attivo dopo la creazione dell'istanza. Gli utenti fanno clic su questo link per aprire la pagina del server JupyterHub per configurare e creare un cluster JupyterLab Dataproc (vedi Utilizzare Dataproc Hub).

Esegui la pulizia

Elimina l'istanza Dataproc Hub

• Per eliminare l'istanza Dataproc Hub:

  gcloud compute instances delete --project=${PROJECT} ${INSTANCE_NAME}
  

Elimina il bucket

• Per eliminare il bucket Cloud Storage che hai creato in Prima di iniziare, inclusi i file di dati memorizzati nel bucket:

  gcloud storage rm gs://${BUCKET_NAME} --recursive
  

Passaggi successivi

• Utilizzare Dataproc Hub