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 predefiniti
Abilita Cloud Storage FUSE su un'immagine container

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

container-allow-fuse
  • true: attiva Cloud Storage FUSE.
  • false (impostazione predefinita): non abilita Cloud Storage FUSE.
nbconvert

Consente di esportare e scaricare i notebook come tipo di file diverso.

 notebook-disable-nbconvert
  • true: disattiva nbconvert.
  • false (impostazione predefinita): abilita 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 (impostazione predefinita): utilizza il comportamento predefinito di JupyterLab.
Dataproc

Abilita l'accesso ai kernel Dataproc.

Per saperne di più, vedi Crea 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à

Attiva l'arresto per inattività.

Per ulteriori informazioni, vedi Arresto inattivo.

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

Attiva gli attributi guest. Necessario per l'esecuzione dell'arresto inattivo.

Per maggiori informazioni, consulta i requisiti per l'esecuzione dell'arresto inattivo.

enable-guest-attributes
  • true (impostazione predefinita): attiva gli attributi guest.
  • false: disattiva gli attributi degli ospiti.
    		•
    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 (impostazione predefinita): 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 blocchi note. Ad esempio, invece della directory predefinita /home/jupyter/, puoi modificare 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 (impostazione predefinita): attiva 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): attiva l'accesso al terminale.
    Upgrade pianificati

    Pianifica gli upgrade automatici dell'istanza.

    		 notebook-upgrade-schedule La pianificazione settimanale o mensile che hai impostato, nel formato unix-cron, ad esempio 00 19 * * MON significa settimanale il lunedì alle ore 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 (impostazione predefinita): 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 lo esegue dopo ogni avvio.
    Segnalare l'integrità degli eventi

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

    		 report-event-health
    • true (impostazione predefinita): attiva la generazione di report sull'integrità degli eventi.
    • false: Disattiva i report sullo stato di integrità degli eventi.
    Abilitare l'anteprima di JupyterLab 4

    Abilita JupyterLab 4 (anteprima) sulla tua istanza. Per ulteriori informazioni, vedi Anteprima di JupyterLab 4.

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

    Metadati gestiti da Compute Engine

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

    Chiavi dei metadati protette

    Alcune chiavi dei metadati sono riservate all'utilizzo esclusivo del sistema. Se assegni valori a queste chiavi di 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 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 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.

    Aggiorna i metadati di un'istanza

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

    Console

    Per aggiornare i metadati di un'istanza di Vertex AI Workbench:

    1. Nella console Google Cloud , vai alla pagina Istanze.

      Vai a Istanze

    2. Nell'elenco delle istanze, fai clic sul nome dell'istanza da aggiornare.

    3. Nella pagina Dettagli istanza, fai clic su Software e sicurezza.

    4. Nella sezione Metadati, aggiorna le coppie chiave-valore dei metadati che vuoi modificare.

    5. Fai clic su Invia.

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

    Per rimuovere i metadati da un'istanza di Vertex AI Workbench, segui questi passaggi:

    1. Nella console Google Cloud , vai alla pagina Istanze.

      Vai a Istanze

    2. Nell'elenco delle istanze, fai clic sul nome dell'istanza da modificare.

    3. Nella pagina Dettagli istanza, fai clic su Software e sicurezza.

    4. Nella sezione Metadati, a destra di una coppia chiave-valore che vuoi eliminare, fai clic su  Elimina.

    5. Fai clic su Invia.

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