Configurer Dataproc Hub

---

Dataproc Hub et Les notebooks Vertex AI Workbench gérés par l'utilisateur obsolète. À compter du 30 janvier 2025, les notebooks gérés par l'utilisateur ne seront plus pris en charge et il ne sera plus possible de créer des instances de notebooks gérés par l'utilisateur. Pour découvrir d'autres solutions de notebooks sur Google Cloud, consultez les pages suivantes:

• Installer le composant Jupyter sur votre cluster Dataproc.
• Créer compatible avec Dataproc Instance Vertex AI Workbench.

Dataproc Hub est un serveur JupyterHub personnalisé. Les administrateurs configurent et créent des instances Dataproc Hub pouvant générer un seul utilisateur. Des clusters Dataproc pour héberger des environnements de notebook Jupyter et JupyterLab (consultez la page Utiliser Dataproc Hub).

Lancer Notebooks pour plusieurs utilisateurs Vous pouvez créer Dataproc compatible Instance Vertex AI Workbench ou installer le plug-in Dataproc JupyterLab sur une VM pour diffuser des notebooks auprès de plusieurs utilisateurs.

Objectifs

1. Définissez une configuration de cluster Dataproc (ou utilisez l'un des fichiers de configuration prédéfinis).

2. Définir les variables d'environnement de l'instance Dataproc Hub

3. Créer une instance Dataproc Hub.

Avant de commencer

Si vous ne l'avez pas déjà fait, créez un projet Google Cloud et un bucket Cloud Storage.

1. Configurez votre projet

   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. Créer un bucket Cloud Storage dans votre projet pour stocker les données utilisées dans ce tutoriel

   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.

Définir une configuration de cluster

Une instance Dataproc Hub crée un cluster à partir des valeurs de configuration contenues dans un fichier de configuration de cluster YAML.

Configurations de cluster prédéfinies : vous pouvez utiliser les fichiers de configuration prédéfinis suivants, situés dans Cloud Storage :

• Configuration example-cluster : configure un cluster de composants Jupyter standard avec un nœud maître et deux nœuds de calcul.
• Configuration example-single-node : configure un cluster de composants Jupyter avec un nœud.

Pour afficher ces fichiers de configuration Cloud Storage publics, exécutez la commande suivante :

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

Créez un hub de démarrage rapide. Pour créer un hub à l'aide du des configurations de cluster prédéfinies, passez à Créer un hub Dataproc Hub Compute Engine. L'emplacement Cloud Storage du de configuration de cluster prédéfinies répertoriées ci-dessus est la valeur par défaut DATAPROC_CONFIGS.

Votre configuration du cluster peut spécifier n'importe quelle fonctionnalité ou composant disponible pour les clusters Dataproc (tels que le type de machine, les actions d'initialisation et les composants facultatifs). La version en images du cluster doit être 1.4.13 ou ultérieure. Toute tentative de génération d'un cluster avec une version en images inférieure à 1.4.13 entraînera une erreur et un échec.

Remarque :Les administrateurs peuvent autoriser les utilisateurs à remplacer certaines des configurations prédéfinies du cluster. paramètres. Pour en savoir plus, consultez DATAPROC_ALLOW_CUSTOM_CLUSTERS dans Définissez les valeurs d'environnement d'instance Dataproc Hub.

Exemple de fichier de configuration de cluster YAML

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

Chaque configuration doit être enregistrée dans Cloud Storage. Vous pouvez créer et enregistrer plusieurs fichiers de configuration pour donner le choix aux utilisateurs lorsqu'ils utilisent Dataproc Hub pour créer leur environnement de notebook de cluster Dataproc.

Il existe deux façons de créer un fichier de configuration de cluster YAML :

1. Créer un fichier de configuration de cluster YAML à partir de la console

2. Exporter un fichier de configuration de cluster YAML à partir d'un cluster existant

Créer un fichier de configuration de cluster YAML à partir de la console

1. Ouvrez la page Créer un cluster. dans la console Google Cloud, puis sélectionnez et remplissez les champs pour spécifier le type de cluster que Dataproc Hub générera pour les utilisateurs.
   Les paramètres de région et de zone sont remplacés lorsque le cluster de l'utilisateur est généré : la région du cluster généré correspond à la région où se trouve le serveur Dataproc Hub. L'utilisateur sélectionne une zone dans cette région.
   1. Au bas du panneau de gauche, sélectionnez "Équivalent REST".
   2. Copiez le bloc JSON généré, en excluant la ligne de requête POST principale, puis collez le bloc JSON dans un convertisseur JSON-YAML en ligne (effectuez une recherche en ligne pour "Convert JSON to YAML").
      Certains convertisseurs de code JSON en code YAML génèrent une première ligne contenant "---". L'inclusion de cette ligne dans le fichier YAML est facultative.
   3. Copiez le fichier YAML converti dans un fichier cluster-config-filename.yaml local.

