通过元数据管理功能

本页面介绍如何通过修改实例的元数据键值对来管理某些 Vertex AI Workbench 实例功能。

元数据键

如需了解各个功能及其对应的元数据键，请参阅下表。

功能	说明	元数据键	接受的值和默认值
nbconvert	可让您以其他文件类型导出和下载笔记本。	`notebook-disable-nbconvert`	`true`：停用 nbconvert。 `false`（默认值）：启用 nbconvert。
删除至回收站	从 JupyterLab 中删除时使用操作系统的回收站行为。	`notebook-enable-delete-to-trash`	`true`：允许删除到回收站。 `false`（默认值）：使用默认的 JupyterLab 行为。
Dataproc	实现对 Dataproc 内核的访问权限。如需了解详情，请参阅创建启用 Dataproc 的实例。	`disable-mixer`	`true`：禁止访问 Dataproc 内核。 `false`（默认值）：允许访问 Dataproc 内核。
空闲机器关停	启用空闲机器关停功能。如需了解详情，请参阅空闲机器关停。	`idle-timeout-seconds`	表示空闲时间的整数，以秒为单位。默认值为 `10800` 秒（180 分钟）。
自定义 Jupyter 用户	指定默认 Jupyter 用户的名称。此设置决定了笔记本的文件夹名称。例如，您可以将目录更改为 `/home/CUSTOM_NAME`，而不是使用默认的 `/home/jupyter/` 目录。此元数据键不会影响对实例的访问。	`jupyter-user`	一个字符串。默认值为 `jupyter`。
文件下载	可让您从 JupyterLab 下载文件。	`notebook-disable-downloads`	`true`：停用文件下载。 `false`（默认值）：启用文件下载。
根访问权限	启用根访问权限。	`notebook-disable-root`	`true`：停用根访问权限。 `false`（默认值）：启用根访问权限。
终端访问权限	启用终端访问权限。	`notebook-disable-terminal`	`true`：停用终端访问权限。 `false`（默认值）：启用终端访问权限。
预定升级	预定实例的自动升级。	`notebook-upgrade-schedule`	您设置的每周或每月时间表，采用 unix-cron 格式，例如 `00 19 * * MON` 表示格林威治标准时间 (GMT) 每周一的 19:00。默认情况下，此功能处于关闭状态。
启动后脚本	在启动后运行自定义脚本。	`post-startup-script`	Cloud Storage 中启动后脚本的 URI，例如 `gs://bucket/hello.sh`。默认情况下，此功能处于关闭状态。
启动后脚本行为	定义启动后脚本运行的时间和方式。	`post-startup-script-behavior`	`run_once`（默认）：在实例创建或升级后运行启动后脚本一次。 `run_every_start`：在每次启动后运行启动后脚本。 `download_and_run_every_start`：从来源重新下载启动后脚本，然后在每次启动后运行该脚本。
报告事件健康状况	每 30 秒检查一次虚拟机指标的健康状况。	`report-event-health`	`true`（默认值）：启用事件健康状况报告。 `false`：停用事件健康状况报告。

Compute Engine 管理的元数据

Compute Engine 预定义了部分元数据键。如需了解详情，请参阅预定义的元数据键。

受保护的元数据键

某些元数据键已为系统预留，仅供系统使用。如果您为这些元数据键分配值，则新值将会被系统值覆盖。

预留的元数据键包括但不限于：

data-disk-uri
enable-oslogin
framework
notebooks-api
notebooks-api-version
nvidia-driver-gcs-path
proxy-url
restriction
shutdown-script
title
version

创建具有特定元数据的实例

您可以使用 Google Cloud 控制台、Google Cloud CLI、Terraform 或 Notebooks API 创建具有特定元数据的 Vertex AI Workbench 实例。

控制台

创建 Vertex AI Workbench 实例时，您可以在高级选项的环境部分中添加元数据。

“环境”部分中的“添加元数据”按钮

gcloud

创建 Vertex AI Workbench 实例时，您可以使用以下命令添加元数据。

gcloud workbench instances create INSTANCE_NAME --metadata=KEY=VALUE

Terraform

如需添加元数据，请使用元数据键值对创建资源。

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

resource "google_workbench_instance" "default" {
  name     = "workbench-instance-example"
  location = "us-central1-a"

  gce_setup {
    machine_type = "n1-standard-1"
    vm_image {
      project = "cloud-notebooks-managed"
      family  = "workbench-instances"
    }
    metadata = {
      key = "value"
    }
  }
}

Notebooks API

使用 instances.create 方法和元数据值来管理相应的功能。

更新实例的元数据

您可以使用 Google Cloud 控制台、Google Cloud CLI、Terraform 或 Notebooks API 更新 Vertex AI Workbench 实例的元数据。

控制台

您可以在 Vertex AI Workbench 实例的详细信息页面上的软件和安全部分中更新该实例的元数据。

元数据键和值字段示例

gcloud

您可以使用以下命令更新 Vertex AI Workbench 实例的元数据。

gcloud workbench instances update INSTANCE_NAME --metadata=KEY=VALUE

Terraform

您可以更改元数据键值对，以管理 Vertex AI Workbench 实例上的相应功能。

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

resource "google_workbench_instance" "default" {
  name     = "workbench-instance-example"
  location = "us-central1-a"

  gce_setup {
    machine_type = "n1-standard-1"
    vm_image {
      project = "cloud-notebooks-managed"
      family  = "workbench-instances"
    }
    metadata = {
      key = "updated_value"
    }
  }
}

Notebooks API

使用 instances.patch 方法与元数据值以及 updateMask 中的 gce_setup.metadata 来管理相应的功能。

从实例中移除元数据

您可以使用 Google Cloud 控制台、Google Cloud CLI、Terraform 或 Notebooks API 从 Vertex AI Workbench 实例中移除元数据。

控制台

您可以在 Vertex AI Workbench 实例的详细信息页面上的软件和安全部分中移除该实例中的元数据。

更新期间的元数据键和值字段示例

gcloud

您可以使用以下命令从 Vertex AI Workbench 实例中移除元数据。

gcloud workbench instances update INSTANCE_NAME --metadata=KEY=

Terraform

您可以移除元数据键值对，以管理 Vertex AI Workbench 实例的相应功能。

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

resource "google_workbench_instance" "default" {
  name     = "workbench-instance-example"
  location = "us-central1-a"

  gce_setup {
    machine_type = "n1-standard-1"
    vm_image {
      project = "cloud-notebooks-managed"
      family  = "workbench-instances"
    }
    metadata = {
    }
  }
}

Notebooks API

使用 instances.patch 方法并将元数据值设置为空字符串，并使用 updateMask 中的 gce_setup.metadata，以移除相应的功能。