本頁面由 Cloud Translation API 翻譯而成。

透過中繼資料管理功能

本頁說明如何修改執行個體的中繼資料鍵/值組合，以管理部分 Vertex AI Workbench 執行個體功能。

中繼資料鍵

如要瞭解功能及其對應的中繼資料鍵，請參閱下表。

功能	說明	中繼資料鍵	接受的值和預設值
在容器映像檔上啟用 Cloud Storage FUSE	將 `/dev/fuse` 掛接到容器，並啟用 `gcsfuse` 以便在容器上使用。	`container-allow-fuse`	`true`：啟用 Cloud Storage FUSE。 `false` (預設)：不啟用 Cloud Storage FUSE。
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 分鐘)。
訪客屬性	啟用訪客屬性。必須開啟這項設定，才能執行閒置關機功能。詳情請參閱「執行閒置關機功能的相關規定」。	`enable-guest-attributes`	`true` (預設)：啟用訪客屬性。 `false`：關閉訪客屬性。
已排定的 OS 修補程式	安排執行個體的自動作業系統更新。這會啟用 Debian 的無人值勤升級服務，且僅適用於 VM 型映像檔。	`install-unattended-upgrades`	`true`：開啟自動作業系統更新功能。 `false` (預設)：關閉自動作業系統更新功能。
自訂 Jupyter 使用者	指定預設 Jupyter 使用者的名稱。這項設定會決定筆記本的資料夾名稱。例如，您可以將目錄變更為 `/home/CUSTOM_NAME`，而非預設的 `/home/jupyter/` 目錄。這個中繼資料鍵不會影響對執行個體的存取權。	`jupyter-user`	字串。預設值為 `jupyter`。
下載檔案	可讓您從 JupyterLab 下載檔案。	`notebook-disable-downloads`	`true`：關閉檔案下載功能。 `false` (預設)：啟用檔案下載功能。
根目錄存取權	啟用根存取權。	`notebook-disable-root`	`true`：關閉 root 存取權。 `false` (預設)：啟用 root 存取權。
終端機存取權	啟用終端機存取權。	`notebook-disable-terminal`	`true`：關閉終端機存取權。 `false` (預設)：啟用終端機存取權。
定期升級	排定執行個體的自動升級作業。	`notebook-upgrade-schedule`	您設定的每週或每月排程，採用 Unix-Cron 格式，例如 `00 19 * * MON` 表示每週星期一下午 19:00 格林威治標準時間 (GMT)。這項功能預設為關閉。
開機後指令碼	在啟動後執行自訂指令碼。	`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 秒檢查一次 VM 指標的健康狀態。	`report-event-health`	`true` (預設)：啟用事件健康狀況回報功能。 `false`：關閉事件健康狀況回報功能。
啟用 JupyterLab 4 預先發布版	在執行個體上啟用 JupyterLab 4 (預先發布版)。詳情請參閱 JupyterLab 4 預先發布版。	`enable-jupyterlab4-preview`	`true`：啟用 JupyterLab 4。 `false` (預設)：啟用 JupyterLab 3。

由 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 執行個體的中繼資料，請按照下列步驟操作：

前往 Google Cloud 控制台的「Instances」(執行個體) 頁面。

前往「Instances」(執行個體)
在執行個體清單中，按一下要更新的執行個體名稱。
在「Instance details」頁面上，按一下「Software and security」。
在「中繼資料」專區中，更新要變更的中繼資料鍵值組合。
按一下「提交」。

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 執行個體移除中繼資料，請執行下列操作：

前往 Google Cloud 控制台的「Instances」(執行個體) 頁面。

前往「Instances」(執行個體)
在執行個體清單中，按一下要修改的執行個體名稱。
在「Instance details」頁面上，按一下「Software and security」。
在「中繼資料」部分，點選要刪除的鍵/值組合右側的「刪除」。
按一下「提交」。

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 來移除對應的功能。