Mengelola fitur melalui metadata

Halaman ini menjelaskan cara mengelola beberapa fitur instance Vertex AI Workbench dengan mengubah pasangan nilai kunci metadata instance.

Kunci metadata

Untuk 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 penampung dan mengaktifkan gcsfuse untuk digunakan di penampung.

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.
Menghapus 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.
Dataproc

Mengaktifkan akses ke kernel Dataproc.

Untuk mengetahui informasi selengkapnya, lihat Membuat instance yang mendukung Dataproc.

disable-mixer
  • true: Menonaktifkan akses ke kernel Dataproc.
  • false (default): Mengaktifkan akses ke kernel Dataproc.
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 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 akan 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 menjadi /home/CUSTOM_NAME, bukan direktori /home/jupyter/ default. Kunci metadata ini tidak memengaruhi akses ke instance.

    		jupyter-user String. Nilai defaultnya adalah jupyter.
    File sedang didownload

    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, pada pukul 19.00 Waktu Greenwich (GMT). Fitur ini dinonaktifkan secara default.
    Skrip pasca-startup

    Menjalankan skrip kustom setelah 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 sekali setelah pembuatan atau upgrade instance.
    • run_every_start: Menjalankan skrip pasca-startup setelah setiap mulai.
    • download_and_run_every_start: Mendownload ulang skrip pasca-startup dari sumbernya, lalu menjalankan skrip setelah setiap mulai.
    Melaporkan kondisi peristiwa

    Memeriksa status setiap 30 detik untuk metrik VM.

    		 report-event-health
    • true (default): Mengaktifkan pelaporan kondisi peristiwa.
    • false: Menonaktifkan pelaporan kondisi peristiwa.
    Mengaktifkan pratinjau JupyterLab 4

    Mengaktifkan JupyterLab 4 (Pratinjau) di instance Anda. Untuk informasi selengkapnya, lihat pratinjau JupyterLab 4.

    		enable-jupyterlab4-preview
    • true: Mengaktifkan JupyterLab 4.
    • false (default): Mengaktifkan JupyterLab 3.

    Metadata yang dikelola oleh Compute Engine

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

    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, tetapi tidak terbatas pada:

    • data-disk-uri
    • enable-oslogin
    • framework
    • notebooks-api
    • notebooks-api-version
    • nvidia-driver-gcs-path
    • proxy-url
    • restriction
    • shutdown-script
    • title
    • version

    Membuat instance dengan metadata tertentu

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

    Konsol

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

    Tombol Tambahkan metadata di bagian Lingkungan

    gcloud

    Saat membuat instance Vertex AI Workbench, Anda dapat menambahkan metadata menggunakan perintah berikut:

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

    Terraform

    Untuk menambahkan metadata, buat resource dengan pasangan nilai kunci 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 Vertex AI Workbench menggunakan konsol Google Cloud, Google Cloud CLI, Terraform, atau Notebooks API.

    Konsol

    Untuk memperbarui metadata instance Vertex AI Workbench, lakukan hal berikut:

    1. Di konsol Google Cloud, buka halaman Instance.

      Buka Instance

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

    3. Di halaman Detail instance, klik Software and security.

    4. Di bagian Metadata, perbarui pasangan nilai kunci metadata yang ingin Anda ubah.

    5. Klik Kirim.

    gcloud

    Anda dapat memperbarui metadata di instance Vertex AI Workbench menggunakan perintah berikut:

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

    Terraform

    Anda dapat mengubah pasangan nilai kunci metadata untuk mengelola fitur yang sesuai di instance Vertex AI 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 Vertex AI Workbench menggunakan Konsol Google Cloud, Google Cloud CLI, Terraform, atau Notebooks API.

    Konsol

    Untuk menghapus metadata dari instance Vertex AI Workbench, lakukan langkah berikut:

    1. Di konsol Google Cloud, buka halaman Instance.

      Buka Instance

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

    3. Di halaman Detail instance, klik Software and security.

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

    5. Klik Kirim.

    gcloud

    Anda dapat menghapus metadata dari instance Vertex AI Workbench menggunakan perintah berikut:

    gcloud workbench instances update INSTANCE_NAME --metadata=KEY

    Terraform

    Anda dapat menghapus key-value pair metadata untuk mengelola fitur terkait instance Vertex AI 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.