Mengelola fitur melalui metadata

Halaman ini menjelaskan cara mengelola beberapa fitur instance Workbench Gemini Enterprise Agent Platform dengan mengubah key-value pair metadata instance.

Kunci metadata

Untuk mengetahui informasi tentang fitur dan kunci metadata masing-masing, lihat tabel berikut.

Fitur	Deskripsi	Kunci metadata	Nilai yang diterima dan default
Mengaktifkan Cloud Storage FUSE pada image container	Memasang /dev/fuse ke container dan mengaktifkan gcsfuse untuk digunakan pada container.	container-allow-fuse	true: Mengaktifkan Cloud Storage FUSE. false (default): Tidak mengaktifkan Cloud Storage FUSE.
nbconvert	Memungkinkan Anda mengekspor dan mendownload notebook sebagai jenis file lain.	notebook-disable-nbconvert	true: Menonaktifkan nbconvert. false (default): Mengaktifkan nbconvert.
Hapus ke sampah	Menggunakan perilaku sampah sistem operasi saat menghapus dari JupyterLab.	notebook-enable-delete-to-trash	true: Mengaktifkan penghapusan ke sampah. false (default): Menggunakan perilaku JupyterLab default.
Managed Service untuk Apache Spark	Mengaktifkan akses ke kernel Managed Service untuk Apache Spark. Untuk mengetahui informasi selengkapnya, lihat Membuat instance yang mendukung Managed Service untuk Apache Spark.	disable-mixer	true: Menonaktifkan akses ke kernel Managed Service untuk Apache Spark. false (default): Mengaktifkan akses ke kernel Managed Service untuk Apache Spark.
BigQuery	Mengaktifkan plugin BigQuery JupyterLab, yang menyediakan penjelajah set data, editor kueri SQL, dan histori kueri di JupyterLab.	disable-bigquery	true: Menonaktifkan plugin JupyterLab BigQuery. false (default): Mengaktifkan plugin JupyterLab BigQuery.
Penonaktifan saat tidak ada aktivitas	Mengaktifkan penonaktifan saat tidak ada aktivitas. Untuk mengetahui informasi selengkapnya, lihat Penonaktifan saat tidak ada aktivitas.	idle-timeout-seconds	Bilangan bulat yang mewakili waktu tidak ada aktivitas dalam detik. Nilai default-nya adalah 10800 detik (180 menit).
Atribut tamu	Mengaktifkan atribut tamu. Diperlukan untuk menjalankan penonaktifan saat tidak ada aktivitas. Untuk mengetahui informasi selengkapnya, lihat Persyaratan untuk menjalankan penonaktifan saat tidak ada aktivitas.	enable-guest-attributes	true (default): Mengaktifkan atribut tamu. false: Menonaktifkan atribut tamu.
Patch OS terjadwal	Menjadwalkan update OS otomatis pada instance. Tindakan ini akan mengaktifkan layanan upgrade otomatis Debian dan hanya berlaku untuk image berbasis VM.	install-unattended-upgrades	true: Mengaktifkan update OS otomatis. false (default): Menonaktifkan update OS otomatis.
Pengguna Jupyter kustom	Menentukan nama pengguna Jupyter default. Setelan ini menentukan nama folder untuk notebook Anda. Misalnya, alih-alih direktori /home/jupyter/ default, Anda dapat mengubah direktori menjadi /home/CUSTOM_NAME. Kunci metadata ini tidak memengaruhi akses ke instance.	jupyter-user	String. Nilai defaultnya adalah jupyter.
Mendownload file	Memungkinkan Anda mendownload file dari JupyterLab.	notebook-disable-downloads	true: Menonaktifkan download file. false (default): Mengaktifkan download file.
Akses root	Mengaktifkan akses root.	notebook-disable-root	true: Menonaktifkan akses root. false (default): Mengaktifkan akses root.
Akses terminal	Mengaktifkan akses terminal.	notebook-disable-terminal	true: Menonaktifkan akses terminal. false (default): Mengaktifkan akses terminal.
Upgrade terjadwal	Menjadwalkan upgrade otomatis instance.	notebook-upgrade-schedule	Jadwal mingguan atau bulanan yang Anda tetapkan, dalam format unix-cron, misalnya, 00 19 * * MON berarti setiap minggu pada hari Senin, pukul 19.00 Waktu Greenwich (GMT). Fitur ini dinonaktifkan secara default. Untuk menonaktifkan fitur ini atau tetap menonaktifkannya, hapus kunci metadata notebook-upgrade-schedule dari konfigurasi Anda atau tetapkan nilainya ke string kosong ("").
Skrip pasca-startup	Menjalankan skrip kustom setelah skrip startup lainnya selesai. Untuk mengetahui detail tentang urutan eksekusi, lihat Urutan eksekusi skrip startup.	post-startup-script	URI skrip pasca-startup di Cloud Storage, misalnya: gs://bucket/hello.sh. Fitur ini dinonaktifkan secara default.
Perilaku skrip pasca-startup	Menentukan kapan dan cara skrip pasca-startup dijalankan.	post-startup-script-behavior	run_once (default): Menjalankan skrip pasca-startup sekali setelah pembuatan atau upgrade instance. run_every_start: Menjalankan skrip pasca-startup setelah setiap kali dimulai. download_and_run_every_start: Mendownload ulang skrip pasca-startup dari sumbernya, lalu menjalankan skrip setelah setiap startup.
Melaporkan kondisi acara	Memeriksa responsivitas setiap 30 detik untuk metrik VM.	report-event-health	true (default): Mengaktifkan pelaporan kondisi peristiwa. false: Menonaktifkan pelaporan kondisi peristiwa.
Mengaktifkan JupyterLab 4 atau beralih ke JupyterLab 3	Aktifkan JupyterLab 3. JupyterLab 4 diaktifkan secara default.	enable-jupyterlab4	true (default): Mengaktifkan JupyterLab 4. false: Mengaktifkan JupyterLab 3.
Antigravity CLI	Mengaktifkan Antigravity CLI, dengan kartu peluncur, keterampilan notebook, plugin, dan %%agy cell magic, pada instance yang menggunakan image Debian 12 (workbench-instances-2603) atau yang lebih baru. Instance menerapkan nilai saat dimulai.	enable-antigravity	true (default untuk instance baru): Mengaktifkan Antigravity CLI. false: Menonaktifkan Antigravity CLI.

