Criar jobs

Console

Para criar um novo job, siga estas etapas:

1. No console do Google Cloud , acesse a página de jobs do Cloud Run:

   Acessar jobs do Cloud Run

2. Clique em Implantar contêiner para exibir o formulário Criar job.

3. No formulário, especifique a imagem do contêiner que contém o código do job ou selecione uma opção em uma lista de contêineres implantados anteriormente.

4. O nome do job é gerado automaticamente a partir da imagem do contêiner. É possível editar o nome do job conforme necessário no formulário. Depois de enviar o formulário, não é possível editar o nome do job.

5. No campo Região, Selecione a região para seu job. O seletor de região destaca regiões com o menor impacto de carbono.

6. Especifique o número de tarefas a serem executadas no job. Todas as tarefas precisam ser bem-sucedidas para que o job seja concluído. Por padrão, as tarefas são executadas em paralelo.

7. Clique em Contêineres, rede e segurança para definir outras propriedades do job.

8. Na seção Editar contêiner, configure as seguintes opções nas guias apropriadas:

   • Configuração do contêiner
   • Limites de CPU
   • Limites de memória
   • Secrets
   • Variáveis de ambiente
   • Marcadores
   • Contas de serviço
   • Conexões do Cloud SQL
   • Conectividade VPC

9. Na seção Capacidade da tarefa, especifique o seguinte:

   1. No campo Tempo limite da tarefa, especifique o período máximo em segundos em que a tarefa pode ser executada (até 168 horas ou 7 dias). Para tarefas que usam GPUs, o tempo limite máximo disponível é de 1 hora. Cada tarefa precisa ser concluída nesse período. O padrão é 10 minutos.

   2. No campo Número de novas tentativas por tarefa com falha, especifique o número de novas tentativas em caso de falhas de tarefa. O padrão é três novas tentativas.

10. Em Paralelismo, selecione Executar o máximo possível de tarefas simultaneamente se você precisar definir um limite menor devido a restrições de escalonamento nos recursos acessados pelo job ou selecione Limitar o número máximo de tarefas simultâneas e especifique o número de tarefas simultâneas no campo Limite de paralelismo personalizado.

11. Quando terminar a configuração, clique em Criar para criar o job no Cloud Run.

12. Para executar o job, consulte Executar jobs ou executar jobs em uma programação.

gcloud

Para usar a linha de comando, você precisa já ter configurado a CLI gcloud.

Para criar um novo job, siga estas etapas:

1. Execute o comando:

   gcloud run jobs create JOB --image IMAGE_URL OPTIONS

   Outra possibilidade é usar o comando de implantação:

   gcloud run jobs deploy JOB --image IMAGE_URL OPTIONS

   Substitua:

   • JOB: o nome do seu job do Cloud Run;
   • IMAGE_URL: uma referência à imagem do contêiner. Por exemplo, us-docker.pkg.dev/cloudrun/container/job:latest.

   • OPTIONS (opcional): qualquer uma das seguintes opções:

     Opção	Descrição
     --tasks	Aceita números inteiros maiores ou iguais a 1. o padrão é 1; o máximo é de 10.000. Cada tarefa recebe as variáveis de ambiente CLOUD_RUN_TASK_INDEX com um valor entre 0 e o número de tarefas menos 1, além de CLOUD_RUN_TASK_COUNT, que é o número de tarefas
     --max-retries	O número de novas tentativas de uma tarefa com falha. Quando uma tarefa falha além desse limite, todo o job é marcado como falha. Por exemplo, se for definida como 1, uma tarefa com falha será repetida por duas tentativas, no total de duas tentativas. o padrão é 3; Aceita números inteiros de 0 a 10.
     --task-timeout	Aceita uma duração como "2s". O padrão é 10 minutos; o máximo é de 168 horas (7 dias). Para tarefas que usam GPUs, o tempo limite máximo disponível é de 1 hora.
     --parallelism	O número máximo de tarefas que podem ser executadas em paralelo. Por padrão, as tarefas serão iniciadas o mais rápido possível em paralelo. Consulte Paralelismo para ver o intervalo de valores.
     --execute-now	Se definido, imediatamente após a criação do job, uma execução de job será iniciada. Isso equivale a chamar gcloud run jobs create seguido de gcloud run jobs execute.

     Além das opções acima, você também define outras configurações, como variáveis de ambiente ou limites de memória.

     Para ver uma lista completa das opções disponíveis ao criar um job, consulte a documentação da linha de comando gcloud run jobs create.

