Cette page a été traduite par l'API Cloud Translation.

Configurer Dataproc Hub

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 auprès de plusieurs utilisateurs.

Objectifs

Définissez une configuration de cluster Dataproc (ou utilisez l'un des fichiers de configuration prédéfinis).
Définir les variables d'environnement de l'instance Dataproc Hub
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.

Configurer votre projet
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 un bucket.
3. Sur la page Créer un bucket, saisissez les informations concernant votre bucket. Pour passer à l'étape suivante, cliquez sur Continuer.
  - Pour nommer votre bucket, saisissez un nom qui répond aux exigences de dénomination des buckets.
  - Pour Choisir l'emplacement de stockage des données, procédez comme suit :
    - Sélectionnez une option de type d'emplacement.
    - Sélectionnez une option Location (Emplacement).
  - Pour Choisir une classe de stockage par défaut pour vos données, sélectionnez une classe de stockage.
  - Pour le champ Choisir comment contrôler l'accès aux objets, sélectionnez une option de Contrôle des accès.
  - Sous Paramètres avancés (facultatif), choisissez une méthode de chiffrement, une règle de conservation ou des libellés de bucket.
4. Cliquez sur Create (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 :

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

Créer 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 répertoriées ci-dessus correspond à la valeur par défaut du champ de la 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.

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 :

Créer un fichier de configuration de cluster YAML à partir de la console
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

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

Créez un cluster correspondant à vos besoins.

Exportez la configuration du cluster vers 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.

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

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".	l,c,j
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é.	`service-account`@`project-id`.iam.gserviceaccount.com
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", respectivement pour Jupyter et JupyterLab.
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 au bucket de notebooks ou au dossier de bucket à télécharger dans le cluster Dataproc généré au 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 :

Définir des variables d'environnement de hub à partir de la console
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 de la page 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

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é les 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
```
Enregistrez le fichier dans Cloud Storage. Copiez le fichier local de variables d'environnement de votre instance Dataproc Hub dans votre bucket Cloud Storage.
```
gsutil 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 qui lui sont 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	Compte utilisateur ou 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

Créer une instance Dataproc Hub

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.
Accédez à la page Dataproc → Workbench dans la console Google Cloud, puis sélectionnez l'onglet Notebooks gérés par l'utilisateur.
Si ce n'est pas le cas, cliquez dans la zone Filtre, puis sélectionnez **Environnement:Dataproc Hub".
Cliquez sur Nouveau notebook → Dataproc Hub.
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 ou un exécutable d'action d'initialisation à exécuter sur le cluster Dataproc généré.
  3. Populate Dataproc Hub (optional): cliquez sur Remplir pour ouvrir un formulaire vous permettant de définir chacune des variables d'environnement du hub (consultez la section Définir des variables d'environnement d'instance Dataproc Hub pour obtenir une description de chaque variable). Dataproc utilise les valeurs par défaut pour toutes les variables d'environnement non définies. Vous pouvez également définir des paires Metadata key:value pour définir les variables d'environnement (voir l'élément suivant).
  4. Metadata:
    1. Si vous avez créé un fichier texte contenant les paramètres de vos variables d'environnement hub (consultez la section Définir des variables d'environnement hub), indiquez le nom du fichier en tant que key et son emplacement Cloud Storage gs://bucket-name/folder-name/environment-variable-filename en tant que value. Dataproc utilise les 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 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.
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 la page du serveur JupyterHub afin de configurer et de créer un cluster Dataproc JupyterLab (consultez la section 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 que vous avez créé à la section Avant de commencer, y compris les fichiers de données stockés dans le bucket :
```
gsutil -m rm -r gs://${BUCKET_NAME}
```

Étapes suivantes

Utiliser Dataproc Hub