Gestire le funzionalità tramite i metadati

Questa pagina descrive come gestire alcune funzionalità dell'istanza 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.

Funzionalità Descrizione Chiave dei metadati Valori accettati e valori predefiniti
Consente di attivare Cloud Storage FUSE in un'immagine container

Monta /dev/fuse sul contenitore e attiva gcsfuse per l'utilizzo nel contenitore.

container-allow-fuse
  • true: attiva Cloud Storage FUSE.
  • false (valore predefinito): non attiva Cloud Storage FUSE.
nbconvert

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

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

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

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

Abilita l'accesso ai kernel Dataproc.

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

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

Attiva lo spegnimento per inattività.

Per ulteriori informazioni, consulta la sezione Spegnimento in caso di inattività.

idle-timeout-seconds Un numero intero che rappresenta il tempo di inattività in secondi. Il valore predefinito è 10800 secondi (180 minuti).
Patch del sistema operativo pianificate

Pianifica gli aggiornamenti automatici del sistema operativo dell'istanza. In questo modo viene attivato il servizio di upgrade automatico di Debian e si applica solo alle immagini basate su VM.

install-unattended-upgrades
  • true: attiva gli aggiornamenti automatici del sistema operativo.
  • false (valore predefinito): disattiva gli aggiornamenti automatici del sistema operativo.
Utente Jupyter personalizzato

Specifica il nome dell'utente Jupyter predefinito. Questa impostazione determina il nome della cartella per i tuoi notebook. Ad esempio, anziché la directory predefinita /home/jupyter/, puoi impostare la directory /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 dei file.
  • false (impostazione predefinita): consente il download dei file.
Accesso root

Consente l'accesso root.

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

Consente l'accesso al terminale.

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

Pianifica gli upgrade automatici dell'istanza.

 notebook-upgrade-schedule La pianificazione settimanale o mensile impostata in formato unix-cron, ad esempio 00 19 * * MON, indica che la pianificazione è settimanale e si applica il lunedì alle ore 19:00 (ora media 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 (valore 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 lo script post-avvio dalla relativa origine, quindi esegue lo script dopo ogni avvio.
Segnalazione dell'integrità degli eventi

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

 report-event-health
  • true (valore predefinito): attiva il reporting sullo stato di integrità degli eventi.
  • false: disattiva i report sullo stato degli eventi.
Attivare l'anteprima di JupyterLab 4

Attiva JupyterLab 4 (anteprima) sulla tua istanza. Per ulteriori informazioni, consulta Anteprima di JupyterLab 4.

enable-jupyterlab4-preview
  • true: attiva JupyterLab 4.
  • false (valore predefinito): abilita JupyterLab 3.

Metadati gestiti da Compute Engine

Alcune chiavi dei metadati sono predefinite da Compute Engine. Per maggiori informazioni, consulta la sezione Chiavi predefinite dei metadati.

Chiavi dei metadati protetti

Alcune chiavi dei metadati sono riservate all'utilizzo esclusivo del sistema. Se assegni valori a queste chiavi dei metadati, i nuovi valori verranno sovrascritti da quelli 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

Creare 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 i 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 i metadati utilizzando il seguente comando:

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.

Aggiornare 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 pagina Dettagli.

Esempi di campi chiave e valore dei metadati

gcloud

Puoi aggiornare i metadati di 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 funzionalità corrispondenti nelle 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.

Rimuovere i 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 pagina Dettagli.

Esempi di campi chiave e valore dei metadati durante un aggiornamento

gcloud

Puoi rimuovere i metadati da un'istanza 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 funzionalità 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

Utilizza 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.