Configurer Dataproc Hub

Dataproc Hub et les notebooks Vertex AI Workbench gérés par l'utilisateur sont obsolètes. À 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 ressources suivantes :

• Installez le composant Jupyter sur votre cluster Dataproc.
• Créez une instance Vertex AI Workbench compatible avec Dataproc.

Dataproc Hub est un serveur JupyterHub personnalisé. Les administrateurs configurent et créent des instances Dataproc Hub pouvant générer des clusters Dataproc à utilisateur unique pour héberger des environnements de notebooks Jupyter et JupyterLab (voir Utiliser Dataproc Hub).

Lancez Notebooks pour plusieurs utilisateurs. Vous pouvez créer une instance Vertex AI Workbench compatible avec Dataproc ou installer le plug-in Dataproc JupyterLab sur une VM pour diffuser des notebooks à 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. Configurer le projet

   Connectez-vous à votre compte Google Cloud . Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $de crédits sans frais pour exécuter, tester et déployer des charges de travail.

   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.

   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

   Verify that billing is enabled for your Google Cloud project.

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

   Roles required to enable APIs

   To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

   Enable the APIs

   Installez la Google Cloud CLI.

   Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

   Pour initialiser la gcloud CLI, exécutez la commande suivante :

   gcloud init

   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.

   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

   Verify that billing is enabled for your Google Cloud project.

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

   Roles required to enable APIs

   To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

   Enable the APIs

   Installez la Google Cloud CLI.

   Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

   Pour initialiser la gcloud CLI, exécutez la commande suivante :

   gcloud init

2. Créez un bucket Cloud Storage dans votre projet pour stocker les données utilisées dans ce tutoriel.

   1. Dans la console Google Cloud , accédez à la page Buckets Cloud Storage.

      Accéder à la page "Buckets"

   2. Cliquez sur  Créer.
   3. Sur la page Créer un bucket, saisissez les informations concernant votre bucket. Pour passer à l'étape suivante, cliquez sur Continuer.
      1. Dans la section Premiers pas, procédez comme suit :
         • Saisissez un nom unique qui répond aux exigences relatives aux noms des buckets.
         • Pour ajouter une étiquette de bucket, développez la section Étiquettes (), cliquez sur Ajouter une étiquette, puis spécifiez un élément key et value pour votre étiquette.
      2. Dans la section Choisir l'emplacement de stockage de vos données, procédez comme suit :
         1. Sélectionnez un type d'emplacement.
         2. Choisissez un emplacement où les données de votre bucket seront stockées de manière permanente dans le menu déroulant Type d'emplacement.
            • Si vous sélectionnez le type d'emplacement birégional, vous pouvez également choisir d'activer la réplication turbo à l'aide de la case à cocher correspondante.
         3. Pour configurer la réplication entre buckets, sélectionnez Ajouter une réplication entre buckets via le service de transfert de stockage et suivez ces étapes :

            Configurer la réplication entre buckets

            1. Dans le menu Bucket, sélectionnez un bucket.

            2. Dans la section Paramètres de réplication, cliquez sur Configurer pour configurer les paramètres du job de réplication.

               Le volet Configurer la réplication entre buckets s'affiche.

               • Pour filtrer les objets à répliquer en fonction du préfixe de leur nom, saisissez le préfixe avec lequel vous souhaitez inclure ou exclure des objets, puis cliquez sur Ajouter un préfixe.
               • Pour définir une classe de stockage pour les objets répliqués, sélectionnez-en une dans le menu Classe de stockage. Si vous ignorez cette étape, les objets répliqués utiliseront la classe de stockage par défaut du bucket de destination.
               • Cliquez sur OK.
      3. Dans la section Choisir comment stocker vos données, procédez comme suit :
         1. Sélectionnez une classe de stockage par défaut pour le bucket ou classe automatique pour gérer automatiquement les classes de stockage des données de votre bucket.
         2. Pour activer l'espace de noms hiérarchique, dans la section Optimiser l'espace de stockage pour les charges de travail utilisant beaucoup de données, sélectionnez Activer l'espace de noms hiérarchique sur ce bucket.
            Remarque : Vous ne pouvez pas activer l'espace de noms hiérarchique dans des buckets existants.
      4. Dans la section Choisir comment contrôler l'accès aux objets, indiquez si votre bucket applique ou non la protection contre l'accès public et sélectionnez une méthode de contrôle des accès pour les objets de votre bucket.
         Remarque : Vous ne pouvez pas modifier le paramètre Empêcher l'accès public s'il est appliqué au niveau d'une règle d'administration.
      5. Dans la section Choisir comment protéger les données d'objet, procédez comme suit :
         • Sous Protection des données, sélectionnez les options que vous souhaitez définir pour votre bucket.
           • Pour activer la suppression réversible, cochez la case Règle de suppression réversible (pour la récupération de données), puis spécifiez le nombre de jours pendant lesquels vous souhaitez conserver les objets après leur suppression.
           • Pour configurer la gestion des versions d'objets, cochez la case Gestion des versions des objets (pour le contrôle des versions), puis spécifiez le nombre maximal de versions par objet et le nombre de jours après lesquels les versions obsolètes expirent.
           • Pour activer la règle de conservation sur les objets et les buckets, cochez la case Conservation (pour la conformité), puis procédez comme suit :
             • Pour activer le verrou de conservation des objets, cochez la case Activer la conservation des objets.
             • Pour activer le verrou de bucket, cochez la case Définir une règle de conservation du bucket, puis choisissez une unité de temps et une durée pour votre période de conservation.
         • Pour choisir comment vos données d'objet seront chiffrées, développez la section Chiffrement des données (), puis sélectionnez une méthode de chiffrement des données.
   4. Cliquez sur Créer.

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 des configurations de cluster prédéfinies, passez à la section Créer une instance Dataproc Hub. L'emplacement Cloud Storage des configurations de cluster prédéfinies listées ci-dessus correspond à la valeur par défaut du champ de variable d'environnement 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 certains paramètres de configuration de cluster prédéfinis. Pour en savoir plus, consultez DATAPROC_ALLOW_CUSTOM_CLUSTERS dans Définir les valeurs d'environnement de l'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 va générer 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 du hub

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