2. Aguarde a conclusão da criação do job. Você verá uma mensagem de conclusão bem-sucedida.

3. Para executar o job, consulte Executar jobs ou executar jobs em uma programação.

YAML

É possível armazenar a especificação do job em um arquivo YAML e implantá-la usando a CLI gcloud.

1. Crie um novo arquivo job.yaml com este conteúdo:

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: JOB
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: IMAGE_URL

   Substitua:

   • JOB: o nome do seu job do Cloud Run;
   • IMAGE_URL: uma referência à imagem do contêiner. Por exemplo, us-docker.pkg.dev/cloudrun/container/job:latest.

   Também é possível definir outras configurações, como variáveis de ambiente ou limites de memória.

2. Implante o novo job executando o seguinte comando:

   gcloud run jobs replace job.yaml

Terraform

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

resource "google_cloud_run_v2_job" "default" {
  name     = "cloud-run-job"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    template {
      containers {
        image = "us-docker.pkg.dev/cloudrun/container/job:latest"
      }
    }
  }
}

Bibliotecas de cliente

Para criar um job com base no código, siga estas etapas:

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

API REST

Para criar um job, envie uma solicitação HTTP POST para o endpoint jobs da API Cloud Run Admin.

Por exemplo, usando curl:

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X POST \
  -d '{template: {template: {containers: [{image: "IMAGE_URL"}]}}}' \
  https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs?jobId=JOB

Substitua:

• ACCESS_TOKEN: um token de acesso válido para uma conta com as permissões do IAM para criar jobs. Por exemplo, se você fez login no gcloud, é possível recuperar um token de acesso usando gcloud auth print-access-token. Em uma instância de contêiner do Cloud Run, é possível recuperar um token de acesso por meio do servidor de metadados da instância de contêiner.
• IMAGE_URL: uma referência à imagem do contêiner. Por exemplo, us-docker.pkg.dev/cloudrun/container/job:latest.
• PROJECT_ID: o ID do projeto do Google Cloud .
• REGION: a Google Cloud região do job.
• JOB: o nome do job que você quer criar.

Console

Para atualizar um job, siga estas etapas:

1. No console do Google Cloud , acesse a página de jobs do Cloud Run:

   Acessar jobs do Cloud Run

2. Clique no job para exibir a página de detalhes.

3. Clique em Ver e editar a configuração do job.

4. Se necessário, mude o número de tarefas no job.

5. Opcional: clique em Contêineres, rede e segurança para atualizar outras propriedades do job:

   • Configuração do contêiner
   • Limites de CPU
   • Limites de memória
   • Secrets
   • Variáveis de ambiente
   • Marcadores
   • Contas de serviço
   • Conexões do Cloud SQL
   • Conectividade VPC

6. Na seção Capacidade da tarefa, especifique o seguinte:

   1. No campo Tempo limite da tarefa, especifique o período máximo em segundos em que a tarefa pode ser executada (até 168 horas ou 7 dias). Para tarefas que usam GPUs, o tempo limite máximo disponível é de 1 hora. Cada tarefa precisa ser concluída nesse período. O padrão é 10 minutos.

   2. No campo Número de novas tentativas por tarefa com falha, especifique o número de novas tentativas em caso de falhas de tarefa. O padrão é três novas tentativas.

7. Em Paralelismo, selecione Executar o máximo possível de tarefas simultaneamente se você precisar definir um limite menor devido a restrições de escalonamento nos recursos acessados pelo job ou selecione Limitar o número máximo de tarefas simultâneas e especifique o número de tarefas simultâneas no campo Limite de paralelismo personalizado.

8. Quando terminar de configurar o job, clique em Atualizar para modificar o job no Cloud Run e aguarde a conclusão da criação.

9. Para executar o job, consulte Executar jobs ou executar jobs em uma programação.

gcloud

1. No console do Google Cloud , ative o Cloud Shell.

   Ativar o Cloud Shell

   Na parte de baixo do console Google Cloud , uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

