Funktionen über Metadaten verwalten

Auf dieser Seite wird beschrieben, wie Sie einige Features einer Vertex AI Workbench-Instanz verwalten, indem Sie die Metadaten-Schlüssel/Wert-Paare der Instanz ändern.

Metadatenschlüssel

Informationen zu den Funktionen und ihren jeweiligen Metadatenschlüsseln finden Sie in der folgenden Tabelle.

Funktion	Beschreibung	Metadatenschlüssel	Gültige Werte und Standardeinstellungen
nbconvert	Hiermit können Sie Notebooks als anderen Dateityp exportieren und herunterladen.	`notebook-disable-nbconvert`	`true`: Deaktiviert nbconvert. `false` (Standard): Aktiviert nbconvert.
Über Papierkorb löschen	Verwendet das Papierkorbverhalten des Betriebssystems beim Löschen aus JupyterLab.	`notebook-enable-delete-to-trash`	`true`: aktiviert das Löschen im Papierkorb. `false` (Standardeinstellung): Es wird das Standardverhalten von JupyterLab verwendet.
Dataproc	Ermöglicht den Zugriff auf Dataproc-Kernels. Weitere Informationen finden Sie unter Dataproc-kompatible Instanz erstellen.	`disable-mixer`	`true`: Deaktiviert den Zugriff auf Dataproc-Kernel. `false` (Standard): Ermöglicht den Zugriff auf Dataproc-Kernels.
Herunterfahren bei Inaktivität	Ermöglicht das Herunterfahren bei Inaktivität. Weitere Informationen finden Sie unter Herunterfahren bei Inaktivität.	`idle-timeout-seconds`	Eine Ganzzahl, die die Inaktivitätszeit in Sekunden darstellt. Der Standardwert beträgt `10800` Sekunden (180 Minuten).
Benutzerdefinierter Jupyter-Nutzer	Gibt den Namen des Jupyter-Standardnutzers an. Diese Einstellung bestimmt den Namen des Ordners für Ihre Notebooks. Anstelle des Standardverzeichnisses `/home/jupyter/` können Sie das Verzeichnis beispielsweise in `/home/CUSTOM_NAME` ändern. Dieser Metadatenschlüssel hat keinen Einfluss auf den Zugriff auf die Instanz.	`jupyter-user`	Ein String. Der Standardwert ist `jupyter`.
Download von Dateien	Ermöglicht das Herunterladen von Dateien aus JupyterLab.	`notebook-disable-downloads`	`true`: Deaktiviert den Dateidownload. `false` (Standard): Der Dateidownload wird aktiviert.
Root-Zugriff	Aktiviert den Root-Zugriff.	`notebook-disable-root`	`true`: Deaktiviert den Root-Zugriff. `false` (Standard): Aktiviert den Root-Zugriff.
Terminalzugriff	Aktiviert den Terminalzugriff.	`notebook-disable-terminal`	`true`: Deaktiviert den Terminalzugriff. `false` (Standard): Aktiviert den Terminalzugriff.
Geplante Upgrades	Plant automatische Upgrades der Instanz.	`notebook-upgrade-schedule`	Der von Ihnen festgelegte wöchentliche oder monatliche Zeitplan im Unix-Cron-Format, z. B. `00 19 * * MON` bedeutet wöchentlich am Montag, um 19:00 Uhr Greenwich Mean Time (GMT). Diese Funktion ist standardmäßig deaktiviert.
Post-Startskript	Führt nach dem Start ein benutzerdefiniertes Skript aus.	`post-startup-script`	Der URI eines Scripts nach dem Start in Cloud Storage, z. B.: `gs://bucket/hello.sh`. Diese Funktion ist standardmäßig deaktiviert.
Verhalten des Post-Startscripts	Hier wird festgelegt, wann und wie das Script nach dem Start ausgeführt wird.	`post-startup-script-behavior`	`run_once` (Standard): Das Post-Start-Script wird nach der Instanzerstellung oder dem Upgrade einmal ausgeführt. `run_every_start`: Das Post-Start-Script wird nach jedem Start ausgeführt. `download_and_run_every_start`: lädt das Post-Startscript aus seiner Quelle noch einmal herunter und führt das Script nach jedem Start aus.
Ereignisstatus melden	Prüft den Status alle 30 Sekunden auf VM-Messwerte.	`report-event-health`	`true` (Standard): Aktiviert die Berichterstellung zum Ereignisstatus. `false`: Deaktiviert die Berichte zur Ereignisintegrität.

