Gestisci le funzionalità tramite i metadati

Questa pagina descrive come gestire alcune funzionalità delle istanze di Vertex AI Workbench modificando le coppie chiave-valore dei metadati dell'istanza.

Chiavi dei metadati

Per informazioni sulle caratteristiche e sulle rispettive chiavi di metadati, consulta la tabella seguente.

Funzionalità Descrizione Chiave dei metadati Valori e valori predefiniti accettati
nbconvert

Consente di esportare e scaricare i blocchi note come tipo di file diverso.

 notebook-disable-nbconvert
  • true: disattiva nbconvert.
  • false (predefinito): attiva nbconvert.
Elimina nel cestino

Utilizza il comportamento del cestino del sistema operativo quando eliminazione da JupyterLab.

notebook-enable-delete-to-trash
  • true: attiva l'eliminazione nel cestino.
  • false (predefinito): utilizza il comportamento JupyterLab predefinito.
Dataproc

Abilita l'accesso ai kernel Dataproc.

Per ulteriori informazioni, vedi Crea abilitata per Dataproc.

disable-mixer
  • true: disattiva l'accesso ai kernel Dataproc.
  • false (predefinito): abilita l'accesso ai kernel Dataproc.
Arresto per inattività

Abilita l'arresto per inattività.

Per ulteriori informazioni, vedi Arresto per inattività.

idle-timeout-seconds Un numero intero che rappresenta il tempo di inattività in secondi. Il valore predefinito è di 10800 secondi (180 minuti).
Utente Jupyter personalizzato

Specifica il nome dell'utente Jupyter predefinito. Questa impostazione determina il nome della cartella dei blocchi note. Ad esempio: anziché la directory /home/jupyter/ predefinita, può cambiare la directory in /home/CUSTOM_NAME. Questa chiave di metadati non influisce sull'accesso all'istanza.

jupyter-user Una stringa. Il valore predefinito è jupyter.
Download del file

Consente di scaricare file da JupyterLab.

 notebook-disable-downloads
  • true: disattiva il download dei file.
  • false (predefinito): consente il download dei file.
Accesso root

Abilita l'accesso root.

 notebook-disable-root
  • true: disattiva l'accesso root.
  • false (predefinito): abilita l'accesso root.
Accesso al terminale

Consente l'accesso al terminale.

 notebook-disable-terminal
  • true: disattiva l'accesso al terminale.
  • false (predefinito): attiva l'accesso al terminale.
Upgrade pianificati

Pianifica gli upgrade automatici dell'istanza.

 notebook-upgrade-schedule La programmazione settimanale o mensile che imposti, unix-cron , ad esempio 00 19 * * MON significa "settimanale Lunedì alle 19:00 del fuso orario di Greenwich (GMT). Questa funzionalità è disattivata per impostazione predefinita.
Script post-avvio

Esegue uno script personalizzato dopo l'avvio.

 post-startup-script L'URI di uno script post-avvio in Cloud Storage, ad esempio: gs://bucket/hello.sh. Questa funzionalità è disattivata per impostazione predefinita.
Comportamento dello script post-avvio

Definisce quando e come viene eseguito lo script post-avvio.

 post-startup-script-behavior
  • run_once (predefinito): esegue lo script post-avvio una volta dopo la creazione o l'upgrade dell'istanza.
  • run_every_start: esegue lo script post-avvio dopo ogni avvio.
  • download_and_run_every_start: scarica di nuovo l'app script post-avvio dalla sua origine, quindi esegue lo script dopo a ogni inizio.
Segnala integrità evento

Controlla l'integrità ogni 30 secondi per le metriche della VM.

 report-event-health
  • true (predefinito): abilita i report sullo stato degli eventi.
  • false: disattiva i report sullo stato degli eventi.

Metadati gestiti da Compute Engine

Alcune delle chiavi dei metadati sono predefinite da Compute Engine. Per ulteriori informazioni le informazioni, vedi Metadati predefiniti chiave.

Chiavi dei metadati protette

Alcune chiavi dei metadati sono riservate al solo uso del sistema. Se assegni valori a queste chiavi di metadati, i nuovi valori verranno sovrascritti valori di sistema.

Le chiavi dei metadati riservate includono, a titolo esemplificativo:

  • data-disk-uri
  • enable-oslogin
  • framework
  • notebooks-api
  • notebooks-api-version
  • nvidia-driver-gcs-path
  • proxy-url
  • restriction
  • shutdown-script
  • title
  • version

Crea un'istanza con metadati specifici

Puoi creare un'istanza di Vertex AI Workbench con metadati specifici utilizzando la console Google Cloud, Google Cloud CLI Terraform, o l'API Notebooks.

Console

Quando crei un'istanza di Vertex AI Workbench, puoi aggiungere nella sezione Ambiente di Opzioni avanzate.

Pulsante Aggiungi metadati nella sezione Ambiente

gcloud

Quando crei un'istanza di Vertex AI Workbench, puoi aggiungere utilizzando il comando seguente.

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

Terraform

Per aggiungere metadati, crea la risorsa con coppie chiave-valore di metadati.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta: Comandi Terraform di base.

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 Notebooks

Utilizza la instances.create con i valori dei metadati per gestire le caratteristiche corrispondenti.

Aggiorna i metadati di un'istanza

Puoi aggiornare i metadati di un'istanza di Vertex AI Workbench utilizzando la console Google Cloud, Google Cloud CLI Terraform, o l'API Notebooks.

Console

Puoi aggiornare i metadati di un'istanza di Vertex AI Workbench in nella sezione Software e sicurezza della pagina Dettagli.

Esempi di campi di valori e chiavi dei metadati

gcloud

Puoi aggiornare i metadati su un'istanza di Vertex AI Workbench utilizzando il seguente comando.

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

Terraform

Puoi modificare le coppie chiave-valore dei metadati per gestire le caratteristiche corrispondenti sulle istanze di Vertex AI Workbench.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta: Comandi Terraform di base.

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 Notebooks

Utilizza la instances.patch con valori di metadati e gce_setup.metadata nel updateMask per gestire le funzionalità corrispondenti.

Rimuovi metadati da un'istanza

Puoi rimuovere i metadati da un'istanza di Vertex AI Workbench utilizzando la console Google Cloud, Google Cloud CLI Terraform, o l'API Notebooks.

Console

Puoi rimuovere i metadati da un'istanza di Vertex AI Workbench in nella sezione Software e sicurezza della pagina Dettagli.

Esempi di campi di valori e chiavi dei metadati durante un aggiornamento

gcloud

Puoi rimuovere i metadati da un'istanza di Vertex AI Workbench utilizzando il seguente comando.

gcloud workbench instances update INSTANCE_NAME --metadata=KEY=

Terraform

Puoi rimuovere le coppie chiave-valore dei metadati per gestire a quelle di un'istanza di Vertex AI Workbench.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta: Comandi Terraform di base.

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 Notebooks

Utilizza la instances.patch con il valore metadata impostato su una stringa vuota e gce_setup.metadata in updateMask per rimuovere la caratteristica corrispondente.