2. Execute este comando:

   gcloud run jobs update JOB

   Substitua:

   • JOB: o nome do seu job do Cloud Run;

   • OPTIONS (opcional): com as seguintes opções:

     Opção	Descrição
     --tasks	Aceita números inteiros iguais ou maiores que 1. o padrão é 1; o máximo é de 10.000. Cada tarefa recebe as variáveis de ambiente CLOUD_RUN_TASK_INDEX com um valor entre 0 e o número de tarefas menos 1, além de CLOUD_RUN_TASK_COUNT, que é o número de tarefas
     --max-retries	O número de novas tentativas de uma tarefa com falha. Quando uma tarefa falha além desse limite, todo o job é marcado como falha. Por exemplo, se for definida como 1, uma tarefa com falha será repetida por duas tentativas, no total de duas tentativas. O padrão é 3. Aceita números inteiros de 0 a 10.
     --task-timeout	Aceita uma duração como "2s". O padrão é 10 minutos; o máximo é de 168 horas (7 dias).
     --parallelism	O número máximo de tarefas que podem ser executadas em paralelo. Por padrão, as tarefas serão iniciadas o mais rápido possível em paralelo. Consulte Paralelismo para ver o intervalo de valores.

   Além das opções anteriores, você pode definir outras configurações opcionais:

   • Configuração do contêiner
   • Limites de CPU
   • Limites de memória
   • Secrets
   • Variáveis de ambiente
   • Marcadores
   • Contas de serviço
   • Conexões do Cloud SQL
   • Conexão VPC

   Para ver uma lista completa das opções disponíveis ao criar um job, consulte a documentação da linha de comando gcloud run jobs create.

3. Aguarde a conclusão da atualização do job. Após a conclusão, será exibida uma mensagem semelhante a esta:

   Job [JOB] has been successfully updated.
   View details about this job by running `gcloud run jobs describe JOB`.
   See logs for this execution at: https://console.cloud.google.com/logs/viewer?project=PROJECT_ID&resource=cloud_run_revision/service_name/JOB

4. Para executar o job, consulte Executar jobs ou executar jobs em uma programação.

YAML

1. Se você precisar fazer o download ou visualizar a configuração de um job que já existe, execute o comando a seguir para salvar os resultados em um arquivo YAML:

   gcloud run jobs describe JOB --format export > job.yaml

2. Modifique os atributos filhos spec.template conforme necessário e reimplante executando o seguinte comando:

   gcloud run jobs replace job.yaml

   Por padrão, o comando gcloud run jobs replace usa o arquivo job.yaml, se ele estiver presente.

3. Para executar o job, consulte Executar jobs ou executar jobs em uma programação.

Terraform

Faça alterações na configuração do job no arquivo main.tf usando o comando terraform apply. As instruções detalhadas do Terraform estão disponíveis para:

• Paralelismo
• Máximo de novas tentativas
• Tempos limite

Para mais informações, consulte as opções de linha de comando terraform apply.

Bibliotecas de cliente

Para atualizar um job atual a partir do código, siga estas etapas:

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

API REST

Para atualizar um job, envie uma solicitação HTTP PATCH para o endpoint jobs da API Cloud Run Admin.

Por exemplo, usando curl:

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X PATCH \
  -d '{template: {template: {containers: [{image: "IMAGE_URL"}]}}}' \
  https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB

Substitua:

• ACCESS_TOKEN: um token de acesso válido para uma conta com as permissões do IAM para atualizar jobs. Por exemplo, se você fez login no gcloud, é possível recuperar um token de acesso usando gcloud auth print-access-token. Em uma instância de contêiner do Cloud Run, é possível recuperar um token de acesso por meio do servidor de metadados da instância de contêiner.
• IMAGE_URL: uma referência à imagem do contêiner. Por exemplo, us-docker.pkg.dev/cloudrun/container/job:latest.
• PROJECT_ID: o ID do projeto do Google Cloud .
• REGION: a Google Cloud região do job.
• JOB: o nome do job que você quer atualizar.

Console

1. No console do Google Cloud , acesse a página de jobs do Cloud Run:

   Acessar jobs do Cloud Run

