このページは Cloud Translation API によって翻訳されました。

メタデータを通じて機能を管理する

このページでは、Vertex AI Workbench インスタンスのメタデータの Key-Value ペアを変更して、インスタンスの一部機能を管理する方法について説明します。

メタデータキー

機能とそれぞれのメタデータキーについては、次の表をご覧ください。

特徴	説明	メタデータキー	使用可能な値とデフォルト
コンテナイメージで 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 分）です。
スケジュールされた OS パッチ	インスタンスの OS の自動更新をスケジュールします。これにより、Debian の無人アップグレードサービスが有効になり、VM ベースのイメージにのみ適用されます。	`install-unattended-upgrades`	`true`: OS の自動更新をオンにします。 `false`（デフォルト）: OS の自動更新を無効にします。
カスタム Jupyter ユーザー	デフォルトの Jupyter ユーザーの名前を指定します。この設定により、ノートブックのフォルダ名が決まります。たとえば、デフォルトの `/home/jupyter/` ディレクトリではなく、`/home/CUSTOM_NAME` に変更できます。このメタデータキーは、インスタンスへのアクセスには影響しません。	`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`（デフォルト）: インスタンスの作成またはアップグレード後に、起動後のスクリプトを 1 回実行します。 `run_every_start`: 起動のたびに起動後のスクリプトを実行します。 `download_and_run_every_start`: 起動後のスクリプトをソースから再ダウンロードし、起動のたびにスクリプトを実行します。
イベントの状態をレポートする	VM 指標に対する 30 秒ごとのヘルスチェックを行います。	`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

特定のメタデータを持つインスタンスを作成する

特定のメタデータを持つ Vertex AI Workbench インスタンスを作成するには、Google Cloud コンソール、Google Cloud CLI、Terraform、または Notebooks API を使用します。

コンソール

Vertex AI Workbench インスタンスを作成する場合は、[詳細オプション] の [環境] セクションでメタデータを追加できます。

[環境] セクションの [メタデータを追加] ボタン

gcloud

Vertex AI Workbench インスタンスを作成するときに、次のコマンドを使用してメタデータを追加できます。

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

Terraform

メタデータを追加するには、メタデータの Key-Value ペアを使用してリソースを作成します。

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 メソッドを使用します。

インスタンスのメタデータを更新する

Vertex AI Workbench インスタンスのメタデータを更新するには、Google Cloud コンソール、Google Cloud CLI、Terraform、または Notebooks API を使用します。

コンソール

Vertex AI Workbench インスタンスのメタデータは、[詳細] ページの [ソフトウェアとセキュリティ] セクションで更新できます。

メタデータの Key-Value フィールドの例

gcloud

Vertex AI Workbench インスタンスのメタデータは、次のコマンドを使用して更新できます。

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

Terraform

メタデータの Key-Value ペアを変更して、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

対応する機能を管理するには、updateMask でメタデータ値と gce_setup.metadata を指定して instances.patch メソッドを使用します。

インスタンスからメタデータを削除する

Vertex AI Workbench インスタンスからメタデータを削除するには、Google Cloud コンソール、Google Cloud CLI、Terraform、または Notebooks API を使用します。

コンソール

Vertex AI Workbench インスタンスのメタデータは、[詳細] ページの [ソフトウェアとセキュリティ] セクションで削除できます。

更新時のメタデータの Key-Value フィールドの例

gcloud

Vertex AI Workbench インスタンスからメタデータを削除するには、次のコマンドを使用します。

gcloud workbench instances update INSTANCE_NAME --metadata=KEY

Terraform

メタデータの Key-Value ペアを削除して、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 を使用して、対応する機能を削除します。