Gestire 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 funzionalità e sulle rispettive chiavi dei metadati, consulta la tabella seguente.

Selezione delle Descrizione Chiave dei metadati Valori e valori predefiniti accettati
nbconvert

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

 notebook-disable-nbconvert
  • true: disattiva nbconvert.
  • false (impostazione predefinita): consente di attivare nbconvert.
Elimina nel cestino

Utilizza il comportamento del cestino del sistema operativo per l'eliminazione da JupyterLab.

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

Abilita l'accesso ai kernel Dataproc.

Per maggiori informazioni, consulta Creare un'istanza abilitata per Dataproc.

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

Consente l'arresto per inattività.

Per maggiori informazioni, consulta Chiusura per inattività.

idle-timeout-seconds Un numero intero che rappresenta il tempo di inattività in secondi. Il valore predefinito è 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 predefinita /home/jupyter/, puoi cambiare la directory in /home/CUSTOM_NAME. Questa chiave dei metadati non influisce sull'accesso all'istanza.

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

Ti consente di scaricare file da JupyterLab.

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

Abilita l'accesso root.

 notebook-disable-root
  • true: disattiva l'accesso root.
  • false (impostazione predefinita): consente l'accesso root.
Accesso al terminale

Consente l'accesso al terminale.

 notebook-disable-terminal
  • true: disattiva l'accesso al terminale.
  • false (impostazione predefinita): consente l'accesso al terminale.
Upgrade pianificati

Pianifica gli upgrade automatici dell'istanza.

 notebook-upgrade-schedule La pianificazione settimanale o mensile che imposti, in formato unix-cron, ad esempio, 00 19 * * MON indica che la pianificazione è settimanale di lunedì, alle 1900 ore 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 nuovamente lo script post-avvio dall'origine e poi esegue lo script dopo ogni avvio.
Segnala stato un evento

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

 report-event-health
  • true (impostazione predefinita): abilita i report sullo stato di salute degli eventi.
  • false: disattiva i report sulla salute degli eventi.

Metadati gestiti da Compute Engine

Alcune delle chiavi dei metadati sono predefinite da Compute Engine. Per ulteriori informazioni, consulta Chiavi dei metadati predefinite.

Chiavi dei metadati protette

Alcune chiavi dei metadati sono riservate all'utilizzo esclusivo del sistema. Se assegni valori a queste chiavi dei metadati, i nuovi valori verranno sovrascritti dai 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 metadati nella sezione Ambiente di Opzioni avanzate.

Il pulsante Aggiungi metadati nella sezione Ambiente

gcloud

Quando crei un'istanza di Vertex AI Workbench, puoi aggiungere metadati 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 il metodo instances.create con i valori dei metadati per gestire le funzionalità 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 nella sezione Software e sicurezza della relativa pagina Dettagli.

Esempi di campi chiave e valore dei metadati

gcloud

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

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 il metodo instances.patch con i valori dei metadati e gce_setup.metadata in 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 nella sezione Software e sicurezza della relativa pagina Dettagli.

Esempi di campi chiave e valore 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 le caratteristiche corrispondenti 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

Usa il metodo instances.patch con il valore dei metadati impostato su una stringa vuota e gce_setup.metadata in updateMask per rimuovere la funzionalità corrispondente.