Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Administrar atributos a través de metadatos
En esta página, se describe cómo administrar algunas funciones de la instancia de Vertex AI Workbench mediante la modificación de los pares clave-valor de metadatos de la instancia.
Claves de metadatos
Para obtener información sobre las funciones y sus respectivas claves de metadatos, consulta la siguiente tabla.
Función
Descripción
Clave de metadatos
Valores predeterminados y valores aceptados
nbconvert
Te permite exportar y descargar notebooks como un tipo de archivo diferente.
notebook-disable-nbconvert
true: Desactiva nbconvert.
false (predeterminado): habilita nbconvert.
Enviar a la papelera
Usa el comportamiento de la papelera del sistema operativo cuando se borra de JupyterLab.
notebook-enable-delete-to-trash
true: habilita la eliminación a la papelera.
false (predeterminado): Usa el comportamiento predeterminado de JupyterLab.
Un número entero que representa el tiempo de inactividad en segundos. El valor predeterminado es de 10800 segundos (180 minutos).
Usuario de Jupyter personalizado
Especifica el nombre del usuario predeterminado de Jupyter. Este parámetro de configuración determina el nombre de la carpeta de tus notebooks. Por ejemplo, en lugar del directorio /home/jupyter/ predeterminado, puedes cambiarlo a /home/CUSTOM_NAME.
Esta clave de metadatos no afecta el acceso a la instancia.
jupyter-user
Una string. El valor predeterminado es jupyter.
Descarga de archivos
Te permite descargar archivos de JupyterLab.
notebook-disable-downloads
true: Desactiva la descarga de archivos.
false (predeterminado): habilita la descarga de archivos.
Acceso raíz
Habilita el acceso raíz.
notebook-disable-root
true: Desactiva el acceso raíz.
false (predeterminado): habilita el acceso raíz.
Acceso a la terminal
Habilita el acceso a la terminal.
notebook-disable-terminal
true: Desactiva el acceso a la terminal.
false (predeterminado): Habilita el acceso a la terminal.
Actualizaciones programadas
Programa actualizaciones automáticas de la instancia.
notebook-upgrade-schedule
La programación semanal o mensual que establezcas, en formato unix-cron, por ejemplo, 00 19 * * MON significa semanalmente el lunes, a las 1900 horas, hora del meridiano de Greenwich (GMT).
Esta función se encuentra desactivada de forma predeterminada.
Secuencia de comandos posterior al inicio
Ejecuta una secuencia de comandos personalizada después del inicio.
post-startup-script
El URI de una secuencia de comandos posterior al inicio en Cloud Storage, por ejemplo: gs://bucket/hello.sh. Esta función se encuentra desactivada de forma predeterminada.
Comportamiento de secuencia de comandos posterior al inicio
Define cuándo y cómo se ejecuta la secuencia de comandos posterior al inicio.
post-startup-script-behavior
run_once (predeterminado): Ejecuta la secuencia de comandos posterior al inicio una vez que se crea o actualiza la instancia.
run_every_start: Ejecuta la secuencia de comandos posterior al inicio después de cada inicio.
download_and_run_every_start: Vuelve a descargar la secuencia de comandos posterior al inicio desde su fuente y, luego, la ejecuta después de cada inicio.
Informar el estado del evento
Verifica el estado cada 30 segundos para las métricas de VM.
report-event-health
true (predeterminado): Habilita los informes de estado de los eventos.
false: Desactiva los informes de estado de eventos.
Metadatos administrados por Compute Engine
Compute Engine predefine algunas de las claves de metadatos. Para obtener más información, consulta Claves de metadatos predefinidas.
Claves de metadatos protegidas
Algunas claves de metadatos, incluida, están reservadas para su uso exclusivo en el sistema. Si asignas valores a estas claves de metadatos, los valores del sistema reemplazarán los valores nuevos.
Las claves de metadatos reservados incluyen, entre otras, las siguientes:
data-disk-uri
enable-oslogin
framework
notebooks-api
notebooks-api-version
nvidia-driver-gcs-path
proxy-url
restriction
shutdown-script
title
version
Crear una instancia con metadatos específicos
Puedes crear una instancia de Vertex AI Workbench con metadatos específicos a través de la consola de Google Cloud, Google Cloud CLI, Terraform o la API de Notebooks:
Console
Cuando creas una instancia de Vertex AI Workbench, puedes agregar metadatos en la sección Entorno de la sección de Opciones avanzadas.
gcloud
Cuando creas una instancia de Vertex AI Workbench, puedes agregar metadatos a través del siguiente comando.
Usa el método instances.create con valores de metadatos para administrar los atributos correspondientes.
Actualiza los metadatos de una instancia
Puedes actualizar los metadatos de una instancia de Vertex AI Workbench mediante la consola de Google Cloud, Google Cloud CLI, Terraform o la API de Notebooks.
Console
Puedes actualizar los metadatos de una instancia de Vertex AI Workbench en la sección Software y seguridad de la página Detalles.
gcloud
Puedes actualizar los metadatos en una instancia de Vertex AI Workbench con el siguiente comando.
Usa el método instances.patch con valores de metadatos y gce_setup.metadata en updateMask para administrar los atributos correspondientes.
Quita metadatos de una instancia
Puedes quitar metadatos de una instancia de Vertex AI Workbench mediante la consola de Google Cloud, Google Cloud CLI, Terraform o la API de Notebooks.
Console
Puedes quitar metadatos de una instancia de Vertex AI Workbench en la sección Software y seguridad de la página Detalles.
gcloud
Puedes quitar los metadatos de una instancia de Vertex AI Workbench con el siguiente comando.
Usa el método instances.patch con el valor de metadatos establecido en una string vacía y gce_setup.metadata en el updateMask para quitar el atributo correspondiente.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2024-09-05 (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."]]