Urutan eksekusi skrip startup

Jika Anda menggunakan beberapa skrip startup untuk instance Agent Platform Workbench, skrip tersebut akan dijalankan dalam urutan berikut:

1. startup-script: Berjalan pertama kali selama setiap booting setelah booting awal.
2. startup-script-url: Berjalan kedua dalam setiap booting setelah booting awal.
3. workbench-startup-scripts: Berjalan setelah skrip booting Compute Engine (startup-script dan startup-script-url) selesai.
4. post-startup-script: Berjalan setelah workbench-startup-scripts selesai.

Perhatikan bahwa untuk kunci metadata post-startup-script, Anda harus menyediakan skrip sebagai URI Cloud Storage. Anda tidak dapat memberikan konten skrip secara langsung sebagai nilai.

Metadata yang dikelola oleh Compute Engine

Beberapa kunci metadata telah ditentukan oleh Compute Engine. Untuk mengetahui informasi selengkapnya, lihat Kunci metadata yang telah ditetapkan.

Kunci metadata yang dilindungi

Beberapa kunci metadata dicadangkan hanya untuk penggunaan sistem. Jika Anda menetapkan nilai ke kunci metadata ini, nilai baru akan ditimpa oleh nilai sistem.

Kunci metadata yang dicadangkan mencakup dan tidak terbatas pada:

• 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

Membuat instance dengan metadata tertentu

Anda dapat membuat instance Agent Platform Workbench dengan metadata tertentu menggunakan konsol Google Cloud , Google Cloud CLI, Terraform, atau Notebooks API.

Konsol

Saat membuat instance Agent Platform Workbench, Anda dapat menambahkan metadata di bagian Environment pada Advanced options.

gcloud

Saat membuat instance Agent Platform Workbench, Anda dapat menambahkan metadata menggunakan perintah berikut:

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

Terraform

Untuk menambahkan metadata, buat resource dengan key-value pair metadata.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar 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

Gunakan metode instances.create dengan nilai metadata untuk mengelola fitur yang sesuai.

Memperbarui metadata instance

Anda dapat memperbarui metadata instance Agent Platform Workbench menggunakan konsol Google Cloud , Google Cloud CLI, Terraform, atau Notebooks API.

Konsol

Untuk mengupdate metadata instance Agent Platform Workbench, lakukan hal berikut:

1. Di konsol Google Cloud , buka halaman Instances.

   Buka Instances

2. Dalam daftar instance, klik nama instance yang ingin Anda perbarui.

3. Di halaman Instance details, klik Software and security.

4. Di bagian Metadata, perbarui key-value pair metadata yang ingin Anda ubah.

5. Klik Kirim.

gcloud

Anda dapat mengupdate metadata di instance Agent Platform Workbench menggunakan perintah berikut:

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

Terraform

Anda dapat mengubah key-value pair metadata untuk mengelola fitur yang sesuai di instance Agent Platform Workbench.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar 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

Gunakan metode instances.patch dengan nilai metadata dan gce_setup.metadata di updateMask untuk mengelola fitur yang sesuai.

Menghapus metadata dari instance

Anda dapat menghapus metadata dari instance Agent Platform Workbench menggunakan konsol Google Cloud , Google Cloud CLI, Terraform, atau Notebooks API.

Konsol

Untuk menghapus metadata dari instance Agent Platform Workbench, lakukan hal berikut:

1. Di konsol Google Cloud , buka halaman Instances.

   Buka Instances

2. Dalam daftar instance, klik nama instance yang ingin Anda ubah.

3. Di halaman Instance details, klik Software and security.

4. Di bagian Metadata, di sebelah kanan key-value pair yang ingin Anda hapus, klik  Delete.

5. Klik Kirim.

gcloud

Anda dapat menghapus metadata dari instance Agent Platform Workbench menggunakan perintah berikut:

gcloud workbench instances update INSTANCE_NAME --metadata=KEY

Terraform

Anda dapat menghapus key-value pair metadata untuk mengelola fitur yang sesuai dari instance Agent Platform Workbench.

Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar 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

Gunakan metode instances.patch dengan nilai metadata yang ditetapkan ke string kosong dan gce_setup.metadata di updateMask untuk menghapus fitur yang sesuai.