Von Compute Engine verwaltete Metadaten

Einige Metadatenschlüssel sind von Compute Engine vordefiniert. Weitere Informationen finden Sie unter Vordefinierte Metadatenschlüssel .

Geschützte Metadatenschlüssel

Einige Metadatenschlüssel sind für die Verwendung durch das System reserviert. Wenn Sie diesen Metadatenschlüsseln Werte zuweisen, werden die neuen Werte von den Systemwerten überschrieben.

Zu den reservierten Metadatenschlüsseln gehören:

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

Instanz mit bestimmten Metadaten erstellen

Sie können eine Vertex AI Workbench-Instanz mit bestimmten Metadaten über die Google Cloud Console, die gcloud CLI, Terraform oder die Notebooks API erstellen:

Console

Wenn Sie eine Vertex AI Workbench-Instanz erstellen, können Sie unter Erweiterte Optionen im Abschnitt Umgebung Metadaten hinzufügen.

Schaltfläche "Metadaten hinzufügen" im Abschnitt "Umgebung"

gcloud

Wenn Sie eine Vertex AI Workbench-Instanz erstellen, können Sie mit dem folgenden Befehl Metadaten hinzufügen.

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

Terraform

Wenn Sie Metadaten hinzufügen möchten, erstellen Sie die Ressource mit Metadaten-Schlüssel/Wert-Paaren.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

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

Verwenden Sie die Methode instances.create mit Metadatenwerten, um die entsprechenden Funktionen zu verwalten.

Metadaten einer Instanz aktualisieren

Sie können die Metadaten einer Vertex AI Workbench-Instanz mithilfe der Google Cloud Console, der gcloud CLI, Terraform oder der Notebooks API aktualisieren:

Console

Sie können die Metadaten einer Vertex AI Workbench-Instanz auf der Seite Details im Abschnitt Software und Sicherheit aktualisieren.

Beispielfelder für Metadatenschlüssel und -werte

gcloud

Sie können die Metadaten auf einer Vertex AI Workbench-Instanz mit dem folgenden Befehl aktualisieren.

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

Terraform

Sie können die Metadaten-Schlüssel/Wert-Paare ändern, um die entsprechenden Features auf Vertex AI Workbench-Instanzen zu verwalten.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

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

Verwenden Sie die Methode instances.patch mit Metadatenwerten und gce_setup.metadata in updateMask, um die entsprechenden Funktionen zu verwalten.

Metadaten aus einer Instanz entfernen

Sie können Metadaten aus einer Vertex AI Workbench-Instanz mithilfe der Google Cloud Console, der gcloud CLI, Terraform oder der Notebooks API entfernen.

Console

Sie können Metadaten aus einer Vertex AI Workbench-Instanz im Abschnitt Software und Sicherheit auf der Seite Details entfernen.

Beispielfelder für Metadatenschlüssel und -werte während einer Aktualisierung

gcloud

Mit dem folgenden Befehl können Sie Metadaten aus einer Vertex AI Workbench-Instanz entfernen.

gcloud workbench instances update INSTANCE_NAME --metadata=KEY=

Terraform

Sie können Metadaten-Schlüssel/Wert-Paare entfernen, um die entsprechenden Features einer Vertex AI Workbench-Instanz zu verwalten.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

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

Verwenden Sie die Methode instances.patch, bei der der Metadatenwert auf einen leeren String festgelegt ist, und gce_setup.metadata in updateMask, um das entsprechende Feature zu entfernen.