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

このページでは、インスタンスのメタデータの Key-Value ペアを変更して、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 カーネルへのアクセスを有効にします。
アイドル状態でのシャットダウン	アイドル状態でのシャットダウンを有効にします。 詳細については、アイドル状態でのシャットダウンをご覧ください。	idle-timeout-seconds	アイドル状態の時間を秒単位で表す整数。デフォルト値は 10800 秒（180 分）です。
ゲスト属性	ゲスト属性を有効にします。アイドル状態でのシャットダウンを実行するために必要です。 詳細については、アイドル状態でのシャットダウンの実行要件をご覧ください。	enable-guest-attributes	true（デフォルト）: ゲスト属性を有効にします。 false: ゲスト属性を無効にします。
スケジュールされた 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 3 に切り替える	JupyterLab 3 を有効にします。JupyterLab 4 はデフォルトで有効になっています。	enable-jupyterlab4	true（デフォルト）: JupyterLab 4 を有効にします。 false: JupyterLab 3 を有効にします。

起動スクリプトの実行順序

Agent Platform Workbench インスタンスに複数の起動スクリプトを使用する場合、スクリプトは次の順序で実行されます。

1. startup-script: 初回起動後の各起動時の 1 番目に実行されます。
2. startup-script-url: 初回起動後の各起動時の 2 番目に実行されます。
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

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

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

コンソール

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

gcloud

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

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

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

コンソール

Agent Platform Workbench インスタンスのメタデータを更新する手順は次のとおりです。

1. Google Cloud コンソールで [インスタンス] ページに移動します。

   [インスタンス] に移動

2. インスタンスのリストで、更新するインスタンスの名前をクリックします。

3. [インスタンスの詳細] ページで、[ソフトウェアとセキュリティ] をクリックします。

4. [メタデータ] セクションで、変更するメタデータの Key-Value ペアを更新します。

5. [送信] をクリックします。

gcloud

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

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

Terraform

メタデータの Key-Value ペアを変更して、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 でメタデータ値と gce_setup.metadata を指定して instances.patch メソッドを使用します。

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

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

コンソール

Agent Platform Workbench インスタンスからメタデータを削除する手順は次のとおりです。

1. Google Cloud コンソールで [インスタンス] ページに移動します。

   [インスタンス] に移動

2. インスタンスのリストで、変更するインスタンスの名前をクリックします。

3. [インスタンスの詳細] ページで、[ソフトウェアとセキュリティ] をクリックします。

4. [メタデータ] セクションで、削除する Key-Value ペアの右側にある [削除] をクリックします。

5. [送信] をクリックします。

gcloud

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

gcloud workbench instances update INSTANCE_NAME --metadata=KEY

Terraform

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