Gerenciar atributos usando metadados

Nesta página, descrevemos como gerenciar alguns recursos de instâncias do Vertex AI Workbench modificando os pares de chave-valor de metadados da instância.

Chaves de metadados

Para informações sobre recursos e as respectivas chaves de metadados, consulte a tabela a seguir.

Recurso	Descrição	Chave de metadados	Valores e padrões aceitos
nbconvert	Permite exportar e fazer o download de notebooks como um tipo de arquivo diferente.	`notebook-disable-nbconvert`	`true`: desativa o nbconvert. `false` (padrão): ativa o nbconvert.
Excluir para a lixeira	Usa o comportamento de lixeira do sistema operacional ao excluir do JupyterLab.	`notebook-enable-delete-to-trash`	`true`: ativa a exclusão para a lixeira. `false` (padrão): usa o comportamento padrão do JupyterLab.
Dataproc	Permite acesso aos kernels do Dataproc. Para mais informações, consulte Criar uma instância ativada para Dataproc.	`disable-mixer`	`true`: desativa o acesso aos kernels do Dataproc. `false` (padrão): ativa o acesso aos kernels do Dataproc.
Encerramento de inatividade	Ativa o desligamento por inatividade. Para mais informações, consulte Desativação de inatividade.	`idle-timeout-seconds`	Um número inteiro que representa o tempo de inatividade em segundos. O valor padrão é de `10800` segundos (180 minutos).
Usuário do Jupyter personalizado	Especifica o nome do usuário padrão do Jupyter. Essa configuração determina o nome da pasta para seus notebooks. Por exemplo, em vez do diretório `/home/jupyter/` padrão, é possível alterar o diretório para `/home/CUSTOM_NAME`. Essa chave de metadados não afeta o acesso à instância.	`jupyter-user`	Uma string. O valor padrão é `jupyter`.
Permitir downloads do arquivo	Permite fazer o download de arquivos do JupyterLab.	`notebook-disable-downloads`	`true`: desativa o download de arquivos. `false` (padrão): ativa o download de arquivos.
Acesso raiz	Ativa o acesso raiz.	`notebook-disable-root`	`true`: desativa o acesso raiz. `false` (padrão): ativa o acesso raiz.
Acesso ao terminal	Permite o acesso ao terminal.	`notebook-disable-terminal`	`true`: desativa o acesso ao terminal. `false` (padrão): ativa o acesso ao terminal.
Upgrades programados	Programa upgrades automáticos da instância.	`notebook-upgrade-schedule`	A programação semanal ou mensal que você define, no formato unix-cron, por exemplo, `00 19 * * MON` significa "semanalmente" às segundas-feiras, às 1900 horas, horário de Greenwich (GMT). Esse recurso fica desativado por padrão.
Script pós-inicialização	Executa um script personalizado após a inicialização.	`post-startup-script`	O URI de um script de pós-inicialização no Cloud Storage, por exemplo: `gs://bucket/hello.sh`. Esse recurso fica desativado por padrão.
Comportamento do script pós-inicialização	Define quando e como o script pós-inicialização é executado.	`post-startup-script-behavior`	`run_once` (padrão): executa o script de pós-inicialização uma vez após a criação ou o upgrade da instância. `run_every_start`: executa o script pós-inicialização após cada início. `download_and_run_every_start`: refaz o download do script pós-inicialização da origem e executa o script após cada início.
Reportar integridade do evento	Verifica a integridade a cada 30 segundos para métricas da VM.	`report-event-health`	`true` (padrão): ativa a geração de relatórios de integridade do evento. `false`: desativa os relatórios de integridade do evento.

Metadados gerenciados pelo Compute Engine

Algumas das chaves de metadados são predefinidas pelo Compute Engine. Para mais informações, consulte Chaves de metadados predefinidas.

Chaves de metadados protegidas

Algumas chaves de metadados são reservadas somente para uso do sistema. Se você atribuir valores a essas chaves de metadados, os novos valores serão substituídos pelos do sistema.

As chaves de metadados reservadas incluem, entre outras:

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

Criar uma instância com metadados específicos

É possível criar uma instância do Vertex AI Workbench com metadados específicos usando o console do Google Cloud, a CLI do Google Cloud, o Terraform ou a API Notebooks:

Console

Ao criar uma instância do Vertex AI Workbench, é possível adicionar metadados na seção Ambiente de Opções avançadas.

O botão "Adicionar metadados" na seção "Ambiente"

gcloud

Ao criar uma instância do Vertex AI Workbench, é possível adicionar metadados usando o comando a seguir.

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

Terraform

Para adicionar metadados, crie o recurso com pares de chave-valor de metadados.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

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

Use o método instances.create com valores de metadados para gerenciar os atributos correspondentes.

Atualizar os metadados de uma instância

É possível atualizar os metadados de uma instância do Vertex AI Workbench usando o console do Google Cloud, a CLI do Google Cloud, o Terraform ou a API Notebooks.

Console

É possível atualizar os metadados de uma instância do Vertex AI Workbench na seção Software e segurança da página Detalhes.

Exemplos de campos de chave e valor de metadados

gcloud

É possível atualizar os metadados em uma instância do Vertex AI Workbench usando o comando a seguir.

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

Terraform

É possível alterar os pares de chave-valor de metadados para gerenciar os recursos correspondentes nas instâncias do Vertex AI Workbench.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

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

Use o método instances.patch com valores de metadados e gce_setup.metadata no updateMask para gerenciar os recursos correspondentes.

Remover metadados de uma instância

É possível remover metadados de uma instância do Vertex AI Workbench usando o console do Google Cloud, a CLI do Google Cloud, o Terraform ou a API Notebooks.

Console

É possível remover metadados de uma instância do Vertex AI Workbench na seção Software e segurança da página Detalhes.

Exemplos de campos de chave e valor de metadados durante uma atualização

gcloud

É possível remover metadados de uma instância do Vertex AI Workbench, use o comando a seguir.

gcloud workbench instances update INSTANCE_NAME --metadata=KEY=

Terraform

É possível remover pares de chave-valor de metadados para gerenciar os recursos correspondentes de uma instância do Vertex AI Workbench.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

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

Use o método instances.patch com o valor de metadados definido como uma string vazia e gce_setup.metadata no updateMask para remover o atributo correspondente.