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.
Dataproc	Habilita el acceso a los kernels de Dataproc. Si deseas obtener más información, consulta Crea una instancia con Dataproc habilitado.	`disable-mixer`	`true`: Desactiva el acceso a los kernels de Dataproc. `false` (predeterminado): Habilita el acceso a los kernels de Dataproc.
Cierre inactivo	Habilita el cierre inactivo. Para obtener más información, consulta Cierre inactivo.	`idle-timeout-seconds`	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.

Botón Agregar metadatos de la sección Entorno

gcloud

Cuando creas una instancia de Vertex AI Workbench, puedes agregar metadatos a través del siguiente comando.

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

Terraform

Para agregar metadatos, crea el recurso con pares clave-valor de metadatos.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de 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"
    }
  }
}

API de Notebooks

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.

Ejemplos de campos de clave y valor de metadatos

gcloud

Puedes actualizar los metadatos en una instancia de Vertex AI Workbench con el siguiente comando.

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

Terraform

Puedes cambiar los pares clave-valor de metadatos para administrar los atributos correspondientes en las instancias de Vertex AI Workbench.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de 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"
    }
  }
}

API de Notebooks

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.

Ejemplo de campos de clave y valor de metadatos durante una actualización

gcloud

Puedes quitar los metadatos de una instancia de Vertex AI Workbench con el siguiente comando.

gcloud workbench instances update INSTANCE_NAME --metadata=KEY=

Terraform

Puedes quitar pares clave-valor de metadatos para administrar los atributos correspondientes de una instancia de Vertex AI Workbench.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de 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 = {
    }
  }
}

API de Notebooks

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.