Esta página foi traduzida pela API Cloud Translation.

Faça a gestão de funcionalidades através de metadados

Esta página descreve como gerir algumas funcionalidades da instância do Vertex AI Workbench modificando os pares de chave-valor dos metadados da instância.

Chaves de metadados

Para ver informações sobre as funcionalidades e as respetivas chaves de metadados, consulte a tabela seguinte.

Funcionalidade	Descrição	Chave de metadados	Valores aceites e predefinições
Ativa o FUSE do Cloud Storage numa imagem de contentor	Monta `/dev/fuse` no contentor e ativa `gcsfuse` para utilização no contentor.	`container-allow-fuse`	`true`: ativa o FUSE do Cloud Storage. `false` (predefinição): não ativa o FUSE do Cloud Storage.
nbconvert	Permite-lhe exportar e transferir blocos de notas como um tipo de ficheiro diferente.	`notebook-disable-nbconvert`	`true`: desativa o nbconvert. `false` (predefinição): ativa o nbconvert.
Eliminar para o lixo	Usa o comportamento do lixo do sistema operativo quando elimina ficheiros do JupyterLab.	`notebook-enable-delete-to-trash`	`true`: permite a eliminação para o lixo. `false` (predefinição): usa o comportamento predefinido do JupyterLab.
Dataproc	Permite o acesso aos kernels do Dataproc. Para mais informações, consulte o artigo Crie uma instância com o Dataproc ativado.	`disable-mixer`	`true`: desativa o acesso aos kernels do Dataproc. `false` (predefinição): permite o acesso aos kernels do Dataproc.
Encerramento por inatividade	Ativa o encerramento por inatividade. Para mais informações, consulte o artigo Encerramento por inatividade.	`idle-timeout-seconds`	Um número inteiro que representa o tempo de inatividade em segundos. O valor predefinido é de `10800` segundos (180 minutos).
Atributos de hóspedes	Ativa os atributos de hóspedes. Necessário para executar o encerramento por inatividade. Para mais informações, consulte os requisitos para executar o encerramento por inatividade.	`enable-guest-attributes`	`true` (predefinição): ativa os atributos de convidados. `false`: desativa os atributos de hóspedes.
Patches do SO agendados	Agenda atualizações automáticas do SO da instância. Isto ativa o serviço de atualização automática do Debian e aplica-se apenas a imagens baseadas em VMs.	`install-unattended-upgrades`	`true`: ativa as atualizações automáticas do SO. `false` (predefinição): desativa as atualizações automáticas do SO.
Utilizador do Jupyter personalizado	Especifica o nome do utilizador do Jupyter predefinido. Esta definição determina o nome da pasta dos seus blocos de notas. Por exemplo, em vez do diretório `/home/jupyter/` predefinido, pode alterar o diretório para `/home/CUSTOM_NAME`. Esta chave de metadados não afeta o acesso à instância.	`jupyter-user`	Uma string. O valor predefinido é `jupyter`.
Transferência de ficheiros	Permite-lhe transferir ficheiros do JupyterLab.	`notebook-disable-downloads`	`true`: desativa a transferência de ficheiros. `false` (predefinição): ativa a transferência de ficheiros.
Acesso root	Ativa o acesso raiz.	`notebook-disable-root`	`true`: desativa o acesso de raiz. `false` (predefinição): ativa o acesso raiz.
Acesso ao terminal	Ativa o acesso ao terminal.	`notebook-disable-terminal`	`true`: desativa o acesso ao terminal. `false` (predefinição): ativa o acesso ao terminal.
Atualizações agendadas	Agenda atualizações automáticas da instância.	`notebook-upgrade-schedule`	O agendamento semanal ou mensal que define no formato unix-cron. Por exemplo, `00 19 * * MON` significa semanalmente à segunda-feira, às 19:00, hora do meridiano de Greenwich (GMT). Esta funcionalidade está desativada por predefinição.
Script pós-arranque	Executa um script personalizado depois de outros scripts de arranque terem sido concluídos. Para ver detalhes sobre a ordem de execução, consulte o artigo Ordem de execução do script de arranque.	`post-startup-script`	O URI de um script de pós-arranque no Cloud Storage, por exemplo: `gs://bucket/hello.sh`. Esta funcionalidade está desativada por predefinição.
Comportamento do script pós-arranque	Define quando e como o script de pós-arranque é executado.	`post-startup-script-behavior`	`run_once` (predefinição): executa o script de pós-inicialização uma vez após a criação ou a atualização da instância. `run_every_start`: executa o script pós-arranque após cada arranque. `download_and_run_every_start`: transfere novamente o script de pós-arranque da respetiva origem e, em seguida, executa o script após cada arranque.
Comunique o estado dos eventos	Verifica a saúde a cada 30 segundos para as métricas de VMs.	`report-event-health`	`true` (predefinição): ativa os relatórios de estado de funcionamento de eventos. `false`: desativa os relatórios de estado dos eventos.
Ative a pré-visualização do JupyterLab 4	Ativa o JupyterLab 4 (Pré-visualização) na sua instância. Para mais informações, consulte a pré-visualização do JupyterLab 4.	`enable-jupyterlab4-preview`	`true`: ativa o JupyterLab 4. `false` (predefinição): ativa o JupyterLab 3.

