Crie uma tarefa Node.js no Cloud Run

Crie uma tarefa Node.js no Cloud Run

Saiba como criar uma tarefa simples do Cloud Run e, em seguida, implementá-la a partir da origem, que automaticamente compacta o seu código numa imagem de contentor, carrega a imagem de contentor para o Artifact Registry e, em seguida, implementa-a no Cloud Run. Pode usar outros idiomas além dos apresentados.

Antes de começar

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.

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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Nota: se instalou a CLI gcloud anteriormente, certifique-se de que tem a versão mais recente executando gcloud components update.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Install the Google Cloud CLI.

Nota: se instalou a CLI gcloud anteriormente, certifique-se de que tem a versão mais recente executando gcloud components update.

Se estiver a usar um fornecedor de identidade (IdP) externo, tem primeiro de iniciar sessão na CLI gcloud com a sua identidade federada.

Para inicializar a CLI gcloud, execute o seguinte comando:

gcloud init

1. Enable the Cloud Run Admin API and Cloud Build APIs.

   Roles required to enable APIs

   To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

   Enable the APIs

   Depois de ativar a API Cloud Run Admin, a conta de serviço predefinida do Compute Engine é criada automaticamente.

2. Conceda à conta de serviço do Cloud Build a seguinte função do IAM.

   Clique para ver as funções necessárias para a conta de serviço do Cloud Build

   O Cloud Build usa automaticamente a conta de serviço predefinida do Compute Engine como a conta de serviço predefinida do Cloud Build para compilar o seu código-fonte e o recurso do Cloud Run, a menos que substitua este comportamento. Para que o Cloud Build compile as suas origens, peça ao administrador para conceder a função Cloud Run Builder (roles/run.builder) à conta de serviço predefinida do Compute Engine no seu projeto:

     gcloud projects add-iam-policy-binding PROJECT_ID \
         --member=serviceAccount:[e-mail] \
         --role=roles/run.builder
     

   Substitua PROJECT_NUMBER pelo seu Google Cloud número do projeto e PROJECT_ID pelo seu Google Cloud ID do projeto. Para ver instruções detalhadas sobre como encontrar o ID e o número do projeto, consulte o artigo Criar e gerir projetos.

   A concessão da função de criador do Cloud Run à conta de serviço predefinida do Compute Engine demora alguns minutos a propagar.

   Nota:

   A iam.automaticIamGrantsForDefaultServiceAccounts restrição da política da organização impede que a função de editor seja concedida automaticamente às contas de serviço predefinidas. Se tiver criado a sua organização após 3 de maio de 2024, esta restrição é aplicada por predefinição.

   Recomendamos vivamente que aplique esta restrição para desativar a concessão automática de funções. Se desativar a concessão automática de funções, tem de decidir que funções conceder às contas de serviço predefinidas e, em seguida, conceder estas funções manualmente.

   Se a conta de serviço predefinida já tiver a função de editor, recomendamos que substitua a função de editor por funções menos permissivas.Para modificar as funções da conta de serviço em segurança, use o Simulador de políticas para ver o impacto da alteração e, em seguida, conceda e revogue as funções adequadas.

3. Reveja os preços do Cloud Run ou estime os custos com a calculadora de preços.

Escrever a tarefa de exemplo

Para escrever um trabalho em Node.js:

1. Crie um novo diretório com o nome jobs e altere o diretório para este:

   mkdir jobs
   cd jobs
   

2. Crie um ficheiro package.json com o seguinte conteúdo:

   {
       "name": "jobs",
       "version": "1.0.0",
       "description": "Node.js sample for Cloud Run jobs",
       "main": "index.js",
       "scripts": {
           "start": "node index.js"
       },
       "engines": {
           "node": ">=16.0.0"
       },
       "author": "Google LLC",
       "license": "Apache-2.0"
   }
   

3. No mesmo diretório, crie um ficheiro index.js para o código do trabalho real. Copie as seguintes linhas de exemplo para o ficheiro:

   // Retrieve Job-defined env vars
   const {CLOUD_RUN_TASK_INDEX = 0, CLOUD_RUN_TASK_ATTEMPT = 0} = process.env;
   // Retrieve User-defined env vars
   const {SLEEP_MS, FAIL_RATE} = process.env;
   
   // Define main script
   const main = async () => {
     console.log(
       `Starting Task #${CLOUD_RUN_TASK_INDEX}, Attempt #${CLOUD_RUN_TASK_ATTEMPT}...`
     );
     // Simulate work
     if (SLEEP_MS) {
       await sleep(SLEEP_MS);
     }
     // Simulate errors
     if (FAIL_RATE) {
       try {
         randomFailure(FAIL_RATE);
       } catch (err) {
         err.message = `Task #${CLOUD_RUN_TASK_INDEX}, Attempt #${CLOUD_RUN_TASK_ATTEMPT} failed.\n\n${err.message}`;
         throw err;
       }
     }
     console.log(`Completed Task #${CLOUD_RUN_TASK_INDEX}.`);
   };
   
   // Wait for a specific amount of time
   const sleep = ms => {
     return new Promise(resolve => setTimeout(resolve, ms));
   };
   
   // Throw an error based on fail rate
   const randomFailure = rate => {
     rate = parseFloat(rate);
     if (!rate || rate < 0 || rate > 1) {
       console.warn(
         `Invalid FAIL_RATE env var value: ${rate}. Must be a float between 0 and 1 inclusive.`
       );
       return;
     }
   
     const randomFailure = Math.random();
     if (randomFailure < rate) {
       throw new Error('Task failed.');
     }
   };
   
   // Start script
   main().catch(err => {
     console.error(err);
     process.exit(1); // Retry Job Task by exiting the process
   });

   As tarefas do Cloud Run permitem que os utilizadores especifiquem o número de tarefas que a tarefa deve executar. Este código de exemplo mostra como usar a variável de ambiente CLOUD_RUN_TASK_INDEX incorporada. Cada tarefa representa uma cópia em execução do contentor. Tenha em atenção que as tarefas são normalmente executadas em paralelo. A utilização de várias tarefas é útil se cada tarefa puder processar independentemente um subconjunto dos seus dados.

   Cada tarefa tem conhecimento do respetivo índice, armazenado na variável de ambiente CLOUD_RUN_TASK_INDEX. A variável de ambiente CLOUD_RUN_TASK_COUNT incorporada contém o número de tarefas fornecidas no momento da execução do trabalho através do parâmetro --tasks.

   O código apresentado também mostra como repetir tarefas, usando a variável de ambiente CLOUD_RUN_TASK_ATTEMPT incorporada, que contém o número de vezes que esta tarefa foi repetida, começando em 0 para a primeira tentativa e aumentando 1 para cada repetição sucessiva, até --max-retries.

   O código também lhe permite gerar falhas como forma de testar as novas tentativas e gerar registos de erros para que possa ver como são.

