Usar um script pós-inicialização

Este guia descreve como usar um script pós-inicialização com o Colab Enterprise. Este guia também descreve como definir variáveis de ambiente para uso com o script de pós-inicialização.

Visão geral

É possível usar um script pós-inicialização para realizar tarefas depois de inicializar o ambiente de execução do Colab Enterprise. Por exemplo, você pode usar um script pós-inicialização para instalar pacotes específicos ou fazer mudanças específicas na VM do seu ambiente de execução.

Para usar um script pós-inicialização no Colab Enterprise, especifique o script de inicialização ao criar um modelo de ambiente de execução. Depois, ao criar um ambiente de execução com base nesse modelo, o script pós-inicialização é executado no final do processo de inicialização.

Local do script pós-inicialização

O URI do script pós-inicialização pode ser qualquer um dos seguintes:

  • Um URI do Cloud Storage: por exemplo, gs://BUCKET_NAME/SCRIPT_FILE_NAME. Se o script pós-inicialização estiver armazenado no Cloud Storage, use um ambiente de execução com credenciais de usuário final ativadas. Isso acontece porque o Colab Enterprise usa suas credenciais de usuário para acessar o bucket do Cloud Storage.
  • Um URL HTTPS: por exemplo, https://example.com/FOLDER_NAME/SCRIPT_FILE_NAME. Não é possível usar um URL HTTPS ao criar seu modelo de tempo de execução usando o console do Google Cloud .

Comportamento do script de pós-inicialização

É possível especificar o comportamento do script pós-inicialização. Confira a tabela a seguir:

Comportamento Descrição
Executar uma vez (RUN_ONCE)

Padrão. O Colab Enterprise executa o script pós-inicialização apenas uma vez, durante a criação do ambiente de execução.

Executar a cada início (RUN_EVERY_START)

Depois de cada inicialização, o Colab Enterprise executa o script pós-inicialização. Por exemplo, se o encerramento por inatividade interromper o ambiente de execução, o Colab Enterprise vai executar o script pós-inicialização novamente quando o ambiente de execução for reiniciado.

Fazer o download e executar a cada inicialização (DOWNLOAD_AND_RUN_EVERY_START)

Após cada inicialização, o Colab Enterprise baixa novamente o script pós-inicialização da origem e o executa.

Variáveis de ambiente

É possível especificar variáveis de ambiente no modelo de ambiente de execução e se referir a elas no script pós-inicialização.

Por exemplo, é possível definir o projeto de cota usando uma variável de ambiente. É possível definir o projeto de cota para um ID do projeto específico usando GOOGLE_CLOUD_QUOTA_PROJECT, uma variável comum usada em bibliotecas de cliente Google Cloud.

Para usar um script pós-inicialização com variáveis de ambiente, consulte Criar um modelo de execução com um script pós-inicialização e variáveis de ambiente.

Acompanhar mudanças e recuperar scripts de pós-inicialização

Para monitorar mudanças no script de pós-inicialização e permitir a recuperação de uma versão específica do script de pós-inicialização, armazene o script de pós-inicialização em um bucket do Cloud Storage com o controle de versões de objetos ativado. O controle de versões de objetos preserva objetos excluídos como objetos não atuais e com controle de versão que permanecem acessíveis no bucket até serem removidos explicitamente.

Para especificar uma versão do script pós-inicialização, adicione #GENERATION_NUMBER ao URI do script ao criar o modelo de ambiente de execução. Por exemplo, gs://BUCKET_NAME/FOLDER_NAME/FILE_NAME.py#GENERATION_NUMBER. Para mais informações sobre o controle de versões de objetos e números de geração, consulte Controle de versões de objetos.

Não é possível especificar um número de geração para o script pós-inicialização ao usar o console do Google Cloud para criar o modelo de ambiente de execução.

Antes de começar

  1. Faça login na sua conta do Google Cloud . Se você começou a usar o Google Cloud, crie uma conta para avaliar o desempenho de nossos produtos em situações reais. Clientes novos também recebem US$ 300 em créditos para executar, testar e implantar cargas de trabalho.

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Agent Platform, Dataform, and Compute Engine APIs.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

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

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Agent Platform, Dataform, and Compute Engine APIs.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the APIs

    8.

Funções exigidas

Para receber as permissões necessárias para criar um modelo de ambiente de execução no Colab Enterprise, peça ao administrador para conceder a você o papel do IAM de Administrador do Colab Enterprise (roles/aiplatform.colabEnterpriseAdmin) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias usando papéis personalizados ou outros papéis predefinidos.