透過中繼資料管理功能

本頁面說明如何修改執行個體的中繼資料鍵/值組合,管理部分 Gemini Enterprise Agent Platform 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 行為。
Managed Service for Apache Spark

啟用 Managed Service for Apache Spark 核心存取權。

詳情請參閱「建立已啟用 Managed Service for Apache Spark 的執行個體」。

disable-mixer
  • true:關閉 Managed Service for Apache Spark 核心的存取權。
  • false (預設):啟用 Managed Service for Apache Spark 核心存取權。
BigQuery

啟用 BigQuery JupyterLab 外掛程式,在 JupyterLab 中提供資料集探索工具、SQL 查詢編輯器和查詢記錄。

disable-bigquery
  • true:關閉 BigQuery JupyterLab 外掛程式。
  • false (預設):啟用 BigQuery JupyterLab 外掛程式。
閒置關閉

啟用閒置關機功能。

詳情請參閱「閒置關機」。

idle-timeout-seconds 代表閒置時間的整數 (以秒為單位)。預設值為 10800 秒 (180 分鐘)。
房客屬性

啟用訪客屬性。必須啟用,才能執行閒置關機。

詳情請參閱「執行閒置關機作業的需求條件」。

enable-guest-attributes
  • true (預設):啟用訪客屬性。
  • false:關閉訪客屬性。
  • 排定 OS 修補作業

    排定執行個體的 OS 自動更新時間。這會啟用 Debian 的自動升級服務,且僅適用於以 VM 為基礎的映像檔。

    install-unattended-upgrades
    • true:開啟 OS 自動更新功能。
    • false (預設):關閉 OS 自動更新功能。
    自訂 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。這項功能預設為關閉。如要停用或不啟用這項功能,請從設定中省略 notebook-upgrade-schedule 中繼資料鍵,或將其值設為空字串 ("")。
    開機後指令碼

    在其他開機指令碼完成後,執行自訂指令碼。如要進一步瞭解執行順序,請參閱「開機指令碼執行順序」。

    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 3

    啟用 JupyterLab 3。JupyterLab 4 預設為啟用。

    enable-jupyterlab4
    • true (預設):啟用 JupyterLab 4。
    • false:啟用 JupyterLab 3。
    Antigravity CLI

    在採用 Debian 12 (workbench-instances-2603) 以上版本映像檔的執行個體上,啟用 Antigravity CLI,以及其啟動器圖塊、筆記本技能、外掛程式和 %%agy 儲存格魔術指令。執行個體會在啟動時套用這個值。

    enable-antigravity
    • true (新執行個體的預設值):開啟 Antigravity CLI。
    • false:關閉 Antigravity CLI。

    開機指令碼執行順序

    如果 Agent Platform Workbench 執行個體使用多個開機指令碼,這些指令碼會依下列順序執行:

    1. startup-script:在初始啟動後,每次啟動時都會先執行。
    2. startup-script-url:在初始啟動後,每次啟動時第二個執行。
    3. workbench-startup-scripts:在 Compute Engine 開機指令碼 (startup-script 和 startup-script-url) 完成後執行。
    4. post-startup-script:在 workbench-startup-scripts 完成後執行。

    請注意,如果是 post-startup-script 中繼資料鍵,您必須以 Cloud Storage URI 的形式提供指令碼。您無法直接將指令碼內容做為值。

    由 Compute Engine 管理的中繼資料

    部分中繼資料鍵是由 Compute Engine 預先定義。詳情請參閱「預先定義的中繼資料索引鍵」。

    受保護的中繼資料鍵

    部分中繼資料鍵僅保留給系統使用。如果您為這些中繼資料索引鍵指派值,新值會遭到系統值覆寫。

    保留的中繼資料鍵包括但不限於:

    • agent-health-check-interval-seconds
    • agent-health-check-path
    • cos-update-strategy
    • custom-container-image
    • custom-container-payload
    • data-disk-uri
    • dataproc-allow-custom-clusters
    • dataproc-cluster-name
    • dataproc-configs
    • dataproc-default-subnet
    • dataproc-locations-list
    • dataproc-machine-types-list
    • dataproc-notebooks-url
    • dataproc-region
    • dataproc-service-account
    • disable-check-xsrf
    • euc-enabled
    • framework
    • generate-diagnostics-bucket
    • generate-diagnostics-file
    • generate-diagnostics-options
    • google-logging-enabled
    • image-url
    • install-monitoring-agent
    • install-nvidia-driver
    • installed-extensions
    • last_updated_diagnostic
    • last_updated_diagnostics
    • notebooks-api
    • notebooks-api-version
    • notebooks-examples-location
    • notebooks-location
    • proxy-backend-id
    • proxy-byoid-url
    • proxy-mode
    • proxy-status
    • proxy-url
    • proxy-user-mail
    • report-container-health
    • report-event-url
    • report-notebook-metrics
    • report-system-health
    • report-system-status
    • resource-url
    • restriction
    • serial-port-logging-enable
    • service-account-mode
    • shutdown-script
    • title
    • use-collaborative
    • user-data
    • version

    建立具有特定中繼資料的執行個體

    您可以使用 Google Cloud 控制台、Google Cloud CLI、Terraform 或 Notebooks API,建立具有特定中繼資料的 Agent Platform Workbench 執行個體。

    控制台

    建立 Agent Platform Workbench 執行個體時,您可以在「進階選項」的「環境」部分新增中繼資料。

    「環境」部分的「新增中繼資料」按鈕

    gcloud

    建立 Agent Platform 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,更新 Agent Platform Workbench 執行個體的中繼資料。

    控制台

    如要更新 Agent Platform Workbench 執行個體的中繼資料,請按照下列步驟操作:

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

      前往「Instances」(執行個體) 頁面

    2. 在執行個體清單中,按一下要更新的執行個體名稱。

    3. 在「執行個體詳細資料」頁面,點選「軟體與安全性」。

    4. 在「Metadata」(中繼資料) 區段中,更新要變更的中繼資料鍵/值組合。

    5. 按一下「提交」。

    gcloud

    您可以使用下列指令,更新 Agent Platform Workbench 執行個體的中繼資料:

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

    Terraform

    您可以變更中繼資料鍵/值組合,管理 Agent Platform 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

    在 updateMask 中,使用 instances.patch 方法搭配中繼資料值和 gce_setup.metadata,管理對應的功能。

    移除執行個體的中繼資料

    您可以使用 Google Cloud 控制台、Google Cloud CLI、Terraform 或 Notebooks API,從 Agent Platform Workbench 執行個體中移除中繼資料。

    控制台

    如要從 Agent Platform Workbench 執行個體移除中繼資料,請按照下列步驟操作:

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

      前往「Instances」(執行個體) 頁面

    2. 在執行個體清單中,按一下要修改的執行個體名稱。

    3. 在「Instance details」(執行個體詳細資料) 頁面中,按一下「Software and security」(軟體和安全性)。

    4. 在「Metadata」(中繼資料) 區段中,找出要刪除的鍵/值組合,然後按一下右側的 「Delete」(刪除)。

    5. 按一下「提交」。

    gcloud

    您可以使用下列指令,從 Agent Platform Workbench 執行個體中移除中繼資料:

    gcloud workbench instances update INSTANCE_NAME --metadata=KEY

    Terraform

    您可以移除中繼資料鍵/值組合,管理 Agent Platform 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,即可移除對應的功能。