创建用户管理的笔记本实例

创建用户管理的笔记本实例

Vertex AI Workbench 用户管理的笔记本已弃用。自 2025 年 1 月 30 日起，我们将终止对用户管理的笔记本的支持，并且将不再支持创建用户管理的笔记本实例。现有实例仍然可以正常使用，但我们将不再提供补丁、更新和升级。如需继续使用 Vertex AI Workbench，我们建议您将用户管理的笔记本实例迁移到 Vertex AI Workbench 实例。

本页面介绍如何使用 Google Cloud 控制台或 Google Cloud CLI 创建用户管理的笔记本实例。在创建实例时，您可以配置实例的硬件、加密类型、网络和其他详细信息。

须知事项

在创建用户管理的笔记本实例之前，您必须拥有 Google Cloud 项目并为该项目启用 Notebooks API。

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 Notebooks API.

   Enable the API

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

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Notebooks API.

   Enable the API

8. 如果您计划在用户管理的笔记本实例中使用 GPU，请查看 Google Cloud 控制台中的配额页面，确保您的项目中有足够的 GPU 可用。如果配额页面上未列出 GPU，或者您需要额外的 GPU 配额，您可以申请增加配额。请参阅 Compute Engine 资源配额页面的申请增加配额。

所需的角色

如果您已创建项目，则需要具有项目的 Owner (roles/owner) IAM 角色，该角色可提供所有必需的权限。跳过此部分并开始创建用户管理的笔记本实例。如果您未自行创建项目，请继续阅读本部分。

如需确保您的用户账号具有创建 Vertex AI Workbench 用户管理的笔记本实例所需的权限，请让您的管理员向您的用户账号授予项目的以下 IAM 角色：

• Notebooks Admin (roles/notebooks.admin)
• Service Account User (roles/iam.serviceAccountUser)

如需详细了解如何授予角色，请参阅管理访问权限。

您的管理员还可以通过自定义角色或其他预定义角色向您的用户账号授予所需的权限。

创建用户管理的笔记本实例

您可以使用 Google Cloud 控制台、Google Cloud CLI 或 Terraform 创建用户管理的笔记本实例。

控制台

如需使用 Google Cloud 控制台创建用户管理的笔记本实例，请执行以下操作：

