Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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.
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.
gcloud
Wenn Sie eine Vertex AI Workbench-Instanz erstellen, können Sie mit dem folgenden Befehl Metadaten hinzufügen.
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.
gcloud
Sie können die Metadaten auf einer Vertex AI Workbench-Instanz mit dem folgenden Befehl aktualisieren.
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.
gcloud
Mit dem folgenden Befehl können Sie Metadaten aus einer Vertex AI Workbench-Instanz entfernen.
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.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2024-09-03 (UTC)."],[],[],null,["# Manage features through metadata\n================================\n\nThis page describes how to manage some Vertex AI Workbench instance features\nby modifying the instance's metadata key-value pairs.\n\nMetadata keys\n-------------\n\nFor information about features and their respective metadata keys,\nsee the following table.\n\nMetadata managed by Compute Engine\n----------------------------------\n\nSome of the metadata keys are predefined by Compute Engine. For more\ninformation, see\n[Predefined metadata\nkeys](/compute/docs/metadata/predefined-metadata-keys).\n\nProtected metadata keys\n-----------------------\n\nSome metadata keys are reserved for system use only. If you assign\nvalues to these metadata keys, the new values will be overwritten by the\nsystem values.\n\nReserved metadata keys include and are not limited to:\n\n- `data-disk-uri`\n- `enable-oslogin`\n- `framework`\n- `notebooks-api`\n- `notebooks-api-version`\n- `nvidia-driver-gcs-path`\n- `proxy-url`\n- `restriction`\n- `shutdown-script`\n- `title`\n- `version`\n\nCreate an instance with specific metadata\n-----------------------------------------\n\nYou can create a Vertex AI Workbench instance with specific metadata\nby using the Google Cloud console, the Google Cloud CLI,\nTerraform, or the Notebooks API. \n\n### Console\n\nWhen you create a Vertex AI Workbench instance, you can add\nmetadata in the **Environment** section of **Advanced options**.\n\n### gcloud\n\nWhen you create a Vertex AI Workbench instance, you can add\nmetadata by using the following command: \n\n```bash\ngcloud workbench instances create INSTANCE_NAME --metadata=KEY=VALUE\n```\n\n### Terraform\n\nTo add metadata, create the resource with metadata key-value pairs.\n\n\u003cbr /\u003e\n\nTo learn how to apply or remove a Terraform configuration, see\n[Basic Terraform commands](/docs/terraform/basic-commands).\n\n\u003cbr /\u003e\n\n resource \"google_workbench_instance\" \"default\" {\n name = \"workbench-instance-example\"\n location = \"us-central1-a\"\n\n gce_setup {\n machine_type = \"n1-standard-1\"\n vm_image {\n project = \"cloud-notebooks-managed\"\n family = \"workbench-instances\"\n }\n metadata = {\n key = \"value\"\n }\n }\n }\n\n### Notebooks API\n\nUse the [`instances.create`](/vertex-ai/docs/workbench/reference/rest/v2/projects.locations.instances/create)\nmethod with metadata values to manage the corresponding features.\n\nUpdate an instance's metadata\n-----------------------------\n\nYou can update the metadata of a Vertex AI Workbench instance\nby using the Google Cloud console, the Google Cloud CLI,\nTerraform, or the Notebooks API. \n\n### Console\n\nTo update the metadata of a Vertex AI Workbench instance,\ndo the following:\n\n1. In the Google Cloud console, go to the **Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/vertex-ai/workbench/instances)\n2. In the list of instances, click the name of the instance that you want\n to update.\n\n3. On the **Instance details** page, click **Software and security**.\n\n4. In the **Metadata** section, update the metadata key-value pairs that\n you want to change.\n\n5. Click **Submit**.\n\n### gcloud\n\nYou can update the metadata on a Vertex AI Workbench instance\nby using the following command: \n\n```bash\ngcloud workbench instances update INSTANCE_NAME --metadata=KEY=VALUE\n```\n\n### Terraform\n\nYou can change the metadata key-value pairs to manage\nthe corresponding features on Vertex AI Workbench instances.\n\n\u003cbr /\u003e\n\nTo learn how to apply or remove a Terraform configuration, see\n[Basic Terraform commands](/docs/terraform/basic-commands).\n\n\u003cbr /\u003e\n\n resource \"google_workbench_instance\" \"default\" {\n name = \"workbench-instance-example\"\n location = \"us-central1-a\"\n\n gce_setup {\n machine_type = \"n1-standard-1\"\n vm_image {\n project = \"cloud-notebooks-managed\"\n family = \"workbench-instances\"\n }\n metadata = {\n key = \"updated_value\"\n }\n }\n }\n\n### Notebooks API\n\nUse the [`instances.patch`](/vertex-ai/docs/workbench/reference/rest/v2/projects.locations.instances/patch)\nmethod with metadata values and `gce_setup.metadata` in the `updateMask`\nto manage the corresponding features.\n\nRemove metadata from an instance\n--------------------------------\n\nYou can remove metadata from a Vertex AI Workbench instance\nby using the Google Cloud console, the Google Cloud CLI,\nTerraform, or the Notebooks API. \n\n### Console\n\nTo remove metadata from a Vertex AI Workbench instance,\ndo the following:\n\n1. In the Google Cloud console, go to the **Instances** page.\n\n [Go to Instances](https://console.cloud.google.com/vertex-ai/workbench/instances)\n2. In the list of instances, click the name of the instance that you want\n to modify.\n\n3. On the **Instance details** page, click **Software and security**.\n\n4. In the **Metadata** section, to the right of a key-value pair that\n you want to delete, click\n delete **Delete**.\n\n5. Click **Submit**.\n\n### gcloud\n\nYou can remove metadata from a Vertex AI Workbench instance\nby using the following command: \n\n```bash\ngcloud workbench instances update INSTANCE_NAME --metadata=KEY\n```\n\n### Terraform\n\nYou can remove metadata key-value pairs to manage the\ncorresponding features of a Vertex AI Workbench instance.\n\n\u003cbr /\u003e\n\nTo learn how to apply or remove a Terraform configuration, see\n[Basic Terraform commands](/docs/terraform/basic-commands).\n\n\u003cbr /\u003e\n\n resource \"google_workbench_instance\" \"default\" {\n name = \"workbench-instance-example\"\n location = \"us-central1-a\"\n\n gce_setup {\n machine_type = \"n1-standard-1\"\n vm_image {\n project = \"cloud-notebooks-managed\"\n family = \"workbench-instances\"\n }\n metadata = {\n }\n }\n }\n\n### Notebooks API\n\nUse the [`instances.patch`](/vertex-ai/docs/workbench/reference/rest/v2/projects.locations.instances/patch)\nmethod with the metadata value set to an empty string and\n`gce_setup.metadata` in the `updateMask` to remove the\ncorresponding feature."]]
