Créer une instance Vertex AI Workbench

Cette page explique comment créer une instance Vertex AI Workbench à l'aide de la console Google Cloud ou de la Google Cloud CLI. Lors de la création de l'instance, vous pouvez configurer le matériel, le type de chiffrement et le réseau de l'instance, ainsi que d'autres détails.

Avant de commencer

Avant de créer une instance Vertex AI Workbench, vous devez effectuer les étapes suivantes :

  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.

    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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Notebooks API.

    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 API

  5. 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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Notebooks API.

    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 API

  8. Créer une instance

    Vous pouvez créer une instance Vertex AI Workbench à l'aide de la console Google Cloud , de la gcloud CLI ou de Terraform :

    Console

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

      Accéder à la page "Instances"

    2. Cliquez sur Créer.

    3. Dans la boîte de dialogue Nouvelle instance, cliquez sur Options avancées.

    4. Dans la boîte de dialogue Créer une instance, dans la section Détails, fournissez les informations suivantes pour la nouvelle instance :

      • Nom : donnez un nom à la nouvelle instance. Il doit commencer par une lettre, suivie de 1 à 62 caractères (lettres minuscules, chiffres ou traits d'union). Il ne peut pas se terminer par un trait d'union.
      • Région et Zone : sélectionnez une région et une zone pour la nouvelle instance. Pour obtenir les meilleures performances réseau, sélectionnez la région la plus proche de vous géographiquement. Consultez les emplacements Vertex AI Workbench disponibles.
      • Étiquettes : facultatif. Fournissez des étiquettes clé-valeur personnalisées pour l'instance.
      • Tags réseau : facultatif. Fournissez des tags réseau pour l'instance.
    5. Dans la section Environnement, indiquez les éléments suivants :

      • Version de JupyterLab : pour activer JupyterLab 4 (preview), sélectionnez JupyterLab 4.x. Si cette option n'est pas sélectionnée, votre instance utilisera JupyterLab 3. Pour en savoir plus, consultez Preview de JupyterLab 4.
      • Version : utilisez la dernière version ou une version précédente des instances Vertex AI Workbench.
      • Script post-démarrage : facultatif. Cliquez sur Parcourir pour sélectionner un script à exécuter une fois, à l'issue de la création de l'instance. Le chemin d'accès doit être une URL ou un chemin d'accès Cloud Storage (par exemple, gs://PATH_TO_FILE/FILE_NAME).
      • Métadonnées : facultatif. Fournissez des clés de métadonnées personnalisées pour l'instance.
    6. Dans la section Type de machine, fournissez les informations suivantes :

      • Type de machine : sélectionnez le nombre de processeurs et la quantité de RAM de la nouvelle instance. Vertex AI Workbench fournit des estimations des coûts mensuels pour chaque type de machine que vous sélectionnez.
      • GPU : facultatif. Si vous souhaitez utiliser des GPU, sélectionnez le type GPU et le nombre de GPU pour votre nouvelle instance. Le type d'accélérateur souhaité doit être disponible dans la zone de votre instance. Pour en savoir plus sur la disponibilité des accélérateurs par zone, consultez Disponibilité des GPU dans les régions et zones. Pour en savoir plus sur les différents GPU, consultez GPU sur Compute Engine.

        Sélectionnez Installer automatiquement le pilote de GPU NVIDIA.

      • VM protégée (facultatif) : cochez ou décochez les cases suivantes :

        • Démarrage sécurisé
        • Module vTPM (Virtual Trusted Platform Module)
        • Surveillance de l'intégrité
      • Arrêt en cas d'inactivité (facultatif)

        • Pour modifier le nombre de minutes avant l'arrêt, dans le champ Temps d'inactivité avant l'arrêt (en minutes), remplacez la valeur par un entier compris entre 10 et 1440.

        • Pour désactiver l'arrêt en cas d'inactivité, désélectionnez Activer l'arrêt en cas d'inactivité.

    7. Dans la section Disques, fournissez les informations suivantes :

      • Disques : facultatif. Pour modifier les paramètres de disque de données par défaut, sélectionnez un type de disque de données et une taille de disque de données en Go. Pour en savoir plus sur les types de disques, consultez Options de stockage.

      • Déplacer vers la corbeille : facultatif. Cochez cette case pour utiliser le comportement par défaut de la corbeille du système d'exploitation. Si vous utilisez le comportement par défaut de la corbeille, les fichiers supprimés à l'aide de l'interface utilisateur JupyterLab sont récupérables, mais ces fichiers supprimés utilisent de l'espace disque.

      • Chiffrement : sélectionnez Google-managed encryption key ou Clé de chiffrement gérée par le client (CMEK). Pour utiliser la CMEK, consultez Clés de chiffrement gérées par le client.

    8. Dans la section Mise en réseau, fournissez les informations suivantes :

    9. Dans la section IAM et sécurité, indiquez les éléments suivants :

      • IAM et sécurité : pour accorder l'accès à l'interface JupyterLab de l'instance, effectuez l'une des opérations suivantes :

        • Pour accorder l'accès à JupyterLab au moyen d'un compte de service, sélectionnez Compte de service.

          • Pour utiliser le compte de service Compute Engine par défaut, sélectionnez Utiliser le compte de service Compute Engine par défaut.

          • Pour utiliser un compte de service personnalisé, décochez la case Utiliser le compte de service Compute Engine par défaut. Ensuite, dans le champ Adresse e-mail du compte de service, saisissez l'adresse e-mail du compte de service personnalisé.

        • Pour autoriser un seul utilisateur à accéder à l'interface JupyterLab, procédez comme suit :

          1. Sélectionnez Un seul utilisateur, puis, dans le champ Adresse e-mail de l'utilisateur, indiquez le compte utilisateur auquel vous souhaitez accorder l'accès. Si l'utilisateur spécifié n'est pas le créateur de l'instance, vous devez lui attribuer le rôle Utilisateur du compte de service (roles/iam.serviceAccountUser) sur le compte de service de l'instance.

          2. Votre instance utilise un compte de service pour interagir avec les services et les APIGoogle Cloud .

            • Pour utiliser le compte de service Compute Engine par défaut, sélectionnez Utiliser le compte de service Compute Engine par défaut.

            • Pour utiliser un compte de service personnalisé, décochez la case Utiliser le compte de service Compute Engine par défaut, puis, dans le champ Adresse e-mail du compte de service, saisissez l'adresse e-mail du compte de service personnalisé.

        Pour en savoir plus sur l'attribution d'autorisations d'accès, consultez Gérer les accès.

      • Options de sécurité : cochez ou décochez les cases suivantes :

        • Accès root à l'instance
        • nbconvert
        • Téléchargement de fichiers
        • Accès au terminal
    10. Dans la section État du système, indiquez les éléments suivants :

      • Mise à niveau de l'environnement et état du système : pour passer automatiquement aux nouvelles versions de l'environnement, sélectionnez Mise à niveau automatique de l'environnement, puis indiquez le calendrier des mises à niveau.

      • Dans Rapports, cochez ou décochez les cases suivantes :

        • Rendez compte de l'état du système
        • Transmettre des métriques personnalisées à Cloud Monitoring
        • Installer Cloud Monitoring
        • Signaler l'état DNS des domaines Google requis
    11. Cliquez sur Créer.

      Vertex AI Workbench crée une instance et la démarre automatiquement. Lorsque l'instance est prête à l'emploi, Vertex AI Workbench active automatiquement un lien Ouvrir JupyterLab.

    gcloud

    Avant d'utiliser les données de la commande ci-dessous, effectuez les remplacements suivants :

    • INSTANCE_NAME : nom de votre instance Vertex AI Workbench. Ce nom doit commencer par une lettre, suivie de 62 caractères (lettres minuscules, chiffres ou traits d'union (-)), et ne peut pas se terminer par un trait d'union.
    • PROJECT_ID : ID de votre projet.
    • LOCATION : zone dans laquelle vous souhaitez placer votre instance.
    • VM_IMAGE_PROJECT : ID du projet Google Cloud auquel appartient l'image de VM. L'ID de projet Google Cloud par défaut pour les images compatibles est cloud-notebooks-managed.
    • VM_IMAGE_NAME : nom de l'image. Pour trouver le nom d'image d'une version spécifique, consultez Rechercher la version spécifique.
    • MACHINE_TYPE : type de machine de la VM de votre instance.
    • METADATA : métadonnées personnalisées à appliquer à cette instance. Par exemple, pour spécifier un script post-démarrage, vous pouvez utiliser le tag de métadonnées post-startup-script au format --metadata=post-startup-script=gs://BUCKET_NAME/hello.sh.

    Exécutez la commande suivante :

    Linux, macOS ou Cloud Shell

    gcloud workbench instances create INSTANCE_NAME \
        --project=PROJECT_ID \
        --location=LOCATION \
        --vm-image-project=VM_IMAGE_PROJECT \
        --vm-image-name=VM_IMAGE_NAME \
        --machine-type=MACHINE_TYPE \
        --metadata=METADATA

    Windows (PowerShell)

    gcloud workbench instances create INSTANCE_NAME `
        --project=PROJECT_ID `
        --location=LOCATION `
        --vm-image-project=VM_IMAGE_PROJECT `
        --vm-image-name=VM_IMAGE_NAME `
        --machine-type=MACHINE_TYPE `
        --metadata=METADATA

    Windows (cmd.exe)

    gcloud workbench instances create INSTANCE_NAME ^
        --project=PROJECT_ID ^
        --location=LOCATION ^
        --vm-image-project=VM_IMAGE_PROJECT ^
        --vm-image-name=VM_IMAGE_NAME ^
        --machine-type=MACHINE_TYPE ^
        --metadata=METADATA

    Pour en savoir plus sur la commande permettant de créer une instance à partir de la ligne de commande, consultez la documentation de la gcloud CLI.

    Vertex AI Workbench crée une instance et la démarre automatiquement. Lorsque l'instance est prête à l'emploi, Vertex AI Workbench active un lien Ouvrir JupyterLab dans la console Google Cloud .

    Terraform

    L'exemple suivant utilise la ressource Terraform google_workbench_instance pour créer une instance Vertex AI Workbench nommée workbench-instance-example.

    Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.

    resource "google_workbench_instance" "default" {
      name     = "workbench-instance-example"
      location = "us-central1-a"
    
      gce_setup {
        machine_type = "n1-standard-1"
        accelerator_configs {
          type       = "NVIDIA_TESLA_T4"
          core_count = 1
        }
        vm_image {
          project = "cloud-notebooks-managed"
          family  = "workbench-instances"
        }
      }
    }

    Preview de JupyterLab 4

    Cette section explique comment modifier la version de JupyterLab sur votre instance. Elle indique également des limites à prendre en compte lorsque vous activez JupyterLab 4.

    Modifier la version de JupyterLab sur une instance existante

    Vous pouvez modifier la version de JupyterLab de votre instance à l'aide de la consoleGoogle Cloud ou de la gcloud CLI.

    Console

    Pour modifier la version de JupyterLab sur une instance existante, procédez comme suit :

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

      Accéder à la page "Instances"

    2. Cliquez sur le nom de votre instance pour ouvrir la page Détails de l'instance.

    3. Dans l'onglet Système, effectuez l'une des opérations suivantes :

      • Pour activer la preview, sélectionnez Activer la preview de JupyterLab 4.

      • Pour désactiver la preview et utiliser JupyterLab 3, décochez Activer la preview de JupyterLab 4.

    4. Cliquez sur Envoyer.

    5. Réinitialisez votre instance.

    gcloud

    Vous pouvez modifier la version de JupyterLab sur une instance existante à l'aide de la commande suivante :

    gcloud workbench instances update INSTANCE_NAME \
        --project="PROJECT_ID" \
        --location="LOCATION" \
        --metadata=enable-jupyterlab4-preview=ENABLEMENT_BOOLEAN

    Remplacez les éléments suivants :

    • PROJECT_ID : ID de votre projet.
    • LOCATION : zone dans laquelle vous souhaitez placer votre instance.
    • INSTANCE_NAME : nom de votre instance Vertex AI Workbench.
    • ENABLEMENT_BOOLEAN : utilisez l'une des options suivantes :

      • true : active la preview de JupyterLab 4.
      • false : désactive la preview de JupyterLab 4 et passe à JupyterLab 3.

    Limites

    Tenez compte des limites suivantes lorsque vous activez la preview de JupyterLab 4 :

    Options de configuration du réseau

    Une instance Vertex AI Workbench doit accéder aux points de terminaison de service situés en dehors de votre réseau VPC.

    Pour fournir cet accès, procédez de l'une des manières suivantes :

    Si vous utilisez l'adresse IP virtuelle private.googleapis.com ou restricted.googleapis.com pour fournir l'accès aux points de terminaison du service, ajoutez des entrées DNS pour chacun des points de terminaison de service requis.

    • notebooks.googleapis.com
    • *.notebooks.cloud.google.com
    • *.notebooks.googleusercontent.com
    • *.kernels.googleusercontent.com

    Pour une instance avec des identifiants tiers, ajoutez une entrée DNS pour l'élément suivant :

    • *.byoid.googleusercontent.com

    Tags réseau

    Les tags réseau deeplearning-vm et notebook-instance sont attribués automatiquement à votre nouvelle instance Vertex AI Workbench.

    Section "Machines virtuelles" du menu de navigation de la console, avec les instances de VM sélectionnées, indiquant les tags réseau actuellement attribués.

    Ces tags vous permettent de gérer l'accès réseau depuis et vers votre instance Vertex AI Workbench en référençant les tags dans vos règles de pare-feu de réseau VPC. Pour en savoir plus sur les tags réseau, consultez Ajouter des tags réseau.

    Pour afficher les tags réseau d'une instance Vertex AI Workbench, procédez comme suit :

    1. Dans la console Google Cloud , accédez à la page Instances de VM.

      Accéder à la page "Instances de VM"

    2. Cliquez sur le nom de l'instance.

    3. Dans la section Mise en réseau, recherchez Tags réseau.

    Dépannage

    Si vous rencontrez un problème lors de la création d'une instance, consultez Résoudre les problèmes liés à Vertex AI Workbench pour obtenir de l'aide sur les problèmes courants.

    Étapes suivantes