Criar uma instância de notebooks gerenciados

Criar uma instância de notebooks gerenciados

Os notebooks gerenciados do Vertex AI Workbench foram descontinuados. Em 30 de janeiro de 2025, o suporte a notebooks gerenciados será encerrado, e não será mais possível criar instâncias de notebooks gerenciados. As instâncias que já existem continuarão funcionando, mas patches, atualizações e upgrades não estarão disponíveis. Para continuar usando o Vertex AI Workbench, recomendamos que você migre suas instâncias de notebooks gerenciados para instâncias do Vertex AI Workbench.

Nesta página, mostramos como criar uma instância de notebooks gerenciados usando o console do Google Cloud ou a CLI do Google Cloud. Ao criar a instância, é possível configurar o hardware, o tipo de criptografia, a rede e outros detalhes dela.

Antes de começar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Notebooks API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Notebooks API.

   Enable the API

Criar uma instância com propriedades padrão

É possível criar uma instância de notebooks gerenciados usando o console do Google Cloud ou a CLI gcloud:

Console

1. No Console do Google Cloud, acesse a página Notebooks gerenciados.

   Acessar Notebooks gerenciados

2. Clique em Novo notebook.

3. No campo Nome do notebook, insira um nome para sua instância. O nome precisa começar com uma letra seguida por até 62 letras minúsculas, números ou hifens (-) e não pode terminar com um hífen.

4. Clique na lista Região e selecione uma região para a instância.

5. Escolha uma opção de permissão para definir quais usuários podem acessar a instância de notebooks gerenciados:

   • Conta de serviço: essa opção dá acesso a todos os usuários que têm acesso à conta de serviço do Compute Engine que você vincula ao ambiente de execução. Para especificar sua própria conta de serviço, desmarque a caixa de seleção Usar a conta de serviço padrão do Compute Engine e insira o endereço de e-mail da conta de serviço que você quer usar. Para mais informações sobre contas de serviço, consulte Tipos de contas de serviço.

   • Usuário único: essa opção concede acesso a somente um usuário específico. No campo E-mail do usuário, insira o endereço de e-mail da conta de usuário que usará a instância de notebooks gerenciados.

   Observação: para conceder acesso à instância por meio da conta de serviço ou da opção de usuário único, é necessário usar a conta de usuário de um indivíduo endereço de e-mail. O acesso ao grupo não é compatível.

   Para saber mais sobre como conceder acesso, consulte Gerenciar acesso.

6. Clique em Criar.

   O Vertex AI Workbench inicia automaticamente a instância. Quando a instância estiver pronta para uso, o Vertex AI Workbench ativa um link Abrir JupyterLab.

gcloud

Antes de usar os dados do comando abaixo, faça estas substituições:

• INSTANCE_NAME: o nome da sua instância de notebooks gerenciados. precisa começar com uma letra seguida por até 62 letras minúsculas, números ou hifens (-) e não pode terminar com um hífen.
• PROJECT_ID: o ID do projeto
• LOCATION: a região em que você quer que a instância esteja localizada.
• ACCESS_MODE: o modo de acesso que você quer usar; por exemplo, SINGLE_USER ou SERVICE_ACCOUNT
• OWNER_EMAIL_ADDRESS: o endereço de e-mail do único usuário ou da conta de serviço que precisa de acesso à interface JupyterLab da instância
• MACHINE_TYPE: o tipo de máquina da VM da instância

Execute o seguinte comando:

Linux, macOS ou Cloud Shell

Observação: para inicializar a Google Cloud CLI com autenticação e um projeto, execute gcloud init. ou gcloud auth login e gcloud config set project.

gcloud notebooks runtimes create INSTANCE_NAME --project=PROJECT_ID --location=LOCATION --runtime-access-type=ACCESS_MODE --runtime-owner=OWNER_EMAIL_ADDRESS --machine-type=MACHINE_TYPE

Windows (PowerShell)

Observação: para inicializar a Google Cloud CLI com autenticação e um projeto, execute gcloud init. ou gcloud auth login e gcloud config set project.

gcloud notebooks runtimes create INSTANCE_NAME --project=PROJECT_ID --location=LOCATION --runtime-access-type=ACCESS_MODE --runtime-owner=OWNER_EMAIL_ADDRESS --machine-type=MACHINE_TYPE

Windows (cmd.exe)

Observação: para inicializar a Google Cloud CLI com autenticação e um projeto, execute gcloud init. ou gcloud auth login e gcloud config set project.

gcloud notebooks runtimes create INSTANCE_NAME --project=PROJECT_ID --location=LOCATION --runtime-access-type=ACCESS_MODE --runtime-owner=OWNER_EMAIL_ADDRESS --machine-type=MACHINE_TYPE

Para mais informações sobre o comando para criar uma instância usando a linha de comando, consulte a documentação da CLI gcloud.