1. 在 Google Cloud 控制台中，转到用户管理的笔记本页面。 或者转到 notebook.new (https://notebook.new) 并跳过下一步。

   进入“用户管理的笔记本”

2. 点击  新建。

   系统会打开新建实例窗口。

3. 在新建实例窗口中，点击高级选项。

4. 在详细信息部分中，为新实例提供以下信息：

   • 名称：为新实例提供名称。 名称必须以字母开头，后面最多可跟 62 个小写字母、数字或连字符 (-)，但不能以连字符结尾。
   • 区域和可用区：为新实例选择区域和可用区。为获得最佳网络性能，请选择与您的地理位置最近的区域。 查看可用的用户管理的笔记本位置。
   • 标签：可选。为实例提供自定义键值对标签。
   • 标记：可选。为实例提供标记。

5. 在环境部分中，提供以下信息：

   • 操作系统：选择要使用的操作系统。
   • 环境：选择要使用的环境。
   • 版本：使用用户管理的笔记本实例的最新版本或先前版本。
   • 启动后脚本：可选。点击浏览以选择在创建实例后要运行一次的脚本。该路径必须是网址或 Cloud Storage 路径，例如：gs://PATH_TO_FILE/FILE_NAME。
   • 元数据：可选。为实例提供自定义元数据键。

6. 在机器类型部分中，提供以下信息：

   • 机器类型：为新实例选择 CPU 数量和 RAM 容量。Vertex AI Workbench 会为您选择的每种机器类型提供每月估算费用。

   • GPU：可选。如果您需要 GPU，请为新实例选择 GPU 类型和 GPU 数量。如需了解各种 GPU，请参阅 Compute Engine 上的 GPU。

     选择自动为我安装 NVIDIA GPU 驱动程序。

     注意：您可以在创建实例后修改其机器类型和 GPU 配置。如需了解详情，请参阅更改机器类型并配置用户管理的笔记本实例的 GPU。

   • 安全强化型虚拟机：可选。选中或清除以下复选框：

     • 安全启动
     • 虚拟可信平台模块 (vTPM)
     • 完整性监控

   • 空闲机器关停：可选。

     • 如需更改关停前的分钟数，请在关停前保持非活跃状态的时间（分钟）字段中，将值更改为 10 到 1440 之间的整数。

     • 如需关闭空闲机器关停，请清除启用空闲机器关停。

7. 在磁盘部分中，提供以下信息：

   • 磁盘：可选。要更改默认启动或数据磁盘设置，请选择启动磁盘类型、启动磁盘大小 (GB)、数据磁盘类型和数据磁盘大小 (GB)。如需详细了解磁盘类型，请参阅存储选项。

   • 删除至回收站可选：选中此复选框以使用操作系统的默认回收站行为。如果您使用默认回收站行为，则使用 JupyterLab 界面删除的文件可以恢复，但这些已删除的文件会占用磁盘空间。

   • 备份：可选。要将 Cloud Storage 位置与实例的数据磁盘同步，请点击浏览并指定 Cloud Storage 位置。如需了解存储费用，请参阅 Cloud Storage 价格。

   • 加密：选择 Google 管理的加密密钥或客户管理的加密密钥 (CMEK)。如需使用 CMEK，请参阅客户管理的加密密钥。

8. 在网络部分中，提供以下信息：

   • 网络：调整网络选项，以在宿主项目中使用当前项目的网络或共享 VPC 网络（如果已配置）。如果您在宿主项目中使用共享 VPC，则还必须在宿主项目中向 Notebooks Service Agent 授予 Compute Network User 角色 (roles/compute.networkUser)。

     注意：在 IAM 和管理部分中选择包括 Google 提供的角色授权时，Notebooks Service Agent 会在可见服务项目中自动创建。Notebooks Service Agent 服务账号为 [e-mail]。

     1. 在网络字段中，选择所需的网络。您可以选择 VPC 网络，只要该网络启用了专用 Google 访问通道或者可以访问互联网即可。如需了解详情，请参阅网络配置选项。

     2. 在子网字段中，选择所需的子网。

   • 如需关闭外部 IP 地址，请清除分配外部 IP 地址复选框。

   • 如需关闭代理访问权限，请清除允许代理访问权限复选框。

     注意：如果您关闭代理访问权限，则必须使用 SSH 连接到实例的 JupyterLab 界面。

9. 在 IAM 和安全部分，提供以下信息：

   • IAM 和安全：如需授予对实例的 JupyterLab 界面的访问权限，请完成以下步骤之一：

     • 如需通过服务账号授予对 JupyterLab 的访问权限，请选择服务账号。

       • 如需使用默认的 Compute Engine 服务账号，请选择 Use default Compute Engine service account。

       • 如需使用自定义服务账号，请清除 Use default Compute Engine service account，然后在服务账号电子邮件地址字段中输入您的自定义服务账号电子邮件地址。

     • 如需为单个用户授予对 JupyterLab 界面的访问权限，请执行以下操作：

       1. 选择单个用户，然后在用户电子邮件字段中输入要授予访问权限的用户账号。如果指定用户不是实例的创建者，您必须向指定用户授予实例的服务账号的 Service Account User 角色 (roles/iam.serviceAccountUser)。

       2. 您的实例使用服务账号与 Google Cloud 服务和 API 进行交互。

          • 如需使用默认的 Compute Engine 服务账号，请选择 Use default Compute Engine service account。

          • 如需使用自定义服务账号，请清除 Use default Compute Engine service account，然后在服务账号电子邮件地址字段中输入您的自定义服务账号电子邮件地址。

     注意：如需通过服务账号或单用户选项授予对实例的访问权限，您必须使用个人用户账号电子邮件地址。不支持群组访问。

     如需详细了解如何授予访问权限，请参阅管理访问权限。

     注意：创建具有服务账号访问权限的实例后，便无法更改该服务账号。如需使用其他服务账号，您必须创建一个指定所需服务账号的新实例。如果尝试使用 Compute Engine API 更改服务账号，可能会导致功能丢失。

   • 安全选项：选中或清除以下复选框：

     • 对实例的根访问权限
     • nbconvert
     • 文件下载
     • 终端访问权限
     注意：即使您未选择 文件下载，使用 Dataproc Hub 框架的用户管理的笔记本实例也会允许文件下载。

10. 在系统健康状况部分中，提供以下信息：

    • 环境升级和系统健康状况：如需自动升级到新发布的环境版本，请选择环境自动升级并完成升级时间表。

    • 在报告中，选中或清除以下复选框：

      • 报告系统健康状况
      • 向 Cloud Monitoring 报告自定义指标
      • 安装 Cloud Monitoring
      • 报告所需 Google 网域的 DNS 状态

11. 点击创建。

    Vertex AI Workbench 会创建并自动启动用户管理的笔记本实例。当实例可供使用时，Vertex AI Workbench 会激活打开 JupyterLab 链接。

gcloud

默认情况下，Google Cloud CLI 会创建一个具有外部 IP 地址的用户管理的笔记本实例。如需创建一个没有外部 IP 地址的实例，您必须指定启用了专用 Google 访问通道的子网。如需了解详情，请参阅网络配置选项。

1. 如需通过命令行、Cloud Shell 或安装了 Google Cloud CLI 的任何终端创建用户管理的笔记本实例，请使用 gcloud notebooks instances create 命令：

   gcloud notebooks instances create INSTANCE_NAME \
     --vm-image-project=deeplearning-platform-release \
     --vm-image-family=VM_IMAGE_FAMILY \
     --machine-type=MACHINE_TYPE \
     --location=LOCATION
   

   替换以下内容：

   • INSTANCE_NAME：新实例的名称；必须以字母开头，后面最多可跟 62 个小写字母、数字或连字符 (-)，但不能以连字符结尾。
   • VM_IMAGE_FAMILY：要用于创建实例的映像系列名称
   • MACHINE_TYPE：实例虚拟机的机器类型
   • LOCATION：新实例所在的 Google Cloud 位置

2. 通过 Google Cloud 控制台访问实例。

如需了解通过命令行创建实例的所有命令，请参阅 gcloud CLI 文档。

Terraform

以下示例会使用 google_notebooks_instance Terraform 资源创建名为 notebooks-instance-basic 的新用户管理的笔记本实例。

如需了解如何应用或移除 Terraform 配置，请参阅基本 Terraform 命令。

resource "google_notebooks_instance" "basic_instance" {
  name         = "notebooks-instance-basic"
  location     = "us-central1-a"
  machine_type = "e2-medium"

  vm_image {
    project      = "deeplearning-platform-release"
    image_family = "tf-ent-2-9-cu113-notebooks"
  }
}

打开笔记本

如需打开用户管理的笔记本实例，请完成以下步骤：

1. 在 Google Cloud 控制台中，点击用户管理的笔记本实例名称旁边的打开 JupyterLab。

2. 用户管理的笔记本实例会打开 JupyterLab。

网络配置选项

用户管理的笔记本实例必须访问 VPC 网络之外的服务端点。

您可以通过以下方式之一提供此访问权限：

• 向用户管理的笔记本实例分配外部 IP 地址。当您创建具有默认属性的新实例时，系统会自动完成此操作。确保您的环境符合访问 Google API 和服务的要求。

• 将用户管理的笔记本实例连接到启用了专用 Google 访问通道的子网。确保您的环境符合专用 Google 访问通道的要求。

如果您使用 private.googleapis.com 或 restricted.googleapis.com VIP 地址来提供对服务端点的访问权限，请为每个必需的服务端点添加 DNS 条目：

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

网络标记

新的用户管理的笔记本实例自动分配有 deeplearning-vm 和 notebook-instance 网络标记。

这些标记可让您通过在 VPC 网络防火墙规则中引用该标记来管理进出用户管理的笔记本实例的网络访问权限。如需详细了解网络标记，请参阅添加网络标记。

如需查看用户管理的笔记本实例的网络标记，请执行以下操作：

1. 在 Google Cloud 控制台中，前往虚拟机实例页面。

   进入“虚拟机实例”

2. 点击实例的名称。

3. 在网络部分中，找到网络标记。

问题排查

如果在创建笔记本时遇到问题，请参阅 Vertex AI Workbench 问题排查以获取常见问题的帮助。

后续步骤

• 在新的用户管理的笔记本实例上安装依赖项。

• 了解如何监控用户管理的笔记本实例的健康状况。