4. Crie um Procfile com o seguinte conteúdo:

   # Define the application's entrypoint to override default, `npm start`
   # https://github.com/GoogleCloudPlatform/buildpacks/issues/160
   web: node index.js
   

O seu código está completo e pronto para ser incluído num contentor.

Crie um contentor de tarefas de compilação, envie-o para o Artifact Registry e implemente-o no Cloud Run

Importante: este início rápido pressupõe que tem funções de proprietário ou editor no projeto que está a usar para o início rápido. Caso contrário, consulte a função de programador de origem do Cloud Run para ver as autorizações necessárias para implementar um recurso do Cloud Run a partir da origem.

Este início rápido usa a implementação a partir da origem, que cria o contentor, carrega-o para o Artifact Registry e implementa a tarefa no Cloud Run:

gcloud run jobs deploy job-quickstart \
    --source . \
    --tasks 50 \
    --set-env-vars SLEEP_MS=10000 \
    --set-env-vars FAIL_RATE=0.1 \
    --max-retries 5 \
    --region REGION \
    --project=PROJECT_ID

onde PROJECT_ID é o ID do seu projeto e REGION é a sua região, por exemplo, europe-west1. Tenha em atenção que pode alterar os vários parâmetros para os valores que quiser usar para fins de teste. SLEEP_MS simula o trabalho e FAIL_RATE faz com que X% das tarefas falhem para que possa experimentar o paralelismo e tentar novamente as tarefas com falhas.

Execute uma tarefa no Cloud Run

Para executar a tarefa que acabou de criar:

gcloud run jobs execute job-quickstart --region REGION

Substitua REGION pela região que usou quando criou e implementou a tarefa, por exemplo, europe-west1.

Êxito: criou e executou uma tarefa com o tempo de execução do Node.js no Cloud Run.

Limpar

Para evitar custos adicionais na sua conta do Google Cloud , elimine todos os recursos implementados com este início rápido.

Elimine o seu repositório

O Cloud Run só cobra pelo tempo de execução da sua tarefa. No entanto, ainda pode ser cobrado pelo armazenamento da imagem do contentor no Artifact Registry. Para eliminar repositórios do Artifact Registry, siga os passos em Eliminar repositórios na documentação do Artifact Registry.

Elimine a sua tarefa

As tarefas do Cloud Run só incorrem em custos quando uma tarefa está a ser executada. Para eliminar a tarefa do Cloud Run, siga um destes passos:

Consola

Para eliminar uma tarefa:

1. Na Google Cloud consola, aceda ao Cloud Run:

   Aceda ao Cloud Run

2. Localize a tarefa que quer eliminar na lista de tarefas e clique na caixa de verificação para a selecionar.

3. Clique em Eliminar. Esta ação termina todas as execuções de tarefas em curso e todas as instâncias de contentores em execução.

gcloud

Para eliminar uma tarefa, execute o seguinte comando:

gcloud run jobs delete JOB_NAME

Substitua JOB_NAME pelo nome da tarefa.

Elimine o projeto de teste

A eliminação do seu projeto Google Cloud interrompe a faturação de todos os recursos nesse projeto. Para libertar todos os Google Cloud recursos no seu projeto, siga estes passos:

Atenção: a eliminação de um projeto tem os seguintes efeitos:
• Tudo no projeto é eliminado. Se usou um projeto existente para as tarefas neste documento, quando o elimina, também elimina qualquer outro trabalho que tenha feito no projeto.
• Os IDs dos projetos personalizados são perdidos. Quando criou este projeto, pode ter criado um ID do projeto personalizado que quer usar no futuro. Para preservar os URLs que usam o ID do projeto, como um URL appspot.com, elimine os recursos selecionados no projeto em vez de eliminar o projeto inteiro.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

O que se segue?

Para mais informações sobre a criação de um contentor a partir do código-fonte e o envio para um repositório, consulte:

• Desenvolver serviços do Cloud Run
• Criar contentores
• Teste um serviço do Cloud Run localmente
• Implementação a partir do código-fonte