O Vertex AI Workbench inicia a instância automaticamente após a criação. Quando a instância estiver pronta para uso, acesse-a no Console do Google Cloud.

Criar uma instância usando configurações avançadas

1. No Console do Google Cloud, acesse a página Notebooks gerenciados.

   Acessar Notebooks gerenciados

2. Clique em Novo notebook.

3. No campo Nome do notebook, insira um nome para sua instância. O nome precisa começar com uma letra seguida por até 62 letras minúsculas, números ou hifens (-) e não pode terminar com um hífen.

4. Clique na lista Região e selecione uma região para a instância.

5. Escolha uma opção de permissão para definir quais usuários podem acessar a instância de notebooks gerenciados:

   • Conta de serviço: essa opção dá acesso a todos os usuários que têm acesso à conta de serviço do Compute Engine que você vincula ao ambiente de execução. Para especificar sua própria conta de serviço, desmarque a caixa de seleção Usar a conta de serviço padrão do Compute Engine e insira o endereço de e-mail da conta de serviço que você quer usar. Para mais informações sobre contas de serviço, consulte Tipos de contas de serviço.

   • Usuário único: essa opção concede acesso a somente um usuário específico. No campo E-mail do usuário, insira o endereço de e-mail da conta de usuário que usará a instância de notebooks gerenciados.

   Observação: para conceder acesso à instância por meio da conta de serviço ou da opção de usuário único, é necessário usar a conta de usuário de um indivíduo endereço de e-mail. O acesso ao grupo não é compatível.

   Para saber mais sobre como conceder acesso, consulte Gerenciar acesso.

6. Clique em Configurações avançadas e preencha a caixa de diálogo seguindo as instruções nas seções a seguir.

Usar imagens personalizadas do Docker

Para executar arquivos de notebook em um contêiner personalizado do Docker, adicione a imagem do contêiner personalizado do Docker à instância de notebooks gerenciado.

A imagem personalizada do contêiner do Docker precisa estar localizada no Artifact Registry. Você precisa ter acesso à imagem do contêiner.

1. Na seção Ambiente, em Imagens personalizadas do Docker, marque a caixa de seleção Fornecer imagens personalizadas do Docker.

2. Informe um caminho de imagem do contêiner do Docker ou clique em Selecionar para adicionar um do Artifact Registry.

3. Para adicionar outra imagem personalizada do Docker, clique em Adicionar outra imagem do Docker e repita essas etapas.

Configurar hardware

Selecione uma configuração de hardware para seu ambiente. É possível alterar isso posteriormente na interface do usuário do JupyterLab.

Confirmar disponibilidade da GPU

A disponibilidade do acelerador de GPU é baseada na região, no tipo de máquina e no número de GPUs que você quer. Confirme a disponibilidade usando os recursos a seguir:

• Disponibilidade de regiões e zonas de GPU. O tipo de acelerador que você quer precisa estar disponível na zona da instância.
• NVIDIA® A100 GPUs. Verifique a disponibilidade da GPU para seu tipo de máquina.

Configurar o hardware

Para configurar o hardware, faça o seguinte:

1. Na seção Configuração de hardware, selecione um Tipo de máquina.

2. Se você quiser usar GPUs, selecione um Tipo de GPU. Se o tipo de GPU que você quer usar não estiver disponível, verifique a disponibilidade da GPU para seu tipo de máquina e região.

3. Se você optar por usar GPUs, selecione um Número de GPUs e, em seguida, selecione Instalar o driver da GPU NVIDIA automaticamente para mim.

4. Selecione um Tipo de disco de dados e Tamanho do disco de dados em GB.

5. Para usar o comportamento padrão do sistema operacional, marque a caixa de seleção Excluir para a lixeira. Se você usar o comportamento padrão da lixeira, os arquivos excluídos com a interface do usuário do JupyterLab serão recuperáveis, mas eles consomem espaço em disco.

Selecionar tipo de criptografia

Escolha a chave de criptografia padrão gerenciada pelo Google ou uma chave de criptografia gerenciada pelo cliente (CMEK): Para saber mais sobre o uso da CMEK com notebooks gerenciados, consulte Usar chaves de criptografia gerenciadas pelo cliente.

1. Na seção Criptografia de disco selecione o padrão Chave de criptografia gerenciada pelo Google ou selecione Chave de criptografia gerenciada pelo cliente (CMEK).

2. Se você selecionar Chave de criptografia gerenciada pelo cliente (CMEK), clique na lista e selecione a chave gerenciada pelo cliente.

   • Se a chave que você quer usar não estiver na lista, insira o ID do recurso da sua chave de criptografia.

   • Para criar uma chave de criptografia gerenciada pelo cliente, consulte Como criar chaves de criptografia simétricas.

Ativar encerramento de inatividade

