Neste documento, explicamos os conceitos básicos da criação de jobs no Batch: como criar e executar um job baseado em um script ou imagem de contêiner e usar variáveis predefinidas e personalizadas. Para saber mais sobre como criar e executar jobs, consulte Visão geral da criação e execução de jobs.
Antes de começar
- Se você nunca usou o Batch, leia Primeiros passos com o Batch e ative-o concluindo os pré-requisitos para projetos e usuários.
-
Para receber as permissões necessárias para criar um job, peça ao administrador para conceder a você os seguintes papéis do IAM:
-
Editor de jobs em lote (
roles/batch.jobsEditor
) no projeto -
Usuário da conta de serviço (
roles/iam.serviceAccountUser
) na conta de serviço do job, que, por padrão, é a conta de serviço padrão do Compute Engine
Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.
Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.
-
Editor de jobs em lote (
-
Sempre que você criar um job, verifique se ele tem uma configuração de rede válida.
- Se você não tiver nenhum requisito de rede específico para sua carga de trabalho ou projeto e não tiver modificado a rede padrão do projeto, nenhuma ação será necessária.
- Caso contrário, você precisará configurar a rede ao criar um job. Aprenda a configurar a rede para um job antes de criar um job básico. Assim, é possível modificar os exemplos abaixo para atender aos requisitos de rede.
-
Sempre que você criar um job, verifique se ele tem um ambiente
de sistema operacional (SO) de VM válido.
- Se você não tiver nenhum requisito específico de imagem do SO da VM ou de disco de inicialização para sua carga de trabalho ou projeto, nenhuma ação será necessária.
- Caso contrário, você precisará preparar uma opção válida de ambiente do SO da VM. Antes de criar um job básico, permita a configuração padrão do ambiente do SO da VM ou aprenda a personalizar esse ambiente para modificar os exemplos abaixo de acordo com seus requisitos.
Criar um job básico
Para informações sobre todos os campos que podem ser especificados para um job, consulte a
documentação de referência para o
recurso REST projects.locations.jobs
.
Para resumir, um job consiste em uma matriz de uma ou mais tarefas que executam um ou mais executáveis, que são scripts executáveis e/ou contêineres do job.
Para abordar o básico, esta seção explica como criar um job de exemplo com
apenas um executável, um script ou uma imagem de contêiner:
- Se você quiser usar o Batch para gravar jobs que executam uma imagem de contêiner, consulte Criar um job de contêiner.
- Caso você não tenha certeza se quer usar imagens de contêiner ou não tem familiaridade com contêineres, é recomendável criar um job de script.
O job de exemplo para os dois tipos de jobs contém um grupo de tarefas com uma matriz de quatro tarefas. Cada tarefa imprime uma mensagem e o índice dela na saída padrão e no Cloud Logging. A definição desse job especifica um paralelismo de 2, que indica que o job precisa ser executado em duas VMs para permitir que duas tarefas sejam executadas de cada vez.
Criar um job de contêiner básico
Selecione ou crie uma imagem de contêiner para fornecer o código e as dependências para que o job seja executado em qualquer ambiente de computação. Para mais informações, consulte Como trabalhar com imagens de contêiner e Como executar contêineres em instâncias de VM.
É possível criar um job de contêiner básico usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Console
Para criar um job de contêiner básico usando o console do Google Cloud, faça o seguinte:
No console do Google Cloud, acesse a página Lista de jobs.
Clique em
Criar. A página Criar job em lote é aberta. No painel esquerdo, a página Detalhes do job é selecionada.Configure a página Detalhes do job:
Opcional: no campo Nome do job, personalize o nome.
Por exemplo, insira
example-basic-job
.Configure a seção Detalhes da tarefa:
Na janela Novo executável, adicione pelo menos um script ou contêiner para que esse job seja executado.
Por exemplo, para adicionar um contêiner, faça o seguinte:
Selecione URL da imagem do contêiner (padrão).
No campo URL da imagem do contêiner, insira o URL de uma imagem de contêiner que você quer executar para cada tarefa deste job.
Por exemplo, para usar a imagem do contêiner
busybox
do Docker, insira o seguinte URL:gcr.io/google-containers/busybox
Opcional: para substituir o comando
ENTRYPOINT
da imagem do contêiner, insira um comando no campo Ponto de entrada.Por exemplo, digite o seguinte:
/bin/sh
Opcional: para modificar o comando
CMD
da imagem do contêiner, faça o seguinte:Marque a caixa de seleção Substituir o comando CMD da imagem do contêiner. Uma caixa de texto será exibida.
Na caixa de texto, insira um ou mais comandos, separando cada um com uma nova linha.
Por exemplo, digite os seguintes comandos:
-c echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
Clique em Concluído.
No campo Contagem de tarefas, insira o número de tarefas desse job. O valor precisa ser um número inteiro entre
1
e o limite de tarefas por grupo de tarefas.Por exemplo, insira
4
.No campo Paralelismo, insira o número de tarefas a serem executadas simultaneamente. Esse número não pode ser maior que o total de tarefas. Ele precisa ser um número inteiro entre
1
e as tarefas paralelas por limite de jobs.Por exemplo, insira
2
.
Configure a página Especificações de recursos:
No painel à esquerda, clique em Especificações do recurso. A página Especificações de recursos é aberta.
Na seção Modelo de provisionamento de VM, selecione uma das seguintes opções para o modelo de provisionamento das VMs deste job:
Se o job oferecer suporte à preempção e você quiser VMs de desconto, selecione Spot.
Caso contrário, selecione Padrão.
Por exemplo, selecione Padrão.
Selecione o local deste job:
No campo Região, selecione uma região.
Por exemplo, selecione
us-central1 (Iowa)
(padrão).No campo Zona, siga um destes procedimentos:
Se você quiser restringir a execução desse job apenas em uma zona específica, selecione uma zona.
Caso contrário, selecione qualquer um.
Por exemplo, selecione qualquer um (padrão).
Selecione uma das seguintes famílias de máquinas:
Para cargas de trabalho comuns, clique em Uso geral.
Para cargas de trabalho que exigem alto desempenho, clique em Otimização para computação.
Para cargas de trabalho com uso intensivo de memória, clique em Otimização de memória.
Por exemplo, clique em Uso geral (padrão).
No campo Série, selecione uma série de máquinas para as VMs deste job.
Por exemplo, se você selecionou Uso geral para a família de máquinas, selecione E2 (padrão).
No campo Tipo de máquina, selecione um tipo de máquina para as VMs desse job.
Por exemplo, se você tiver selecionado E2 para a série de máquinas, selecione e2-medium (2 vCPU, 4 GB de memória) (padrão).
Configure a quantidade de recursos de VM necessários para cada tarefa:
No campo Núcleos, insira a quantidade de vCPUs por tarefa.
Por exemplo, digite
1
(padrão).No campo Memória, insira a quantidade de RAM em GB por tarefa.
Por exemplo, digite
0.5
(padrão).
Opcional: para revisar a configuração do job, clique em Visualizar no painel esquerdo.
Clique em Criar.
A página Detalhes do job exibe o job que você criou.
gcloud
Para criar um job de contêiner básico usando a CLI gcloud, faça o seguinte:
Crie um arquivo JSON que especifique os detalhes de configuração do job. Por exemplo, para criar um job de contêiner básico, crie um arquivo JSON com o conteúdo a seguir. Para mais informações sobre todos os campos que podem ser especificados para um job, consulte a documentação de referência para o recurso REST
projects.locations.jobs
.{ "taskGroups": [ { "taskSpec": { "runnables": [ { "container": { CONTAINER } } ], "computeResource": { "cpuMilli": CORES, "memoryMib": MEMORY }, "maxRetryCount": MAX_RETRY_COUNT, "maxRunDuration": "MAX_RUN_DURATION" }, "taskCount": TASK_COUNT, "parallelism": PARALLELISM } ] }
Substitua:
CONTAINER
: o contêiner que cada tarefa executa.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que geralmente representam metade de um núcleo físico, para alocar para cada tarefa em unidades de miliCPU. Se o campocpuMilli
não for especificado, o valor será definido como2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a ser alocada para cada tarefa em MB. Se o campomemoryMib
não for especificado, o valor será definido como2000
(2 GB).MAX_RETRY_COUNT
: opcional. O número máximo de novas tentativas de uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será definido como0
, o que significa não repetir a tarefa. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefa.MAX_RUN_DURATION
: opcional. O tempo máximo que uma tarefa pode ser executada antes de ser repetida ou falhar, formatado como um valor em segundos seguido pors
. Por exemplo,3600s
por uma hora. Se o campomaxRunDuration
não for especificado, o valor será definido como o tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limitar tempos de execução de tarefas e executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas do job. O valor precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se o campotaskCount
não for especificado, o valor será definido como1
.PARALLELISM
: opcional. O número de tarefas que o job executa simultaneamente. O número não pode ser maior que o número de tarefas e precisa ser um número inteiro entre1
e as tarefas paralelas por limite de jobs. Se o campoparallelism
não for especificado, o valor será definido como1
.
Crie um job usando o comando
gcloud batch jobs submit
.gcloud batch jobs submit JOB_NAME \ --location LOCATION \ --config JSON_CONFIGURATION_FILE
Substitua:
JOB_NAME
: o nome do job.LOCATION
: o local do job.JSON_CONFIGURATION_FILE
: o caminho de um arquivo JSON com os detalhes de configuração do job.
Por exemplo, para criar um job que execute tarefas usando a
imagem do contêiner busybox
do Docker:
Crie um arquivo JSON no diretório atual chamado
hello-world-container.json
com o seguinte conteúdo:{ "taskGroups": [ { "taskSpec": { "runnables": [ { "container": { "imageUri": "gcr.io/google-containers/busybox", "entrypoint": "/bin/sh", "commands": [ "-c", "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks." ] } } ], "computeResource": { "cpuMilli": 2000, "memoryMib": 16 }, "maxRetryCount": 2, "maxRunDuration": "3600s" }, "taskCount": 4, "parallelism": 2 } ], "allocationPolicy": { "instances": [ { "policy": { "machineType": "e2-standard-4" } } ] }, "labels": { "department": "finance", "env": "testing" }, "logsPolicy": { "destination": "CLOUD_LOGGING" } }
Execute este comando:
gcloud batch jobs submit example-container-job \ --location us-central1 \ --config hello-world-container.json
API
Para criar um job de contêiner básico usando a API Batch, use o método jobs.create
.
Para mais informações sobre todos os campos que podem ser especificados para um job, consulte a
documentação de referência para o recurso REST projects.locations.jobs
.
POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs?job_id=JOB_NAME
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"container": {
CONTAINER
}
}
],
"computeResource": {
"cpuMilli": CORES,
"memoryMib": MEMORY
},
"maxRetryCount": MAX_RETRY_COUNT,
"maxRunDuration": "MAX_RUN_DURATION"
},
"taskCount": TASK_COUNT,
"parallelism": PARALLELISM
}
]
}
Substitua:
PROJECT_ID
: o ID do projeto (link em inglês).LOCATION
: o local do job.JOB_NAME
: o nome do job.CONTAINER
: o contêiner que cada tarefa executa.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que geralmente representam metade de um núcleo físico, para alocar para cada tarefa em unidades de miliCPU. Se o campocpuMilli
não for especificado, o valor será definido como2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a ser alocada para cada tarefa em MB. Se o campomemoryMib
não for especificado, o valor será definido como2000
(2 GB).MAX_RETRY_COUNT
: opcional. O número máximo de novas tentativas de uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será definido como0
, o que significa não repetir a tarefa. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefa.MAX_RUN_DURATION
: opcional. O tempo máximo que uma tarefa pode ser executada antes de ser repetida ou falhar, formatado como um valor em segundos seguido pors
. Por exemplo,3600s
por uma hora. Se o campomaxRunDuration
não for especificado, o valor será definido como o tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limitar tempos de execução de tarefas e executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas do job, que precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se o campotaskCount
não for especificado, o valor será definido como1
.PARALLELISM
: opcional. O número de tarefas que o job executa simultaneamente. Esse número não pode ser maior que o de tarefas. Ele precisa ser um número inteiro entre1
e as tarefas paralelas por limite de jobs. Se o campoparallelism
não for especificado, o valor será definido como1
.
Por exemplo, para criar um job que execute tarefas usando a
imagem do contêiner busybox
do Docker,
use a seguinte solicitação:
POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/jobs?job_id=example-container-job
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"container": {
"imageUri": "gcr.io/google-containers/busybox",
"entrypoint": "/bin/sh",
"commands": [
"-c",
"echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
]
}
}
],
"computeResource": {
"cpuMilli": 2000,
"memoryMib": 16
},
"maxRetryCount": 2,
"maxRunDuration": "3600s"
},
"taskCount": 4,
"parallelism": 2
}
],
"allocationPolicy": {
"instances": [
{
"policy": { "machineType": "e2-standard-4" }
}
]
},
"labels": {
"department": "finance",
"env": "testing"
},
"logsPolicy": {
"destination": "CLOUD_LOGGING"
}
}
em que PROJECT_ID
é o ID do projeto.
Go
Go
Para mais informações, consulte a documentação de referência da API Go em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Java
Para mais informações, consulte a documentação de referência da API Java em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Node.js
Para mais informações, consulte a documentação de referência da API Node.js em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Python
Para mais informações, consulte a documentação de referência da API Python em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
C++
C++
Para mais informações, consulte a documentação de referência da API C++ em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Criar um job de script básico
É possível criar um job básico de script usando o console do Google Cloud, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.
Console
Para criar um job de script básico usando o console do Google Cloud, faça o seguinte:
No console do Google Cloud, acesse a página Lista de jobs.
Clique em
Criar. A página Criar job em lote é aberta. No painel esquerdo, a página Detalhes do job é selecionada.Configure a página Detalhes do job:
Opcional: no campo Nome do job, personalize o nome.
Por exemplo, insira
example-basic-job
.Configure a seção Detalhes da tarefa:
Na janela Novo executável, adicione pelo menos um script ou contêiner para que esse job seja executado.
Por exemplo, para adicionar um script, faça o seguinte:
Selecione Script. Uma caixa de texto será exibida.
Na caixa de texto, insira um script que você quer executar para cada tarefa neste job.
Por exemplo, insira o seguinte script:
echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
Clique em Concluído.
No campo Contagem de tarefas, insira o número de tarefas desse job. O valor precisa ser um número inteiro entre
1
e o limite de tarefas por grupo de tarefas.Por exemplo, insira
4
.No campo Paralelismo, insira o número de tarefas a serem executadas simultaneamente. Esse número não pode ser maior que o total de tarefas. Ele precisa ser um número inteiro entre
1
e as tarefas paralelas por limite de jobs.Por exemplo, insira
2
.
Configure a página Especificações de recursos:
No painel à esquerda, clique em Especificações do recurso. A página Especificações de recursos é aberta.
Na seção Modelo de provisionamento de VM, selecione uma das seguintes opções para o modelo de provisionamento das VMs deste job:
Se o job oferecer suporte à preempção e você quiser VMs de desconto, selecione Spot.
Caso contrário, selecione Padrão.
Por exemplo, selecione Padrão.
Selecione o local deste job:
No campo Região, selecione uma região.
Por exemplo, selecione
us-central1 (Iowa)
(padrão).No campo Zona, siga um destes procedimentos:
Se você quiser restringir a execução desse job apenas em uma zona específica, selecione uma zona.
Caso contrário, selecione qualquer um.
Por exemplo, selecione qualquer um (padrão).
Selecione uma das seguintes famílias de máquinas:
Para cargas de trabalho comuns, clique em Uso geral.
Para cargas de trabalho que exigem alto desempenho, clique em Otimização para computação.
Para cargas de trabalho com uso intensivo de memória, clique em Otimização de memória.
Por exemplo, clique em Uso geral (padrão).
No campo Série, selecione uma série de máquinas para as VMs deste job.
Por exemplo, se você selecionou Uso geral para a família de máquinas, selecione E2 (padrão).
No campo Tipo de máquina, selecione um tipo de máquina para as VMs desse job.
Por exemplo, se você tiver selecionado E2 para a série de máquinas, selecione e2-medium (2 vCPU, 4 GB de memória) (padrão).
Configure a quantidade de recursos de VM necessários para cada tarefa:
No campo Núcleos, insira a quantidade de vCPUs por tarefa.
Por exemplo, digite
1
(padrão).No campo Memória, insira a quantidade de RAM em GB por tarefa.
Por exemplo, digite
0.5
(padrão).
Opcional: para revisar a configuração do job, clique em Visualizar no painel esquerdo.
Clique em Criar.
A página Detalhes do job exibe o job que você criou.
gcloud
Para criar um job de script básico usando a CLI gcloud, faça o seguinte:
Crie um arquivo JSON que especifique os detalhes de configuração do job. Por exemplo, para criar um job de script básico, crie um arquivo JSON com o conteúdo a seguir. Para mais informações sobre todos os campos que podem ser especificados para um job, consulte a documentação de referência para o recurso REST
projects.locations.jobs
.{ "taskGroups": [ { "taskSpec": { "runnables": [ { "script": { SCRIPT } } ], "computeResource": { "cpuMilli": CORES, "memoryMib": MEMORY }, "maxRetryCount": MAX_RETRY_COUNT, "maxRunDuration": "MAX_RUN_DURATION" }, "taskCount": TASK_COUNT, "parallelism": PARALLELISM } ] }
Substitua:
SCRIPT
: o script que cada tarefa executa.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que geralmente representam metade de um núcleo físico, para alocar para cada tarefa em unidades de miliCPU. Se o campocpuMilli
não for especificado, o valor será definido como2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a ser alocada para cada tarefa em MB. Se o campomemoryMib
não for especificado, o valor será definido como2000
(2 GB).MAX_RETRY_COUNT
: opcional. O número máximo de novas tentativas de uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será definido como0
, o que significa não repetir a tarefa. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefa.MAX_RUN_DURATION
: opcional. O tempo máximo que uma tarefa pode ser executada antes de ser repetida ou falhar, formatado como um valor em segundos seguido pors
. Por exemplo,3600s
por uma hora. Se o campomaxRunDuration
não for especificado, o valor será definido como o tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limitar tempos de execução de tarefas e executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas do job. O valor precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se o campotaskCount
não for especificado, o valor será definido como1
.PARALLELISM
: opcional. O número de tarefas que o job executa simultaneamente. O número não pode ser maior que o número de tarefas e precisa ser um número inteiro entre1
e as tarefas paralelas por limite de jobs. Se o campoparallelism
não for especificado, o valor será definido como1
.
Crie um job usando o comando
gcloud batch jobs submit
.gcloud batch jobs submit JOB_NAME \ --location LOCATION \ --config JSON_CONFIGURATION_FILE
Substitua:
JOB_NAME
: o nome do job.LOCATION
: o local do job.JSON_CONFIGURATION_FILE
: o caminho de um arquivo JSON com os detalhes de configuração do job.
Por exemplo, para criar um job que executa tarefas usando um script:
Crie um arquivo JSON no diretório atual chamado
hello-world-script.json
com o seguinte conteúdo:{ "taskGroups": [ { "taskSpec": { "runnables": [ { "script": { "text": "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks." } } ], "computeResource": { "cpuMilli": 2000, "memoryMib": 16 }, "maxRetryCount": 2, "maxRunDuration": "3600s" }, "taskCount": 4, "parallelism": 2 } ], "allocationPolicy": { "instances": [ { "policy": { "machineType": "e2-standard-4" } } ] }, "labels": { "department": "finance", "env": "testing" }, "logsPolicy": { "destination": "CLOUD_LOGGING" } }
Execute este comando:
gcloud batch jobs submit example-script-job \ --location us-central1 \ --config hello-world-script.json
API
Para criar um job de script básico usando a API Batch, use o método jobs.create
.
Para mais informações sobre todos os campos que podem ser especificados para um job, consulte a
documentação de referência para o recurso REST projects.locations.jobs
.
POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs?job_id=JOB_NAME
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"script": {
SCRIPT
}
}
],
"computeResource": {
"cpuMilli": CORES,
"memoryMib": MEMORY
},
"maxRetryCount": MAX_RETRY_COUNT,
"maxRunDuration": "MAX_RUN_DURATION"
},
"taskCount": TASK_COUNT,
"parallelism": PARALLELISM
}
]
}
Substitua:
PROJECT_ID
: o ID do projeto (link em inglês).LOCATION
: o local do job.JOB_NAME
: o nome do job.SCRIPT
: o script que cada tarefa executa.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que geralmente representam metade de um núcleo físico, para alocar para cada tarefa em unidades de miliCPU. Se o campocpuMilli
não for especificado, o valor será definido como2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a ser alocada para cada tarefa em MB. Se o campomemoryMib
não for especificado, o valor será definido como2000
(2 GB).MAX_RETRY_COUNT
: opcional. O número máximo de novas tentativas de uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será definido como0
, o que significa não repetir a tarefa. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefa.MAX_RUN_DURATION
: opcional. O tempo máximo que uma tarefa pode ser executada antes de ser repetida ou falhar, formatado como um valor em segundos seguido pors
. Por exemplo,3600s
por uma hora. Se o campomaxRunDuration
não for especificado, o valor será definido como o tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limitar tempos de execução de tarefas e executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas do job. O valor precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se o campotaskCount
não for especificado, o valor será definido como1
.PARALLELISM
: opcional. O número de tarefas que o job executa simultaneamente. Esse número não pode ser maior que o de tarefas. Ele precisa ser um número inteiro entre1
e as tarefas paralelas por limite de jobs. Se o campoparallelism
não for especificado, o valor será definido como1
.
Por exemplo, para criar um job que execute tarefas usando um script, use a seguinte solicitação:
POST https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/jobs?job_id=example-script-job
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"script": {
"text": "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
}
}
],
"computeResource": {
"cpuMilli": 2000,
"memoryMib": 16
},
"maxRetryCount": 2,
"maxRunDuration": "3600s"
},
"taskCount": 4,
"parallelism": 2
}
],
"allocationPolicy": {
"instances": [
{
"policy": { "machineType": "e2-standard-4" }
}
]
},
"labels": {
"department": "finance",
"env": "testing"
},
"logsPolicy": {
"destination": "CLOUD_LOGGING"
}
}
em que PROJECT_ID
é o ID do projeto.
Go
Go
Para mais informações, consulte a documentação de referência da API Go em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Java
Para mais informações, consulte a documentação de referência da API Java em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Node.js
Para mais informações, consulte a documentação de referência da API Node.js em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Python
Para mais informações, consulte a documentação de referência da API Python em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
C++
C++
Para mais informações, consulte a documentação de referência da API C++ em lote.
Para autenticar no Batch, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Usar variáveis de ambiente
Use variáveis de ambiente ao escrever uma imagem de contêiner ou script para executar um job. É possível usar qualquer uma das variáveis de ambiente predefinidas para todos os jobs em lote e as variáveis de ambiente personalizadas que você definir ao criar o job.
Usar variáveis de ambiente predefinidas
Por padrão, os executáveis no seu job podem usar as seguintes variáveis de ambiente predefinidas:
BATCH_TASK_COUNT
: o número total de tarefas no grupo.BATCH_TASK_INDEX
: o número do índice desta tarefa no grupo de tarefas. O índice da primeira tarefa é0
e é incrementado para cada tarefa extra.BATCH_HOSTS_FILE
: o caminho para um arquivo que lista todas as instâncias de VM em execução nesse grupo de tarefas. Para usar essa variável de ambiente, o camporequireHostsFile
precisa ser definido comotrue
.BATCH_TASK_RETRY_ATTEMPT
: o número de vezes que essa tarefa já foi tentada. O valor é0
durante a primeira tentativa de uma tarefa e é incrementado a cada nova tentativa. O número total de novas tentativas permitidas para uma tarefa é determinado pelo valor do campomaxRetryCount
, que será0
se não for definido. Para mais informações sobre novas tentativas, consulte Automatizar novas tentativas de tarefa.
Para ver um exemplo de como usar variáveis de ambiente predefinidas, consulte os executáveis de exemplo anterior em Criar um job básico neste documento.
Definir e usar variáveis de ambiente personalizadas
Também é possível definir uma ou mais variáveis de ambiente personalizadas em um job.
Você define cada variável em um ambiente específico com base no escopo desejado dos dados:
Para uma variável que tem o mesmo valor para todas as tarefas, use uma das seguintes opções:
Se a variável tiver o mesmo valor para todos os executáveis, use o ambiente de todos os executáveis (subcampo
environment
detaskSpec
).Caso contrário, se a variável tiver um valor separado para todos os executáveis, use um ou mais ambientes de executáveis específicos (subcampo
environment
derunnables[]
).
Caso contrário, para uma variável array que tem um valor separado para cada tarefa, use o ambiente de todas as tarefas (
taskEnvironment
).
No ambiente selecionado, você define o nome e os valores de cada variável usando um dos seguintes subcampos de ambiente:
Para definir a variável diretamente no arquivo JSON de configuração do job, use o subcampo de variáveis padrão (
variables
), conforme mostrado nesta seção. Essa opção é recomendada para dados que você não quer criptografar.Para definir a variável usando dados criptografados, use o Secret Manager ou o Cloud Key Management Service:
Para usar o conteúdo criptografado de um secret do Secret Manager atual, use o subcampo de variáveis de secret (
secretVariables
). Para mais informações sobre o uso de secrets em um job, consulte Proteger dados sensíveis usando o Secret Manager.Para usar o conteúdo criptografado de uma chave do Cloud Key Management Service atual, utilize o subcampo de variáveis criptografadas (
encryptedVariables
). Para mais informações sobre as chaves do Cloud KMS, consulte a documentação do Cloud Key Management Service.
É possível definir e usar variáveis de ambiente personalizadas para seu job usando a CLI gcloud ou a API Batch. Nos exemplos a seguir, explicamos como criar dois jobs que definem e usam variáveis padrão. O primeiro exemplo de job tem uma variável para um executável específico. O segundo exemplo de job tem uma variável de matriz, com um valor diferente para cada tarefa.
gcloud
Se você quiser definir um job que transmita uma variável de ambiente para um executável executado por cada tarefa, consulte o exemplo sobre como Definir e usar uma variável de ambiente para um executável. Caso contrário, se você quiser definir um job que transmita uma lista de variáveis de ambiente para tarefas diferentes com base no índice de tarefas, consulte o exemplo sobre como Definir e usar uma variável de ambiente para cada tarefa.
Definir e usar uma variável de ambiente para um executável
Para criar um job que transmita variáveis de ambiente para um executável usando a
CLI gcloud, use o
comando gcloud batch jobs submit
e especifique as variáveis de ambiente no arquivo de configuração do job.
Por exemplo, para criar um job de script que defina uma variável de ambiente e a transmita para os scripts de três tarefas, faça a seguinte solicitação:
Crie um arquivo JSON no diretório atual chamado
hello-world-environment-variables.json
com o seguinte conteúdo:{ "taskGroups": [ { "taskSpec": { "runnables": [ { "script": { "text": "echo Hello ${VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks." }, "environment": { "variables": { "VARIABLE_NAME": "VARIABLE_VALUE" } } } ], "computeResource": { "cpuMilli": 2000, "memoryMib": 16 } }, "taskCount": 3, "parallelism": 1 } ], "allocationPolicy": { "instances": [ { "policy": { "machineType": "e2-standard-4" } } ] } }
Substitua:
VARIABLE_NAME
: o nome da variável de ambiente transmitida para cada tarefa. Por convenção, os nomes de variável de ambiente são capitalizados.VARIABLE_VALUE
: opcional. O valor da variável de ambiente passada para cada tarefa.
Execute este comando:
gcloud batch jobs submit example-environment-variables-job \ --location us-central1 \ --config hello-world-environment-variables.json
Defina e use uma variável de ambiente para cada tarefa
Para criar um job que transmita variáveis de ambiente para uma tarefa com base no índice
de tarefas usando a CLI gcloud, use o
comando gcloud batch jobs submit
e especifique o campo de matriz taskEnvironments
no arquivo de configuração
do job.
Por exemplo, para criar um job que inclua uma matriz de três variáveis de ambiente com nomes correspondentes e valores diferentes e transmita as variáveis de ambiente para os scripts das tarefas com índices correspondentes aos índices das variáveis de ambiente na matriz:
Crie um arquivo JSON no diretório atual chamado
hello-world-task-environment-variables.json
com o seguinte conteúdo:{ "taskGroups": [ { "taskSpec": { "runnables": [ { "script": { "text": "echo Hello ${TASK_VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks." }, } ], "computeResource": { "cpuMilli": 2000, "memoryMib": 16 } }, "taskCount": 3, "taskEnvironments": [ { "variables": { "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_0" } }, { "variables": { "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_1" } }, { "variables": { "TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_2" } } ] } ], "allocationPolicy": { "instances": [ { "policy": { "machineType": "e2-standard-4" } } ] } }
Substitua:
TASK_VARIABLE_NAME
: o nome das variáveis de ambiente da tarefa transmitidas para as tarefas com índices correspondentes. Por convenção, os nomes das variável de ambiente são em maiúsculas.TASK_VARIABLE_VALUE_0
: o valor da variável de ambiente transmitida para a primeira tarefa, em queBATCH_TASK_INDEX
é igual a0
.TASK_VARIABLE_VALUE_1
: o valor da variável de ambiente transmitida para a segunda tarefa, em queBATCH_TASK_INDEX
é igual a1
.TASK_VARIABLE_VALUE_2
: o valor da variável de ambiente transmitida para a terceira tarefa, em queBATCH_TASK_INDEX
é igual a2
.
Execute este comando:
gcloud batch jobs submit example-task-environment-variables-job \ --location us-central1 \ --config hello-world-task-environment-variables.json
API
Se você quiser definir um job que transmita uma variável de ambiente para um executável executado por cada tarefa, consulte o exemplo sobre como Definir e usar uma variável de ambiente para um executável. Caso contrário, se você quiser definir um job que transmita uma lista de variáveis de ambiente para tarefas diferentes com base no índice de tarefas, consulte o exemplo sobre como Definir e usar uma variável de ambiente para cada tarefa.
Definir e usar uma variável de ambiente para um executável
Para criar um job que transmita variáveis de ambiente para um executável usando a API Batch, use o comando gcloud batch jobs submit
e especifique as variáveis no campo environment
.
Por exemplo, para criar um job que inclua uma variável de ambiente e a transmita para os scripts de três tarefas, faça a seguinte solicitação:
POST https://batch.googleapis.com/v1/projects/<var>PROJECT_ID</var>/locations/us-central1/jobs?job_id=example-environment-variables-job
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"script": {
"text": "echo Hello ${VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
},
"environment": {
"variables": {
"VARIABLE_NAME": "VARIABLE_VALUE"
}
}
}
],
"computeResource": {
"cpuMilli": 2000,
"memoryMib": 16
}
},
"taskCount": 3,
"parallelism": 1
}
],
"allocationPolicy": {
"instances": [
{
"policy": {
"machineType": "e2-standard-4"
}
}
]
}
}
Substitua:
PROJECT_ID
: o ID do projeto (link em inglês).VARIABLE_NAME
: o nome da variável de ambiente transmitida para cada tarefa. Por convenção, os nomes das variável de ambiente são em maiúsculas.VARIABLE_VALUE
: o valor da variável de ambiente transmitida para cada tarefa.
Defina e use uma variável de ambiente para cada tarefa
Para criar um job que transmita variáveis de ambiente para uma tarefa com base no índice de tarefas usando a API Batch, use o método jobs.create
e especifique as variáveis no campo da matriz taskEnvironments
.
Por exemplo, para criar um job que inclua uma matriz de três variáveis de ambiente com nomes correspondentes e valores diferentes e transmita as variáveis de ambiente para os scripts das três tarefas com base nos índices, faça a seguinte solicitação:
POST https://batch.googleapis.com/v1/projects/<var>PROJECT_ID</var>/locations/us-central1/jobs?job_id=example-task-environment-variables-job
{
"taskGroups": [
{
"taskSpec": {
"runnables": [
{
"script": {
"text": "echo Hello ${TASK_VARIABLE_NAME}! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
},
}
],
"computeResource": {
"cpuMilli": 2000,
"memoryMib": 16
}
},
"taskCount": 3,
"taskEnvironments": [
{
"variables": {
"TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_0"
}
},
{
"variables": {
"TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_1"
}
},
{
"variables": {
"TASK_VARIABLE_NAME": "TASK_VARIABLE_VALUE_2"
}
}
]
}
],
"allocationPolicy": {
"instances": [
{
"policy": { "machineType": "e2-standard-4" }
}
]
}
}
Substitua:
PROJECT_ID
: o ID do projeto (link em inglês).TASK_VARIABLE_NAME
: o nome das variáveis de ambiente transmitidas para as tarefas com índices correspondentes. Por convenção, os nomes das variável de ambiente são em maiúsculas.TASK_VARIABLE_VALUE_0
: o valor da variável de ambiente transmitida para a primeira tarefa, em queBATCH_TASK_INDEX
é igual a0
.TASK_VARIABLE_VALUE_1
: o valor da variável de ambiente transmitida para a segunda tarefa, em queBATCH_TASK_INDEX
é igual a1
.TASK_VARIABLE_VALUE_2
: o valor da variável de ambiente transmitida para a terceira tarefa, em queBATCH_TASK_INDEX
é igual a2
.
A seguir
- Se você tiver problemas para criar ou executar um job, consulte Solução de problemas.
- Visualizar jobs e tarefas
- Saiba mais sobre mais opções de criação de jobs.