1. Définir des variables d'environnement hub depuis la console

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

Définir des variables d'environnement hub depuis la console

Lorsque vous créez une instance Dataproc Hub à partir de l'onglet Notebooks gérés par l'utilisateur de la page Dataproc→Workbench dans la console Google Cloud , vous pouvez cliquer sur le bouton Renseigner pour ouvrir le formulaire Renseigner 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. Copiez le fichier de variables d'environnement de l'instance Dataproc Hub locale 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é nécessite des rôles ou des autorisations spécifiques pour effectuer les tâches associées. Le tableau ci-dessous récapitule les rôles et autorisations IAM requis par chaque 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 : Pour créer une instance Dataproc Hub à partir de la console Google Cloud , votre compte utilisateur doit disposer de l'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 à la page Dataproc → Workbench dans la console Google Cloud , puis sélectionnez l'onglet Notebooks gérés par l'utilisateur.

3. Si elle n'est pas présélectionnée 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. Les clusters Dataproc générés par cette instance Dataproc Hub seront également 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 parcourir et sélectionner un script d'action d'initialisation ou un exécutable à exécuter sur le cluster Dataproc généré.
      3. Populate Dataproc Hub (optional) : cliquez sur Populate pour ouvrir un formulaire qui vous permet de définir chacune des variables d'environnement du hub (pour obtenir une description de chaque variable, consultez Définir les variables d'environnement de l'instance Dataproc Hub). Dataproc utilise des valeurs par défaut pour toutes les variables d'environnement non définies. Vous pouvez également définir des paires Métadonnées key:value pour définir des variables d'environnement (voir l'élément 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 comme key et l'emplacement Cloud Storage du fichier comme value.gs://bucket-name/folder-name/environment-variable-filename 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 et définir ou remplacer les valeurs par défaut dans les sections Disques, Mise en réseau, Autorisation, 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 une fois l'instance créée. Les utilisateurs cliquent sur ce lien pour ouvrir la page du serveur JupyterHub afin de configurer et de créer un cluster Dataproc JupyterLab (voir 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