Funktionen über Metadaten verwalten

Auf dieser Seite wird beschrieben, wie Sie einige Features einer Gemini Enterprise Agent Platform 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
Aktiviert Cloud Storage FUSE in einem Container-Image	/dev/fuse wird im Container bereitgestellt und gcsfuse für die Verwendung im Container aktiviert	container-allow-fuse	true: Aktiviert Cloud Storage FUSE false (Standardeinstellung): Cloud Storage FUSE ist nicht aktiviert
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.
Managed Service for Apache Spark	Ermöglicht den Zugriff auf Managed Service for Apache Spark-Kernels. Weitere Informationen finden Sie unter Managed Service for Apache Spark-kompatible Instanz erstellen.	disable-mixer	true: Deaktiviert den Zugriff auf Managed Service for Apache Spark-Kernel. false (Standard): Ermöglicht den Zugriff auf Managed Service for Apache Spark-Kernels.
BigQuery	Aktiviert das BigQuery JupyterLab-Plug-in, das einen Dataset-Explorer, einen SQL-Abfrageeditor und einen Abfrageverlauf in JupyterLab bereitstellt.	disable-bigquery	true: Deaktiviert das BigQuery JupyterLab-Plug-in. false (Standardeinstellung): Aktiviert das BigQuery JupyterLab-Plug-in.
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).
Gastattribute	Aktiviert Gastattribute. Erforderlich für das Herunterfahren bei Inaktivität. Weitere Informationen finden Sie unter Anforderungen für das Herunterfahren bei Inaktivität.	enable-guest-attributes	true (Standard): Aktiviert Gastattribute. false: Deaktiviert Gastattribute.
Geplante Betriebssystem-Patches	Plant automatische Betriebssystemupdates der Instanz. Aktiviert den unattended upgrade service von Debian. Diese Option gilt nur für VM-basierte Images.	install-unattended-upgrades	true: Aktiviert automatische Betriebssystemupdates false (Standardeinstellung): Deaktiviert automatische Betriebssystemupdates
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. Wenn Sie diese Funktion deaktivieren oder deaktiviert lassen möchten, lassen Sie den Metadatenschlüssel notebook-upgrade-schedule in Ihrer Konfiguration weg oder setzen Sie seinen Wert auf einen leeren String ("").
Post-Startskript	Führt ein benutzerdefiniertes Skript aus, nachdem andere Startskripts abgeschlossen wurden. Weitere Informationen zur Ausführungsreihenfolge finden Sie unter Ausführungsreihenfolge von Startskripts.	post-startup-script	Der URI eines Startscripts 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 Startscript nach dem Start ausgeführt wird.	post-startup-script-behavior	run_once (Standard): Das Post-Startscript wird nach der Instanzerstellung oder dem Upgrade einmal ausgeführt. run_every_start: Führt das Startscript nach jedem Start aus. 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.
JupyterLab 4 aktivieren oder zu JupyterLab 3 wechseln	Aktivieren Sie JupyterLab 3. JupyterLab 4 ist standardmäßig aktiviert.	enable-jupyterlab4	true (Standard): JupyterLab 4 wird aktiviert. false: Aktiviert JupyterLab 3.
Antigravity CLI	Aktiviert die Antigravity-Befehlszeile mit der Launcher-Kachel, den Notebook-Skills, dem Plug-in und der %%agy-Zellenmagie auf Instanzen, die ein Debian 12-Image (workbench-instances-2603) oder höher verwenden. Die Instanz wendet den Wert beim Start an.	enable-antigravity	true (Standard für neue Instanzen): Aktiviert die Antigravity CLI. false: Deaktiviert die Antigravity CLI.

Ausführungsreihenfolge von Startskripts

Wenn Sie mehrere Startscripts für Ihre Agent Platform Workbench-Instanz verwenden, werden sie in der folgenden Reihenfolge ausgeführt:

1. startup-script: Wird nach dem ersten Bootvorgang bei jedem Bootvorgang zuerst ausgeführt.
2. startup-script-url: Wird nach dem ersten Bootvorgang bei jedem Bootvorgang als Zweites ausgeführt.
3. workbench-startup-scripts: Wird nach Abschluss der Compute Engine-Bootscripts (startup-script und startup-script-url) ausgeführt.
4. post-startup-script: Wird nach Abschluss der workbench-startup-scripts ausgeführt.

Beachten Sie, dass Sie für den Metadatenschlüssel post-startup-script das Script als Cloud Storage-URI angeben müssen. Sie können den Skriptinhalt nicht direkt als Wert angeben.

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:

• 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

Instanz mit bestimmten Metadaten erstellen

Sie können eine Agent Platform Workbench-Instanz mit bestimmten Metadaten über die Google Cloud Console, die Google Cloud CLI, Terraform oder die Notebooks API erstellen.

Console

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

gcloud

Wenn Sie eine Agent Platform 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 Agent Platform Workbench-Instanz mithilfe der Google Cloud Console, der Google Cloud CLI, Terraform oder der Notebooks API aktualisieren.

Console

So aktualisieren Sie die Metadaten einer Agent Platform Workbench-Instanz:

1. Rufen Sie in der Google Cloud Console die Seite Instanzen auf.

   Zur Seite „VM-Instanzen“

2. Klicken Sie in der Liste der Instanzen auf den Namen der Instanz, die Sie aktualisieren möchten.

3. Klicken Sie auf der Seite Instanzdetails auf Software und Sicherheit.

4. Aktualisieren Sie im Abschnitt Metadaten die Metadaten-Schlüssel/Wert-Paare, die Sie ändern möchten.

5. Klicken Sie auf Senden.

gcloud

Sie können die Metadaten auf einer Agent Platform 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 Agent Platform 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 Agent Platform Workbench-Instanz mithilfe der Google Cloud Console, der Google Cloud CLI, Terraform oder der Notebooks API entfernen.

Console

So entfernen Sie Metadaten aus einer Agent Platform Workbench-Instanz:

1. Rufen Sie in der Google Cloud Console die Seite Instanzen auf.

   Zur Seite „VM-Instanzen“

2. Klicken Sie in der Liste der Instanzen auf den Namen der Instanz, die Sie ändern möchten.

3. Klicken Sie auf der Seite Instanzdetails auf Software und Sicherheit.

4. Klicken Sie im Abschnitt Metadaten rechts neben dem Schlüssel/Wert-Paar, das Sie löschen möchten, auf  Löschen.

5. Klicken Sie auf Senden.

gcloud

Mit dem folgenden Befehl können Sie Metadaten aus einer Agent Platform 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 Agent Platform 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.