Gestire le funzionalità tramite i metadati

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

Chiavi dei metadati

Per informazioni sulle funzionalità e sulle relative 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: abilita Cloud Storage FUSE. false (predefinito): 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 (valore predefinito): 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 (predefinito): utilizza il comportamento predefinito di JupyterLab.
Managed Service for Apache Spark	Abilita l'accesso ai kernel Managed Service for Apache Spark. Per saperne di più, consulta Crea un'istanza abilitata per Managed Service for Apache Spark.	disable-mixer	true: disattiva l'accesso ai kernel di Managed Service for Apache Spark. false (valore predefinito): abilita l'accesso ai kernel Managed Service for Apache Spark.
BigQuery	Abilita il plug-in BigQuery JupyterLab, che fornisce un explorer di set di dati, un editor di query SQL e la cronologia delle query in JupyterLab.	disable-bigquery	true: disattiva il plug-in JupyterLab di BigQuery. false (predefinito): abilita il plug-in BigQuery JupyterLab.
Arresto per inattività	Abilita l'arresto per inattività. Per saperne di più, consulta Arresto per inattività.	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. Obbligatorio per l'esecuzione dell'arresto per inattività. Per saperne di più, consulta Requisiti per l'esecuzione dell'arresto per inattività.	enable-guest-attributes	true (valore predefinito): attiva gli attributi guest. false: disattiva gli attributi guest.
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, che si applica solo alle immagini basate su VM.	install-unattended-upgrades	true: attiva gli aggiornamenti automatici del sistema operativo. false (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, invece della 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	Consente di scaricare file da JupyterLab.	notebook-disable-downloads	true: disattiva il download dei file. false (valore predefinito): attiva il download dei file.
Accesso root	Abilita l'accesso root.	notebook-disable-root	true: disattiva l'accesso root. false (valore predefinito): abilita l'accesso root.
Accesso al terminale	Abilita l'accesso al terminale.	notebook-disable-terminal	true: disattiva l'accesso al terminale. false (valore predefinito): 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 ogni lunedì alle 19:00 Greenwich Mean Time (GMT). Questa funzionalità è disattivata per impostazione predefinita. Per disattivare questa funzionalità o mantenerla disattivata, ometti la chiave dei metadati notebook-upgrade-schedule dalla configurazione o imposta il relativo valore su una stringa vuota ("").
Script post-avvio	Esegue uno script personalizzato dopo il completamento di altri script di avvio. Per maggiori dettagli sull'ordine di esecuzione, consulta Ordine di esecuzione degli script di 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 di avvio	Definisce quando e come viene eseguito lo script post-avvio.	post-startup-script-behavior	run_once (predefinito): esegue lo script di avvio post-creazione una volta dopo la creazione o l'upgrade dell'istanza. run_every_start: esegue lo script di avvio post-avvio dopo ogni avvio. download_and_run_every_start: scarica nuovamente lo script di avvio dalla relativa origine, quindi lo esegue dopo ogni avvio.
Segnala l'integrità dell'evento	Controlla l'integrità ogni 30 secondi per le metriche delle VM.	report-event-health	true (valore predefinito): attiva il reporting sullo stato degli eventi. false: disattiva i report sullo stato degli eventi.
Attiva JupyterLab 4 o passa a JupyterLab 3	Abilita JupyterLab 3. JupyterLab 4 è abilitato per impostazione predefinita.	enable-jupyterlab4	true (predefinito): abilita JupyterLab 4. false: abilita JupyterLab 3.
Antigravity CLI	Attiva l'interfaccia a riga di comando Antigravity, con il relativo riquadro di avvio, le skill del notebook, il plug-in e il comando magico della cella %%agy, sulle istanze che utilizzano un'immagine Debian 12 (workbench-instances-2603) o successiva. L'istanza applica il valore all'avvio.	enable-antigravity	true (predefinito per le nuove istanze): attiva l'interfaccia a riga di comando Antigravity. false: disattiva l'interfravity CLI.

Ordine di esecuzione degli script di avvio

Se utilizzi più script di avvio per l'istanza Workbench di Agent Platform, questi vengono eseguiti nel seguente ordine:

1. startup-script: viene eseguito per primo durante ogni avvio successivo all'avvio iniziale.
2. startup-script-url: Viene eseguito come secondo avvio dopo l'avvio iniziale.
3. workbench-startup-scripts: viene eseguito dopo il completamento degli script di avvio di Compute Engine (startup-script e startup-script-url).
4. post-startup-script: viene eseguito dopo il completamento di workbench-startup-scripts.

Tieni presente che per la chiave dei metadati post-startup-script devi fornire lo script come URI Cloud Storage. Non puoi fornire i contenuti dello script direttamente come valore.

Metadati gestiti da Compute Engine

Alcune chiavi dei metadati sono predefinite da Compute Engine. Per saperne di più, 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:

• agent-health-check-interval-seconds
• agent-health-check-path
• cos-update-strategy
• custom-container-image
• custom-container-payload
• data-disk-uri
• dataproc-allow-custom-clusters
• dataproc-cluster-name
• dataproc-configs
• dataproc-default-subnet
• dataproc-locations-list
• dataproc-machine-types-list
• dataproc-notebooks-url
• dataproc-region
• dataproc-service-account
• disable-check-xsrf
• euc-enabled
• framework
• generate-diagnostics-bucket
• generate-diagnostics-file
• generate-diagnostics-options
• google-logging-enabled
• image-url
• install-monitoring-agent
• install-nvidia-driver
• installed-extensions
• last_updated_diagnostic
• last_updated_diagnostics
• notebooks-api
• notebooks-api-version
• notebooks-examples-location
• notebooks-location
• proxy-backend-id
• proxy-byoid-url
• proxy-mode
• proxy-status
• proxy-url
• proxy-user-mail
• report-container-health
• report-event-url
• report-notebook-metrics
• report-system-health
• report-system-status
• resource-url
• restriction
• serial-port-logging-enable
• service-account-mode
• shutdown-script
• title
• use-collaborative
• user-data
• version

Crea un'istanza con metadati specifici

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

Console

Quando crei un'istanza di Agent Platform Workbench, puoi aggiungere metadati nella sezione Ambiente di Opzioni avanzate.

gcloud

Quando crei un'istanza di Agent Platform 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 dei 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 Agent Platform Workbench utilizzando la console Google Cloud , Google Cloud CLI, Terraform o l'API Notebooks.

Console

Per aggiornare i metadati di un'istanza di Agent Platform 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 che vuoi 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 di un'istanza di Agent Platform 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 Agent Platform 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 i metadati da un'istanza

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

Console

Per rimuovere i metadati da un'istanza di Agent Platform 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 che vuoi 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 Agent Platform 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 Agent Platform 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.