Ordem de execução do script de arranque

Se usar vários scripts de arranque para a sua instância do Vertex AI Workbench, estes são executados pela seguinte ordem:

startup-script: é executado primeiro durante cada arranque após o arranque inicial.
startup-script-url: é executado em segundo lugar durante cada arranque após o arranque inicial.
workbench-startup-scripts: é executado após a conclusão dos scripts de arranque do Compute Engine (startup-script e startup-script-url).
post-startup-script: executado após a conclusão do workbench-startup-scripts.

Tenha em atenção que, para a chave de metadados post-startup-script, tem de fornecer o script como um URI do Cloud Storage. Não pode fornecer o conteúdo do script diretamente como valor.

Metadados geridos pelo Compute Engine

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

Chaves de metadados protegidas

Algumas chaves de metadados estão reservadas apenas para utilização pelo sistema. Se atribuir valores a estas chaves de metadados, os novos valores são substituídos pelos valores 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

Crie uma instância com metadados específicos

Pode criar uma instância do Vertex AI Workbench com metadados específicos através da Google Cloud consola, da CLI Google Cloud, do Terraform ou da API Notebooks.

Consola

Quando cria uma instância do Vertex AI Workbench, pode adicionar metadados na secção Ambiente das Opções avançadas.

O botão Adicionar metadados na secção Ambiente

gcloud

Quando cria uma instância do Vertex AI Workbench, pode adicionar metadados através do seguinte comando:

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 os 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 gerir as funcionalidades correspondentes.

Atualize os metadados de uma instância

Pode atualizar os metadados de uma instância do Vertex AI Workbench através da Google Cloud consola, da CLI Google Cloud, do Terraform ou da API Notebooks.

Consola

Para atualizar os metadados de uma instância do Vertex AI Workbench, faça o seguinte:

Na Google Cloud consola, aceda à página Instâncias.

Aceda a Instâncias
Na lista de instâncias, clique no nome da instância que quer atualizar.
Na página Detalhes da instância, clique em Software e segurança.
Na secção Metadados, atualize os pares de chave-valor de metadados que quer alterar.
Clique em Enviar.

gcloud

Pode atualizar os metadados numa instância do Vertex AI Workbench com o seguinte comando:

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

Terraform

Pode alterar os pares de chave-valor de metadados para gerir as funcionalidades correspondentes nas instâncias do Vertex AI Workbench.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os 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 gerir as funcionalidades correspondentes.

Remova metadados de uma instância

Pode remover metadados de uma instância do Vertex AI Workbench através da Google Cloud consola, da CLI Google Cloud, do Terraform ou da API Notebooks.

Consola

Para remover metadados de uma instância do Vertex AI Workbench, faça o seguinte:

Na Google Cloud consola, aceda à página Instâncias.

Aceda a Instâncias
Na lista de instâncias, clique no nome da instância que quer modificar.
Na página Detalhes da instância, clique em Software e segurança.
Na secção Metadados, à direita de um par chave-valor que quer eliminar, clique em Eliminar.
Clique em Enviar.

gcloud

Pode remover metadados de uma instância do Vertex AI Workbench com o seguinte comando:

gcloud workbench instances update INSTANCE_NAME --metadata=KEY

Terraform

Pode remover pares de chave-valor de metadados para gerir as funcionalidades correspondentes de uma instância do Vertex AI Workbench.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os 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 a funcionalidade correspondente.