Exporter un fichier de configuration de cluster YAML à partir d'un cluster existant

1. Créez un cluster correspondant à vos besoins.
2. Exportez la configuration du cluster dans un fichier cluster-config-filename.yaml local.

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

Enregistrez le fichier de configuration YAML dans Cloud Storage.

Copiez votre fichier de configuration de cluster YAML local dans votre bucket Cloud Storage.

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

Définir les variables d'environnement de l'instance Dataproc Hub

L'administrateur peut définir les variables d'environnement hub répertoriées dans le tableau ci-dessous pour définir les attributs des clusters Dataproc qui seront générés par les utilisateurs du hub.

Remarque : Si les variables d'environnement hub ne sont pas définies, Dataproc utilise des valeurs par défaut. Il définit par exemple DATAPROC_CONFIGS sur l'emplacement Cloud Storage des configurations de cluster prédéfinies (voir Définir la configuration d'un cluster).

Variable	Description	Exemple
NOTEBOOKS_LOCATION	Bucket ou dossier de bucket Cloud Storage où sont conservés les notebooks utilisateur. Le préfixe "gs://" est facultatif. Valeur par défaut : le bucket de préproduction Dataproc.	gs://bucket-name/
DATAPROC_CONFIGS	Liste des chaînes des chemins d'accès Cloud Storage vers les fichiers de configuration de cluster YAML séparées par une virgule. Le préfixe "gs://" est facultatif. Valeur par défaut : gs://dataproc-spawner-dist/example-configs/. Contient les paramètres example-cluster.yaml et example-single-node.yaml prédéfinis.	gs://cluster-config-filename.yaml
DATAPROC_LOCATIONS_LIST	Suffixes de zone dans la région où se trouve l'instance Dataproc Hub. Les utilisateurs peuvent sélectionner l'une de ces zones comme zone dans laquelle leur cluster Dataproc sera généré. Valeur par défaut : "b".	b,c,d
DATAPROC_DEFAULT_SUBNET	Sous-réseau sur lequel l'instance Dataproc Hub doit générer des clusters Dataproc. Valeur par défaut : le sous-réseau de l'instance Dataproc Hub.	https://www.googleapis.com/compute/v1/projects/project-id/regions/region/subnetworks/subnet-name
DATAPROC_SERVICE_ACCOUNT	Compte de service dans lequel les VM Dataproc seront exécutées. Valeur par défaut : si cette valeur n'est pas définie, le compte de service Dataproc par défaut est utilisé.	[e-mail]
SPAWNER_DEFAULT_URL	Indique si l'interface utilisateur Jupyter ou JupyterLab doit être affichée par défaut sur les clusters Dataproc générés. Valeur par défaut : "/lab".	"/" ou "/lab", pour Jupyter ou JupyterLab, respectivement.
DATAPROC_ALLOW_CUSTOM_CLUSTERS	Permet d'autoriser ou non les utilisateurs à personnaliser leurs clusters Dataproc. Valeur par défaut : false.	"true" ou "false"
DATAPROC_MACHINE_TYPES_LIST	Liste des types de machines que les utilisateurs sont autorisés à choisir pour leurs clusters Dataproc générés, si la personnalisation de cluster (DATAPROC_ALLOW_CUSTOM_CLUSTERS) est activée. Valeur par défaut : vide (tous les types de machines sont autorisés).	n1-standard-4,n1-standard-8,e2-standard-4,n1-highcpu-4
NOTEBOOKS_EXAMPLES_LOCATION	Chemin d'accès Cloud Storage vers le bucket de notebooks ou le dossier de bucket à télécharger dans le cluster Dataproc généré lors du démarrage du cluster. Valeur par défaut : vide.	gs://bucket-name/

Définir des variables d'environnement de hub

Il existe deux façons de définir des variables d'environnement hub :

1. Définir des variables d'environnement de hub à partir de la console

2. Définir des variables d'environnement hub dans un fichier texte

Définir les variables d'environnement du hub à partir de la console

Lorsque vous créez une instance Dataproc Hub, dans l'onglet Notebooks gérés par l'utilisateur Dataproc→Workbench de la console Google Cloud, vous pouvez cliquer sur le bouton Remplir pour ouvrir un formulaire Remplir Dataproc Hub qui vous permet de définir chaque variable d'environnement.

Définir des variables d'environnement hub dans un fichier texte

1. Créez le fichier. Vous pouvez utiliser un éditeur de texte pour définir des variables d'environnement d'instance Dataproc Hub dans un fichier local. Vous pouvez également créer le fichier en exécutant la commande suivante après avoir renseigné des valeurs d'espace réservé et modifié ou ajouté des variables et leurs valeurs.

   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. Enregistrez le fichier dans Cloud Storage. Copier vos données locales Variables d'environnement de l'instance Dataproc Hub dans votre bucket Cloud Storage.

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

Définir des rôles IAM (Identity and Access Management)

Dataproc Hub inclut les identités suivantes avec les fonctionnalités suivantes :

• Administrateur : crée une instance Dataproc Hub
• Utilisateur de données et du ML : accède à l'interface utilisateur de Dataproc Hub
• Compte de service Dataproc Hub : représente Dataproc Hub
• Compte de service Dataproc : représente le cluster Dataproc créé par Dataproc Hub.

Chaque identité a besoin de rôles ou d'autorisations spécifiques pour exécuter les tâches tâches. Le tableau ci-dessous récapitule les rôles et autorisations IAM requis par chaque l'identité.

Identité	Type	Rôle ou autorisation
Administrateur Dataproc Hub	Utilisateur ou compte de service	roles/notebooks.admin
Utilisateur Dataproc Hub	Utilisateur	notebooks.instances.use, dataproc.clusters.use
Dataproc Hub	Compte de service	roles/dataproc.hubAgent
Dataproc	Compte de service	roles/dataproc.worker

Par défaut, l'instance Dataproc Hub et les nœuds de cluster Dataproc s'exécutent en tant que compte de service Compute Engine par défaut du projet.

Créer une instance Dataproc Hub

1. Avant de commencer:Créer une instance Dataproc Hub depuis la console Google Cloud, votre compte utilisateur doit Autorisation compute.instances.create. En outre, le compte de service de l'instance, c'est-à-dire le compte de service Compute Engine par défaut ou le compte de service spécifié par l'utilisateur répertorié dans IAM et administration > Comptes de service (voir Compte de service de VM Dataproc), doit disposer de l'autorisation iam.serviceAccounts.actAs.

2. Accédez au Dataproc→Workbench de la console Google Cloud, puis sélectionnez Notebooks gérés par l'utilisateur .

3. S'il n'est pas présélectionné en tant que filtre, cliquez dans la zone Filtre, puis sélectionnez **Environnement:Dataproc Hub"".

4. Cliquez sur Nouveau notebook → Dataproc Hub.

5. Sur la page Créer un notebook géré par l'utilisateur, fournissez les informations suivantes:

   1. Nom du notebook: nom de l'instance Dataproc Hub.
   2. Région : sélectionnez une région pour l'instance Dataproc Hub. Dataproc les clusters générés par cette instance Dataproc Hub seront aussi créés dans cette région.
      Pour des performances optimales, sélectionnez une région géographiquement proche.
   3. Zone : sélectionnez une zone dans la région sélectionnée.
   4. Environnement :
      1. Environment: sélectionnez Dataproc Hub.
      2. Select a script to run after creation (facultatif): vous pouvez insérer ou parcourez et sélectionnez un action d'initialisation ou exécutable à exécuter sur le cluster Dataproc généré.
      3. Populate Dataproc Hub (optional): cliquez sur Remplir pour ouvrir un formulaire qui vous permet de définir chacune des variables d'environnement du hub (voir Définir des variables d'environnement d'instance Dataproc Hub pour obtenir une description de chaque variable). Dataproc utilise des valeurs par défaut pour toutes les variables d'environnement non définies. À la place, vous pouvez définir des paires de métadonnées key:value pour définir des variables d'environnement (voir le point suivant).
      4. Metadata :
         1. Si vous avez créé un fichier texte contenant les paramètres de la variable d'environnement hub (consultez la section Définir des variables d'environnement hub), indiquez le nom du fichier en tant que key et l'emplacement Cloud Storage gs://bucket-name/folder-name/environment-variable-filename du fichier en tant que value. Dataproc utilise des valeurs par défaut pour toutes les variables d'environnement non définies.
   5. Configuration de la machine :
      1. Machine Type: sélectionnez le type de machine Compute Engine.
      2. Définissez d'autres options de configuration pour la machine.
   6. Autres options:
      1. Vous pouvez développer, définir ou remplacer les valeurs par défaut dans Disques, Mise en réseau, autorisations, sécurité, et mise à niveau de l'environnement et état du système .
   7. Cliquez sur Créer pour lancer l'instance Dataproc Hub.

6. Le lien Ouvrir JupyterLab pour l'instance Dataproc Hub devient actif après la création de l'instance. Les utilisateurs cliquent sur ce lien pour ouvrir Page du serveur JupyterHub pour configurer et créer un JupyterLab Dataproc (consultez Utiliser Dataproc Hub).

Effectuer un nettoyage

Supprimer l'instance Dataproc Hub

• Pour supprimer votre instance Dataproc Hub :

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

Supprimer le bucket

• Pour supprimer le bucket Cloud Storage créé à la section Avant de commencer, y compris les fichiers de données stockés dans le bucket :

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

Étape suivante

• Utiliser Dataproc Hub