Esta página se ha traducido con Cloud Translation API.

Gestionar funciones mediante metadatos

En esta página se describe cómo gestionar algunas funciones de las instancias de Vertex AI Workbench modificando los pares clave-valor de los 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 aceptados y predeterminados
Habilita Cloud Storage FUSE en una imagen de contenedor.	Monta `/dev/fuse` en el contenedor y habilita `gcsfuse` para usarlo en el contenedor.	`container-allow-fuse`	`true`: habilita Cloud Storage FUSE. `false` (predeterminado): no habilita Cloud Storage FUSE.
nbconvert	Te permite exportar y descargar cuadernos como un tipo de archivo diferente.	`notebook-disable-nbconvert`	`true`: desactiva nbconvert. `false` (valor predeterminado): habilita nbconvert.
Eliminar y enviar a la papelera	Usa el comportamiento de la papelera del sistema operativo al eliminar elementos de JupyterLab.	`notebook-enable-delete-to-trash`	`true`: habilita la eliminación en la papelera. `false` (predeterminado): usa el comportamiento predeterminado de JupyterLab.
Dataproc	Habilita el acceso a los kernels de Dataproc. Para obtener más información, consulta Crear una instancia con Dataproc.	`disable-mixer`	`true`: desactiva el acceso a los kernels de Dataproc. `false` (valor predeterminado): habilita el acceso a los kernels de Dataproc.
Apagado por inactividad	Habilita el apagado por inactividad. Para obtener más información, consulta Cierre por inactividad.	`idle-timeout-seconds`	Número entero que representa el tiempo de inactividad en segundos. El valor predeterminado es `10800` segundos (180 minutos).
Atributos de huésped	Habilita los atributos de invitado. Obligatorio para ejecutar el cierre por inactividad. Para obtener más información, consulta los requisitos para ejecutar el cierre por inactividad.	`enable-guest-attributes`	`true` (valor predeterminado): habilita los atributos de invitado. `false`: desactiva los atributos de huésped.
Parches de SO programados	Programa las actualizaciones automáticas del SO de la instancia. De esta forma, se habilita el servicio de actualización automática de Debian y solo se aplica a las imágenes basadas en máquinas virtuales.	`install-unattended-upgrades`	`true`: activa las actualizaciones automáticas del SO. `false` (opción predeterminada): desactiva las actualizaciones automáticas del SO.
Usuario de Jupyter personalizado	Especifica el nombre del usuario de Jupyter predeterminado. Este ajuste determina el nombre de la carpeta de tus cuadernos. Por ejemplo, en lugar del directorio `/home/jupyter/` predeterminado, puedes cambiarlo a `/home/CUSTOM_NAME`. Esta clave de metadatos no afecta al acceso a la instancia.	`jupyter-user`	Se trata de una cadena. El valor predeterminado es `jupyter`.
Descargando archivo	Te permite descargar archivos de JupyterLab.	`notebook-disable-downloads`	`true`: desactiva la descarga de archivos. `false` (valor predeterminado): habilita la descarga de archivos.
Acceso root	Habilita el acceso de superusuario.	`notebook-disable-root`	`true`: desactiva el acceso de superusuario. `false` (valor predeterminado): habilita el acceso de administrador.
Acceso al terminal	Habilita el acceso al terminal.	`notebook-disable-terminal`	`true`: desactiva el acceso a la terminal. `false` (valor predeterminado): habilita el acceso al terminal.
Actualizaciones programadas	Programa las actualizaciones automáticas de la instancia.	`notebook-upgrade-schedule`	La programación semanal o mensual que hayas definido en formato cron para UNIX. Por ejemplo, `00 19 * * MON` significa semanalmente los lunes a las 19:00 (GMT). Esta función está desactivada de forma predeterminada.
Secuencia de comandos tras el 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 está desactivada de forma predeterminada.
Comportamiento de la secuencia de comandos tras el inicio	Define cuándo y cómo se ejecuta la secuencia de comandos posterior al inicio.	`post-startup-script-behavior`	`run_once` (valor predeterminado): ejecuta la secuencia de comandos posterior al inicio una vez después de crear o actualizar 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, a continuación, la ejecuta después de cada inicio.
Informar del estado de los eventos	Comprueba 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 los eventos.
Habilitar la vista previa de JupyterLab 4	Habilita JupyterLab 4 (vista previa) en tu instancia. Para obtener más información, consulta la vista previa de JupyterLab 4.	`enable-jupyterlab4-preview`	`true`: habilita JupyterLab 4. `false` (predeterminado): habilita JupyterLab 3.

Metadatos gestionados por Compute Engine

Compute Engine predefine algunas de las claves de metadatos. Para obtener más información, consulta las claves de metadatos predefinidas.

Claves de metadatos protegidas

Algunas claves de metadatos están reservadas para uso exclusivo del sistema. Si asignas valores a estas claves de metadatos, los valores del sistema sobrescribirán los nuevos.

Estas son algunas de las claves de metadatos reservadas:

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 mediante la Google Cloud consola, la CLI de Google Cloud, Terraform o la API Notebooks.

Consola

Cuando creas una instancia de Vertex AI Workbench, puedes añadir metadatos en la sección Entorno de Opciones avanzadas.

El botón Añadir metadatos de la sección Entorno

gcloud

Cuando creas una instancia de Vertex AI Workbench, puedes añadir metadatos con el siguiente comando:

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

Terraform

Para añadir metadatos, cree el recurso con pares clave-valor de metadatos.

Para saber cómo aplicar o quitar una configuración de Terraform, consulta 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 gestionar las funciones correspondientes.

Actualizar los metadatos de una instancia

Puedes actualizar los metadatos de una instancia de Vertex AI Workbench mediante la consola, la CLI de Google Cloud, Terraform o la API Notebooks. Google Cloud

Consola

Para actualizar los metadatos de una instancia de Vertex AI Workbench, sigue estos pasos:

En la consola, ve a la página Instancias. Google Cloud

Ir a Instancias
En la lista de instancias, haz clic en el nombre de la instancia que quieras actualizar.
En la página Detalles de la instancia, haz clic en Software y seguridad.
En la sección Metadatos, actualice los pares clave-valor de los metadatos que quiera cambiar.
Haz clic en Enviar.

gcloud

Para actualizar los metadatos de una instancia de Vertex AI Workbench, usa el siguiente comando:

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

Terraform

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

Para saber cómo aplicar o quitar una configuración de Terraform, consulta 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 gestionar las funciones correspondientes.

Eliminar metadatos de una instancia

Puedes quitar metadatos de una instancia de Vertex AI Workbench mediante la Google Cloud consola, la CLI de Google Cloud, Terraform o la API Notebooks.

Consola

Para quitar metadatos de una instancia de Vertex AI Workbench, sigue estos pasos:

En la consola, ve a la página Instancias. Google Cloud

Ir a Instancias
En la lista de instancias, haga clic en el nombre de la instancia que quiera modificar.
En la página Detalles de la instancia, haz clic en Software y seguridad.
En la sección Metadatos, a la derecha del par clave-valor que quieras eliminar, haz clic en Eliminar.
Haz clic en Enviar.

gcloud

Para quitar metadatos de una instancia de Vertex AI Workbench, usa el siguiente comando:

gcloud workbench instances update INSTANCE_NAME --metadata=KEY

Terraform

Puede quitar pares clave-valor de metadatos para gestionar las funciones correspondientes de una instancia de Vertex AI Workbench.

Para saber cómo aplicar o quitar una configuración de Terraform, consulta 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 definido como una cadena vacía y gce_setup.metadata en updateMask para quitar la función correspondiente.