Mengelola fitur melalui metadata

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

Kunci metadata

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

Fitur	Deskripsi	Kunci metadata	Nilai dan default yang diterima
Mengaktifkan Cloud Storage FUSE pada image container	Memasang /dev/fuse ke container dan mengaktifkan gcsfuse untuk digunakan di 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.
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 defaultnya 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 instance. Tindakan ini mengaktifkan layanan upgrade tanpa pengawasan 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, Anda dapat mengubah direktori ke /home/CUSTOM_NAME dan bukan direktori /home/jupyter/ default. Kunci metadata ini tidak memengaruhi akses ke instance.	jupyter-user	String. Nilai defaultnya adalah jupyter.
Download 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 unix-cron format, misalnya, 00 19 * * MON berarti setiap minggu pada hari Senin, pada pukul 1900 Waktu Greenwich (GMT). Fitur ini dinonaktifkan secara default.
Skrip pasca-startup	Menjalankan skrip kustom setelah skrip startup lainnya selesai. Untuk mengetahui detail 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 bagaimana skrip pasca-startup berjalan.	post-startup-script-behavior	run_once (default): Menjalankan skrip pasca-startup satu kali setelah pembuatan atau upgrade instance. run_every_start: Menjalankan skrip pasca-startup setelah setiap memulai. download_and_run_every_start: Mendownload ulang skrip pasca-startup dari sumbernya, lalu menjalankan skrip setelah setiap memulai.
Laporkan kondisi peristiwa	Memeriksa kondisi 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	Mengaktifkan JupyterLab 3. JupyterLab 4 diaktifkan secara default.	enable-jupyterlab4	true (default): Mengaktifkan JupyterLab 4. false: Mengaktifkan JupyterLab 3.

Urutan eksekusi skrip startup

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

1. startup-script: Berjalan pertama selama setiap booting setelah booting awal.
2. startup-script-url: Berjalan kedua selama 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 memberikan skrip sebagai Cloud Storage URI. Anda tidak dapat memberikan konten skrip secara langsung sebagai nilai.

Metadata yang dikelola oleh Compute Engine

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

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 Google Cloud konsol, 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 instances.create metode dengan nilai metadata untuk mengelola fitur yang sesuai.

Memperbarui metadata instance

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

Konsol

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

1. Di Google Cloud konsol, buka halaman Instances.

   Buka Instance

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 Submit.

gcloud

Anda dapat memperbarui metadata pada 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 pada 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 instances.patch metode 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 Google Cloud konsol, Google Cloud CLI, Terraform, atau Notebooks API.

Konsol

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

1. Di Google Cloud konsol, buka halaman Instances.

   Buka Instance

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 Submit.

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 instances.patch metode dengan nilai metadata yang ditetapkan ke string kosong dan gce_setup.metadata di updateMask untuk menghapus fitur yang sesuai.