Este documento explica os conceitos básicos da criação de jobs em lote: 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 antes, revise Introdução ao Batch e ativar o Batch. pré-requisitos para projetos e usuários.
-
Para ter 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 é 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 com papéis personalizados ou 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 requisitos de rede específicos para sua carga de trabalho e você não tiver modificado a rede padrão dele, nenhuma ação é necessária.
- Caso contrário, você precisará configurar a rede ao criar um job. Saiba como configurar rede para um trabalho antes de criar um job básico, para que possa modifique os exemplos abaixo para atender aos requisitos de rede.
-
Sempre que você criar um job, verifique se ele tem uma VM válida
do sistema operacional (SO).
- Se você não tiver requisitos específicos de imagem do SO da VM ou disco de inicialização para o carga de trabalho ou projeto, nenhuma ação é necessária.
- Caso contrário, você precisará preparar uma opção válida de ambiente de SO de VM. Antes de criar um job básico, permita a configuração padrão para o ambiente do SO da VM ou aprenda a personalizar esse ambiente para que você possa modificar os exemplos abaixo de acordo com suas necessidades.
Criar um job básico
Para informações sobre todos os campos que você pode especificar para um trabalho, consulte a
documentação de referência do
Recurso REST projects.locations.jobs
.
Para resumir, um job consiste em uma matriz de uma ou mais tarefas
que executem um ou mais
executáveis,
que são os scripts e/ou contêineres executáveis para seu job.
Para cobrir o básico, esta seção explica como criar um job de exemplo com
apenas um executável, seja 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 contrário, se você não tiver certeza se quer usar imagens de contêiner ou se não tiver familiaridade com contêineres, como criar um job de script é recomendado.
O exemplo de trabalho para os dois tipos de jobs contém um grupo de tarefas com um matriz de quatro tarefas. Cada tarefa imprime uma mensagem e o índice dela no padrão e o Cloud Logging. A definição deste job especifica paralelismo de 2, que indica que o job deve ser executado em 2 VMs para permitir Duas tarefas a serem executadas por vez.
Criar um job básico de contêiner
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 básico de contêiner usando o console do Google Cloud. CLI gcloud, API Batch, Go, Java, Node.js, Python ou C++.
Console
Para criar um job básico de contêiner usando o console do Google Cloud, faça o seguintes:
No console do Google Cloud, acesse a página Lista de jobs.
Clique em
Criar. O A página Criar job em lote é aberta. No painel esquerdo, A página Detalhes do job está selecionada.Configure a página Detalhes do job:
Opcional: no campo Nome do job, personalize o nome do job.
Por exemplo, insira
example-basic-job
.Configure a seção Task details:
Na janela New runnable, adicione pelo menos um script. ou contêiner para a execução desse job.
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 um do contêiner que você quer executar para cada tarefa neste trabalho.
Por exemplo, para usar o contêiner
busybox
do Docker imagem, digite o seguinte URL:gcr.io/google-containers/busybox
Opcional: para modificar o valor da imagem
ENTRYPOINT
, digite um comando no Ponto de entrada.Por exemplo, digite o seguinte:
/bin/sh
Opcional: para substituir o comando
CMD
da imagem do contêiner, faça o seguinte: faça o seguinte:Selecione a opção Substituir o comando CMD da imagem do contêiner. caixa de seleção. Uma caixa de texto será exibida.
Na caixa de texto, digite um ou mais comandos, separando cada comando 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, digite o número de tarefas desta trabalho. 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. concomitantemente. O número não pode ser maior do que o total de tarefas e precisa ser um número inteiro entre
1
e o limite de tarefas paralelas por job.Por exemplo, insira
2
.
Configure a página Especificações de recursos:
No painel à esquerda, clique em Especificações de recursos. A página Especificações de recursos será aberta.
Na seção Modelo de provisionamento de VM, selecione um dos opções a seguir para a modelo de provisionamento para das VMs deste job:
Se o job puder suportar a preempção e você quiser VMs com desconto, selecione Spot.
Caso contrário, selecione Padrão.
Por exemplo, selecione Padrão.
Selecione o local para este 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 do job em uma zona específica, selecione uma zona.
Caso contrário, selecione qualquer um.
Por exemplo, selecione qualquer (padrão).
Selecione uma das seguintes opções: famílias de máquinas:
Para cargas de trabalho comuns, clique em Uso geral.
Para cargas de trabalho que exigem alto desempenho, clique em Otimizado 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 desse job.
Por exemplo, se você selecionou Uso geral para o família de máquinas, selecione E2 (padrão).
No campo Tipo de máquina, selecione um tipo de máquina para esta as VMs do job.
Por exemplo, se você selecionou E2 para a série de máquinas, escolha 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, no painel esquerdo, Clique em Visualizar.
Clique em Criar.
A página Detalhes do job exibe o job que você criou.
gcloud
Para criar um job básico de contêiner usando a CLI gcloud, faça o seguintes:
Crie um arquivo JSON que especifique os detalhes de configuração do job. Para exemplo, para criar um job básico de contêiner, crie um arquivo JSON com o conteúdos a seguir. Para mais informações sobre todos os campos que você pode especificar para um trabalho, consulte a documentação de referência do 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 em que cada tarefa é executada. No mínimo, um contêiner precisa especificar uma imagem noimageUri
. , mas subcampos adicionais também podem ser necessários. Para mais mais informações, consulte acontainer
subcampos e o exemplo de job de contêiner nesta seção.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que normalmente representam metade de um núcleo físico, a serem alocados para cada tarefa em unidades de milliCPU. Se o campocpuMilli
não for especificado, o valor é definido como2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a alocar para cada tarefa em MB. Se o campomemoryMib
não for especificado, o valor é definido como2000
(2 GB).MAX_RETRY_COUNT
: opcional. O número máximo de novas tentativas para uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será Defina como0
, o que significa que a tarefa não será repetida. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefas.MAX_RUN_DURATION
: opcional. O tempo máximo uma tarefa pode ser executada antes de ser repetida ou falhar, formatada como um valor em segundos seguido des
. Por exemplo,3600s
para 1 hora. Se o campomaxRunDuration
não for especificado, a é definido como tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limite os tempos de execução das tarefas e dos elementos executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas para o job. O valor precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se Se o campotaskCount
não for especificado, o valor será definido como1
.PARALLELISM
: opcional. O número de tarefas o job será executado simultaneamente. O número não pode ser maior do que o número de tarefas e precisa ser um número inteiro entre1
e o limite de tarefas paralelas por job. Se o O campoparallelism
não é especificado, o valor é 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 trabalho.JSON_CONFIGURATION_FILE
: o caminho para um JSON. com os detalhes de configuração do job.
Por exemplo, para criar um job que execute tarefas usando
Imagem do contêiner do Docker busybox
:
Crie um arquivo JSON chamado
hello-world-container.json
com o conteúdo a seguir:{ "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 básico de contêiner usando a API Batch, use
o método jobs.create
.
Para obter mais informações sobre todos os campos que você pode especificar para um trabalho, 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 do seu projeto.LOCATION
: o local do trabalho.JOB_NAME
: o nome do job.CONTAINER
: o contêiner em que cada tarefa é executada. No mínimo, um contêiner precisa especificar uma imagem noimageUri
. , mas subcampos adicionais também podem ser necessários. Para mais mais informações, consulte acontainer
subcampos e o exemplo de job de contêiner nesta seção.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que normalmente representam metade de um núcleo físico, a serem alocados para cada tarefa milliCPU. Se o campocpuMilli
não for especificado, o valor será definido para2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a alocar 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 para uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será Defina como0
, o que significa que a tarefa não será repetida. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefas.MAX_RUN_DURATION
: opcional. O tempo máximo uma tarefa pode ser executada antes de ser repetida ou falhar, formatada como um valor em segundos seguido des
. Por exemplo,3600s
para 1 hora. Se o campomaxRunDuration
não for especificado, o valor está definido como tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limite os tempos de execução das tarefas e dos elementos executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas da job, que precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se o O campotaskCount
não é especificado, o valor é definido como1
.PARALLELISM
: opcional. O número de tarefas que é executado simultaneamente. O número não pode ser maior do que o número de tarefas e precisa ser um número inteiro entre1
e o limite de tarefas paralelas por job. Se o O campoparallelism
não é especificado, o valor é definido como1
.
Por exemplo, para criar um job que execute tarefas usando
busybox
Imagem de contêiner 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
do seu projeto.
Go
Go
Para mais informações, consulte a API Batch Go documentação de referência.
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 API Batch Java documentação de referência.
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 API Batch Node.js documentação de referência.
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 API Batch Python documentação de referência.
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 API Batch C++ documentação de referência.
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 básico de script
É possível criar um job básico de script usando o console do Google Cloud. CLI gcloud, 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 seguintes:
No console do Google Cloud, acesse a página Lista de jobs.
Clique em
Criar. O A página Criar job em lote é aberta. No painel esquerdo, A página Detalhes do job está selecionada.Configure a página Detalhes do job:
Opcional: no campo Nome do job, personalize o nome do job.
Por exemplo, insira
example-basic-job
.Configure a seção Task details:
Na janela New runnable, adicione pelo menos um script. ou contêiner para a execução desse job.
Por exemplo, para adicionar um script, faça o seguinte:
Selecione Script. Uma caixa de texto será exibida.
Na caixa de texto, insira o script que você quer executar em cada tarefa deste trabalho.
Por exemplo, digite este 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, digite o número de tarefas de para esse trabalho. O valor deve 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. concomitantemente. O número não pode ser maior do que o total de tarefas e precisa ser um número inteiro entre
1
e o limite de tarefas paralelas por job.Por exemplo, insira
2
.
Configure a página Especificações de recursos:
No painel à esquerda, clique em Especificações de recursos. A página Especificações de recursos será aberta.
Na seção Modelo de provisionamento de VM, selecione um dos opções a seguir para a modelo de provisionamento para das VMs deste job:
Se o job puder suportar a preempção e você quiser VMs com desconto, selecione Spot.
Caso contrário, selecione Padrão.
Por exemplo, selecione Padrão.
Selecione o local para este 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ê quer restringir a execução desse job em uma zona específica, selecione uma opção.
Caso contrário, selecione qualquer um.
Por exemplo, selecione qualquer (padrão).
Selecione uma das seguintes opções: famílias de máquinas:
Para cargas de trabalho comuns, clique em Uso geral.
Para cargas de trabalho que exigem alto desempenho, clique em Otimizado 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 desse job.
Por exemplo, se você selecionou Uso geral para o família de máquinas, selecione E2 (padrão).
No campo Tipo de máquina, selecione um tipo de máquina para esta as VMs do job.
Por exemplo, se você selecionou E2 para a série de máquinas, escolha 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, no painel esquerdo, Clique em Visualizar.
Clique em Criar.
A página Detalhes do job exibe o job que você criou.
gcloud
Para criar um job básico de script usando a CLI gcloud, faça o seguinte: seguintes:
Crie um arquivo JSON que especifique os detalhes de configuração do job. Para exemplo, para criar um job de script básico, crie um arquivo JSON com o conteúdos a seguir. Para mais informações sobre todos os campos que você pode especificar para um trabalho, consulte a documentação de referência do 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. Um precisa ser definido como texto usando o subcampotext
ou como o caminho para um arquivo acessível usando o subcampofile
. Para mais mais informações, consulte ascript
subcampos e o job de script de exemplo nesta seção.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que normalmente representam metade de um núcleo físico, a serem alocados para cada tarefa em unidades de milliCPU. Se o campocpuMilli
não for especificado, o valor é definido como2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a alocar para cada tarefa em MB. Se o campomemoryMib
não for especificado, o valor é definido como2000
(2 GB).MAX_RETRY_COUNT
: opcional. O número máximo de novas tentativas para uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será Defina como0
, o que significa que a tarefa não será repetida. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefas.MAX_RUN_DURATION
: opcional. O tempo máximo uma tarefa pode ser executada antes de ser repetida ou falhar, formatada como um valor em segundos seguido des
. Por exemplo,3600s
para 1 hora. Se o campomaxRunDuration
não for especificado, a é definido como tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limite os tempos de execução das tarefas e dos elementos executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas para o job. O valor precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se Se o campotaskCount
não for especificado, o valor será definido como1
.PARALLELISM
: opcional. O número de tarefas o job será executado simultaneamente. O número não pode ser maior do que o número de tarefas e precisa ser um número inteiro entre1
e o limite de tarefas paralelas por job. Se o O campoparallelism
não é especificado, o valor é 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 trabalho.JSON_CONFIGURATION_FILE
: o caminho para um JSON. com os detalhes de configuração do job.
Por exemplo, para criar um job que execute tarefas usando um script:
Crie um arquivo JSON chamado
hello-world-script.json
com o conteúdo a seguir:{ "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 com a API Batch, use o
método jobs.create
.
Para obter mais informações sobre todos os campos que você pode especificar para um trabalho, 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 do seu projeto.LOCATION
: o local do trabalho.JOB_NAME
: o nome do job.SCRIPT
: o script que cada tarefa executa. Um precisa ser definido como texto usando o subcampotext
ou como o caminho para um arquivo acessível usando o subcampofile
. Para mais mais informações, consulte ascript
subcampos e o job de script de exemplo nesta seção.CORES
: opcional. A quantidade de núcleos, especificamente vCPUs, que normalmente representam metade de um núcleo físico, a serem alocados para cada tarefa milliCPU. Se o campocpuMilli
não for especificado, o valor será definido para2000
(2 vCPUs).MEMORY
: opcional. A quantidade de memória a alocar 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 para uma tarefa. O valor precisa ser um número inteiro entre0
e10
. Se o campomaxRetryCount
não for especificado, o valor será Defina como0
, o que significa que a tarefa não será repetida. Para mais informações sobre o campomaxRetryCount
, consulte Automatizar novas tentativas de tarefas.MAX_RUN_DURATION
: opcional. O tempo máximo uma tarefa pode ser executada antes de ser repetida ou falhar, formatada como um valor em segundos seguido des
. Por exemplo,3600s
para 1 hora. Se o campomaxRunDuration
não for especificado, o valor está definido como tempo máximo de execução de um job. Para mais informações sobre o campomaxRunDuration
, consulte Limite os tempos de execução das tarefas e dos elementos executáveis usando tempos limite.TASK_COUNT
: opcional. O número de tarefas da trabalho. O valor precisa ser um número inteiro entre1
e o limite de tarefas por grupo de tarefas. Se o O campotaskCount
não é especificado, o valor é definido como1
.PARALLELISM
: opcional. O número de tarefas que é executado simultaneamente. O número não pode ser maior do que o número de tarefas e precisa ser um número inteiro entre1
e o limite de tarefas paralelas por job. Se o O campoparallelism
não é especificado, o valor é 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
do seu projeto.
Go
Go
Para mais informações, consulte a API Batch Go documentação de referência.
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 API Batch Java documentação de referência.
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 API Batch Node.js documentação de referência.
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 API Batch Python documentação de referência.
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 API Batch C++ documentação de referência.
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
usar variáveis de ambiente; quando você cria uma imagem de contêiner ou um script e quer que um job seja executado. É possível usar qualquer uma das variáveis de ambiente predefinidas para todos Jobs em lote e variáveis de ambiente personalizadas que definidos ao criar o job.
Usar variáveis de ambiente predefinidas
Por padrão, os executáveis no job podem usar o seguinte: variáveis de ambiente predefinidas:
BATCH_TASK_COUNT
: o número total de tarefas neste grupo de tarefas.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 adicional.BATCH_HOSTS_FILE
: o caminho para um arquivo que lista todas as VMs em execução. neste 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 esta tarefa já foi tentada. O valor é0
na primeira tentativa de uma tarefa. e é incrementado para cada nova tentativa seguinte. O número total de novas tentativas permitidas para uma tarefa é determinado pelo valor de o campomaxRetryCount
, que será0
se estiver indefinido. Para mais informações sobre novas tentativas, consulte Automatizar novas tentativas de tarefas.
Para um exemplo de como usar variáveis de ambiente predefinidas, consulte o exemplo anterior de executáveis 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 de seus dados:
Para uma variável que tem o mesmo valor para todas as tarefas, use uma destas 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 execuções específicas (subcampo
environment
derunnables[]
).
Caso contrário, para um matriz variável 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 usando um dos seguintes subcampos de ambiente:
Para definir a variável diretamente no arquivo JSON de configuração do job, use o subcampo das variáveis padrão (
variables
), como mostrado nesta seção. Essa opção é recomendada para dados que você não que quiser criptografar.Para definir a variável usando dados criptografados, use Secret Manager ou Cloud Key Management Service:
Para usar o conteúdo criptografado de um Secret Manager, use o subcampo de variáveis secretas (
secretVariables
). Para mais informações sobre como usar secrets em um job, consulte Proteja dados sensíveis usando o Secret Manager.Para usar o conteúdo criptografado de um chave do Cloud Key Management Service, use a subcampo de variáveis criptografadas (
encryptedVariables
). Para mais informações sobre as chaves do Cloud KMS, consulte a documentação para o Cloud Key Management Service.
Você pode definir e usar variáveis de ambiente personalizadas para seu job usando a CLI gcloud ou a API Batch. Os exemplos a seguir explicam como criar dois jobs que definem e usar variáveis padrão. O primeiro job de exemplo tem uma variável para um executável específico. O segundo exemplo tem uma variável de matriz, que tem um valor diferente para cada tarefa.
gcloud
Se você quiser definir um job que transmita uma variável de ambiente para um que cada tarefa seja executada, confira o exemplo de como Defina e use 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 a tarefas diferentes com base no índice de tarefas, veja o exemplo da como Definir e usar uma variável de ambiente para cada tarefa.
Defina e use uma variável de ambiente para um executável
Para criar um job que transmita variáveis de ambiente para um executável usando o
CLI gcloud, use o
Comando gcloud batch jobs submit
e especificar as variáveis de ambiente no arquivo de configuração do job.
Por exemplo, para criar um job de script que define uma variável de ambiente e a passa para os scripts de três tarefas, faça a seguinte solicitação:
Crie um arquivo JSON chamado
hello-world-environment-variables.json
com o conteúdo a seguir:{ "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 do variável de ambiente passados para cada tarefa. Por convenção, variável de ambiente Os nomes ficam maiúsculas.VARIABLE_VALUE
: opcional. O valor do parâmetro passada para cada tarefa.
Execute este comando:
gcloud batch jobs submit example-environment-variables-job \ --location us-central1 \ --config hello-world-environment-variables.json
Definir e usar uma variável de ambiente para cada tarefa
Criar um job que transmita variáveis de ambiente para uma tarefa com base em tarefas
índice usando a CLI gcloud, use o
Comando gcloud batch jobs submit
e especificar o campo de matriz taskEnvironments
na configuração do job
.
Por exemplo, para criar um job que inclua uma matriz de três ambientes variáveis com nomes correspondentes e valores diferentes e transmite a variáveis de ambiente para os scripts das tarefas que correspondem aos variáveis de ambiente índices na matriz:
Crie um arquivo JSON 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 do variáveis de ambiente de tarefa passadas para as tarefas com índices correspondentes. De por convenção, os nomes variável de ambiente letras maiúsculas.TASK_VARIABLE_VALUE_0
: o valor do variável de ambiente passada para a primeira tarefa, para a qualBATCH_TASK_INDEX
é igual a0
.TASK_VARIABLE_VALUE_1
: o valor do variável de ambiente passada para a segunda tarefa, para a qualBATCH_TASK_INDEX
é igual a1
.TASK_VARIABLE_VALUE_2
: o valor do variável de ambiente passada para a terceira tarefa, para a qualBATCH_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 que cada tarefa seja executada, confira o exemplo de como Defina e use 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 a tarefas diferentes com base no índice de tarefas, veja o exemplo da como Definir e usar uma variável de ambiente para cada tarefa.
Defina e use uma variável de ambiente para um executável
Para criar um job que transmita variáveis de ambiente para um executável usando
Batch API, use o
Comando gcloud batch jobs submit
e especifique as variáveis de ambiente no campo environment
.
Por exemplo, para criar um job que inclua uma variável de ambiente e passá-la 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 do seu projeto.VARIABLE_NAME
: o nome do ambiente passada para cada tarefa. Por convenção, os nomes variável de ambiente ficam maiúsculas.VARIABLE_VALUE
: o valor do ambiente. passada para cada tarefa.
Definir e usar uma variável de ambiente para cada tarefa
Criar um job que transmita variáveis de ambiente para uma tarefa com base em tarefas
índice usando a API Batch, use o método jobs.create
e especifique as variáveis de ambiente no campo de matriz taskEnvironments
.
Por exemplo, para criar um job que inclua uma matriz de três ambientes variáveis com nomes correspondentes e valores diferentes e transmite a variáveis de ambiente para os scripts de três tarefas com base em seus í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 do seu projeto.TASK_VARIABLE_NAME
: o nome do ambiente. passadas para as tarefas com índices correspondentes. Por convenção, nomes de variável de ambiente letras maiúsculas.TASK_VARIABLE_VALUE_0
: o valor do variável de ambiente passada para a primeira tarefa, para a qualBATCH_TASK_INDEX
é igual a0
.TASK_VARIABLE_VALUE_1
: o valor do variável de ambiente passada para a segunda tarefa, para a qualBATCH_TASK_INDEX
é igual a1
.TASK_VARIABLE_VALUE_2
: o valor do variável de ambiente passada para a terceira tarefa, para a qualBATCH_TASK_INDEX
é igual a2
.
A seguir
- Se você tiver problemas para criar ou executar um job, consulte Solução de problemas.
- Ver tarefas e tarefas.
- Saiba mais sobre opções de criação de jobs.