2. Para implantar em um job atual, clique em Jobs. Localize o job na lista e clique para abrir. Em seguida, clique em Ver e editar configuração para mostrar o formulário de edição do job.

3. Para um novo job, clique em Implantar contêiner. Forneça o URL da imagem do contêiner e o nome do job.

4. Clique em Contêineres, rede, segurança.

5. No card Editar contêiner, configure o contêiner de job principal conforme necessário.

6. Clique em Adicionar contêiner e configure um contêiner secundário que você quer adicionar com o contêiner de job principal. Se o sidecar depender de outro contêiner no serviço, indique isso no menu suspenso Ordem de inicialização do contêiner. Repita essa etapa para cada contêiner secundário que estiver implantando.

7. Clique em Criar para um novo serviço ou Atualizar para um job atual e aguarde a conclusão da implantação.

gcloud

1. No console do Google Cloud , ative o Cloud Shell.

   Ativar o Cloud Shell

   Na parte de baixo do console Google Cloud , uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

2. Para implantar vários contêineres em um job, execute o seguinte comando:

   gcloud run jobs create JOB \
    --container JOB_CONTAINER_NAME \
    --image='IMAGE_URL' \
    --container SIDECAR_CONTAINER_NAME \
    --image='SIDECAR_IMAGE'

   Substitua:

   • JOB: o nome do seu job do Cloud Run;
   • JOB_CONTAINER_NAME: um nome para o contêiner do job principal.
   • IMAGE_URL: uma referência à imagem do contêiner. Por exemplo, us-docker.pkg.dev/cloudrun/container/job:latest.
   • SIDECAR_CONTAINER_NAME: um nome para o contêiner sidecar, por exemplo, sidecar.
   • SIDECAR_IMAGE: uma referência à imagem do contêiner secundário.

   Se você quiser configurar cada contêiner no comando de implantação, forneça a configuração de cada contêiner após os parâmetros container, por exemplo:

   gcloud run jobs create JOB \
     --container CONTAINER_1_NAME \
     --image='IMAGE_URL' \
     --set-env-vars=KEY=VALUE \
     --container SIDECAR_CONTAINER_NAME \
     --image='SIDECAR_IMAGE' \
     --set-env-vars=KEY_N=VALUE_N

3. Aguarde a conclusão da implantação dos jobs. Após a conclusão, uma mensagem de sucesso é exibida.

YAML

1. Se você estiver criando um novo serviço, pule esta etapa. Se você estiver atualizando um serviço existente, faça o download da configuração YAML correspondente:

   gcloud run jobs describe JOB --format export > job.yaml

2. Atualize os atributos containers::

   apiVersion: run.googleapis.com/v1
   kind: Job
   metadata:
     name: JOB
   spec:
     template:
       spec:
         containers:
         - image: IMAGE_URL
         - image: SIDECAR_IMAGE
   

   Substitua:

   • JOB: o nome do seu job do Cloud Run;
   • IMAGE_URL: uma referência à imagem do contêiner. Por exemplo, us-docker.pkg.dev/cloudrun/container/job:latest.
   • SIDECAR_IMAGE: uma referência à imagem do contêiner de arquivo secundário.

3. Crie ou atualize o serviço usando o seguinte comando:

   gcloud run jobs replace job.yaml

   Por padrão, o comando gcloud run jobs replace usa o arquivo job.yaml, se ele estiver presente.

Terraform

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

resource "google_cloud_run_v2_job" "default" {
  name     = "JOB"
  location = "europe-west1"

  template {
    template {
      containers {
        name = "CONTAINER_NAME"
        image = "IMAGE_URL"
      }
      containers {
        name = "SIDECAR_CONTAINER_NAME"
        image = "SIDECAR_IMAGE_URL"
      }
    }
  }
}

Substitua:

• JOB: o nome do seu job do Cloud Run;
• CONTAINER_NAME: o nome do contêiner.
• IMAGE_URL: uma referência à imagem do contêiner. Por exemplo, us-docker.pkg.dev/cloudrun/container/job:latest.
• SIDECAR_CONTAINER_NAME: o nome do contêiner sidecar.
• SIDECAR_IMAGE_URL: uma referência à imagem do contêiner secundário.