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
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.
Configurez votre projet
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Dataproc, Compute Engine, and Cloud Storage APIs.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Dataproc, Compute Engine, and Cloud Storage APIs.
-
Install the Google Cloud CLI.
-
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
-
To initialize the gcloud CLI, run the following command:
gcloud init
Créer un bucket Cloud Storage dans votre projet pour stocker les données utilisées dans ce tutoriel
- In the Google Cloud console, go to the Cloud Storage Buckets page.
- Click Create.
- On the Create a bucket page, enter your bucket information. To go to the next
step, click Continue.
-
In the Get started section, do the following:
- Enter a globally unique name that meets the bucket naming requirements.
- To add a
bucket label,
expand the Labels section ( ),
click add_box
Add label, and specify a
key
and avalue
for your label.
-
In the Choose where to store your data section, do the following:
- Select a Location type.
- Choose a location where your bucket's data is permanently stored from the Location type drop-down menu.
- If you select the dual-region location type, you can also choose to enable turbo replication by using the relevant checkbox.
- To set up cross-bucket replication, select
Add cross-bucket replication via Storage Transfer Service and
follow these steps:
Set up cross-bucket replication
- In the Bucket menu, select a bucket.
In the Replication settings section, click Configure to configure settings for the replication job.
The Configure cross-bucket replication pane appears.
- To filter objects to replicate by object name prefix, enter a prefix that you want to include or exclude objects from, then click Add a prefix.
- To set a storage class for the replicated objects, select a storage class from the Storage class menu. If you skip this step, the replicated objects will use the destination bucket's storage class by default.
- Click Done.
-
In the Choose how to store your data section, do the following:
- Select a default storage class for the bucket or Autoclass for automatic storage class management of your bucket's data.
- To enable hierarchical namespace, in the Optimize storage for data-intensive workloads section, select Enable hierarchical namespace on this bucket.
- In the Choose how to control access to objects section, select whether or not your bucket enforces public access prevention, and select an access control method for your bucket's objects.
-
In the Choose how to protect object data section, do the
following:
- Select any of the options under Data protection that you
want to set for your bucket.
- To enable soft delete, click the Soft delete policy (For data recovery) checkbox, and specify the number of days you want to retain objects after deletion.
- To set Object Versioning, click the Object versioning (For version control) checkbox, and specify the maximum number of versions per object and the number of days after which the noncurrent versions expire.
- To enable the retention policy on objects and buckets, click the Retention (For compliance) checkbox, and then do the following:
- To enable Object Retention Lock, click the Enable object retention checkbox.
- To enable Bucket Lock, click the Set bucket retention policy checkbox, and choose a unit of time and a length of time for your retention period.
- To choose how your object data will be encrypted, expand the Data encryption section (Data encryption method. ), and select a
- Select any of the options under Data protection that you
want to set for your bucket.
-
In the Get started section, do the following:
- 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.
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.
- Au bas du panneau de gauche, sélectionnez "Équivalent REST".
- 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").
- 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 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.
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é. | 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", 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 :
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 (Dataproc→Workbench) de 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
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
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 | 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'autorisationiam.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 elle n'est pas présélectionnée en tant que filtre, 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 :
- Nom du notebook : nom de l'instance Dataproc Hub.
- 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.
- Zone : sélectionnez une zone dans la région sélectionnée.
- Environnement :
Environment
: sélectionnezDataproc Hub
.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é.Populate Dataproc Hub (optional)
: cliquez sur Renseigner 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éeskey:value
pour définir des variables d'environnement (voir l'élément suivant).Metadata
:- 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 commevalue
.gs://bucket-name/folder-name/environment-variable-filename
Dataproc utilise des valeurs par défaut pour toutes les variables d'environnement non définies.
- 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
- Configuration de la machine :
Machine Type
: sélectionnez le type de machine Compute Engine.- Définissez d'autres options de configuration pour la machine.
- Autres options :
- 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.
- Cliquez sur Créer pour lancer l'instance Dataproc Hub.
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