O encerramento de inatividade é ativado por padrão para encerrar a instância após 180 minutos de inatividade. É possível alterar o número de minutos de inatividade antes do encerramento ou desativar o desligamento. Para saber mais, consulte Encerramento por inatividade.

• Para alterar o número de minutos antes do encerramento, na seção Desligamento ocioso, no campo Tempo de inatividade antes do encerramento (minutos): mude o valor para um inteiro entre 1 e 600.

• Para desativar o desligamento inativo, na seção Desligamento inativo, desmarque Ativar o desligamento ocioso.

Configurar a rede

Por padrão, a instância de notebooks gerenciados usa uma rede VPC gerenciada pelo Google, que não requer configuração. Se quiser, especifique uma rede localizada dentro do projeto ou uma rede compartilhada com você. Se você especificar uma rede, será necessária uma conexão de acesso a serviços particulares. Também é necessário ter acesso à Internet ou ativar o Acesso privado do Google.

1. Na seção Rede, selecione Redes neste projeto ou Redes compartilhadas comigo.

2. No campo Rede, selecione a rede que você quer usar.

3. No campo Sub-rede, selecione a sub-rede que você quer usar.

4. Para ativar um endereço IP externo, marque a caixa de seleção Ativar endereço IP externo. Se a rede especificada não tiver acesso à Internet ou você não ativar o endereço IP externo, ative o Acesso privado do Google na rede para usar essa instância.

5. Se você ainda não configurou uma conexão do Acesso a serviços privados para esta rede, clique em Configurar conexão e faça o seguinte:

   1. Na caixa de diálogo Criar uma conexão de acesso a serviços privados, ative a API Service Networking e clique em Ativar API. Se a API Service Networking já estiver ativada, clique em Continue.

   2. Na seção Alocar um intervalo de IP, conclua a caixa de diálogo para selecionar um ou mais intervalos de IP atuais, criar um novo ou usar um alocado automaticamente.

   3. Quando terminar, clique em Continuar.

   4. Na seção Criar uma conexão, revise a rede e o intervalo de IP alocado que você selecionou e clique em Criar conexão.

Configurar opções de segurança

Ative ou desative as seguintes opções:

• O nbconvert nbconvert permite que os usuários exportem e façam o download de um arquivo de notebook como um tipo de arquivo diferente, como HTML, PDF ou LaTeX.
• Download de arquivos da interface de notebook: essa configuração permite que os usuários façam o download de arquivos na interface do JupyterLab.
• Terminal: permite o acesso de terminal à instância de notebooks gerenciados a partir da interface do usuário do JupyterLab.

Termine de criar a instância

1. Clique em Criar.

   O Vertex AI Workbench inicia automaticamente a instância. Quando a instância estiver pronta para uso, o Vertex AI Workbench ativa um link Abrir JupyterLab.

Criar uma instância usando o Terraform

É possível criar uma instância de notebooks gerenciados usando o recurso do Terraform google_notebooks_runtime. Use o exemplo a seguir para criar uma nova instância de notebooks gerenciados chamada notebooks-runtime-basic.

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

resource "google_notebooks_runtime" "basic_runtime" {
  name     = "notebooks-runtime-basic"
  location = "us-central1"

  access_config {
    access_type   = "SINGLE_USER"
    runtime_owner = "[e-mail]"
  }

  virtual_machine {
    virtual_machine_config {
      machine_type = "n1-standard-4"
      data_disk {
        initialize_params {
          disk_size_gb = "100"
          disk_type    = "PD_STANDARD"
        }
      }
    }
  }
}

Abrir JupyterLab

Depois que você cria instância, o Vertex AI Workbench a inicia automaticamente. Quando a instância estiver pronta para uso, o Vertex AI Workbench ativa um link Abrir JupyterLab.

1. Ao lado do nome da instância de notebooks gerenciados, clique em Abrir JupyterLab.

2. Na primeira vez que você acessar a interface do usuário do JupyterLab de uma instância de notebooks gerenciados, será necessário conceder permissão do SDK do Cloud para acessar seus dados e autenticar sua instância de notebooks gerenciados.

   1. Na caixa de diálogo Autenticar seu notebook gerenciado, clique no botão para receber um código de autenticação.

   2. Escolha uma conta e clique em Permitir. Copie o código de autenticação.

   3. Na caixa de diálogo Autenticar seu notebook gerenciado, cole o código de autenticação e clique em Autenticar.

Sua instância de notebooks gerenciados abre o JupyterLab.

Abrir um novo arquivo de notebook

1. Selecione File > New > Notebook.

2. Na caixa de diálogo Selecionar kernel, selecione Python e clique em Selecionar.

3. O novo arquivo do notebook será aberto.

A seguir

• Teste um dos tutoriais incluídos na nova instância de notebooks gerenciados. No navegador de arquivos JupyterLab, navegador de arquivos, abra a pasta tutoriais e abra um dos arquivos de notebook.