En este documento se explican los conceptos básicos para crear tareas de Batch: cómo crear y ejecutar una tarea basada en una secuencia de comandos o una imagen de contenedor y cómo usar variables predefinidas y personalizadas. Para obtener más información sobre cómo crear y ejecutar tareas, consulta el artículo Descripción general de la creación y ejecución de tareas.
Antes de empezar
- Si no has usado Batch antes, consulta el artículo Empezar a usar Batch y habilita Batch completando los requisitos previos para proyectos y usuarios.
-
Para obtener los permisos que necesitas para crear un trabajo, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos:
-
Editor de trabajos por lotes (
roles/batch.jobsEditor
) en el proyecto -
Usuario de cuenta de servicio (
roles/iam.serviceAccountUser
) en la cuenta de servicio del trabajo, que de forma predeterminada es la cuenta de servicio predeterminada de Compute Engine
Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.
También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.
-
Editor de trabajos por lotes (
-
Cada vez que crees un trabajo, asegúrate de que tenga una configuración de red válida.
- Si tu carga de trabajo o proyecto no tiene ningún requisito de red específico y no has modificado la red predeterminada de tu proyecto, no tienes que hacer nada.
- De lo contrario, tendrás que configurar la red al crear un trabajo. Consulta cómo configurar la red de un trabajo antes de crear un trabajo básico para poder modificar los ejemplos que se muestran a continuación y adaptarlos a tus requisitos de red.
-
Cada vez que crees un trabajo, asegúrate de que tenga un entorno de sistema operativo (SO) de máquina virtual válido.
- Si no tienes ningún requisito específico de imagen de SO de VM o de disco de arranque para tu carga de trabajo o proyecto, no tienes que hacer nada.
- De lo contrario, debes preparar una opción de entorno de SO de VM válida. Antes de crear un trabajo básico, puedes usar la configuración predeterminada del entorno del SO de la VM o personalizarlo para adaptar los ejemplos que se muestran a continuación a tus necesidades.
Crear una tarea básica
Para obtener información sobre todos los campos que puede especificar en un trabajo, consulte la documentación de referencia del recurso REST projects.locations.jobs
.
En resumen, un trabajo consta de una matriz de una o varias tareas
que ejecutan uno o varios
ejecutables,
que son los scripts o contenedores ejecutables de tu trabajo.
Para cubrir los aspectos básicos, en esta sección se explica cómo crear un trabajo de ejemplo con un solo elemento ejecutable, ya sea una secuencia de comandos o una imagen de contenedor:
- Si quieres usar Batch para escribir trabajos que ejecuten una imagen de contenedor, consulta Crear un trabajo de contenedor.
- De lo contrario, si no sabes si quieres usar imágenes de contenedor o no estás familiarizado con los contenedores, te recomendamos que crees un trabajo de secuencia de comandos.
El trabajo de ejemplo de ambos tipos de trabajos contiene un grupo de tareas con un array de 4 tareas. Cada tarea imprime un mensaje y su índice en la salida estándar y en Cloud Logging. La definición de este trabajo especifica un paralelismo de 2, lo que indica que el trabajo debe ejecutarse en 2 VMs para permitir que se ejecuten 2 tareas a la vez.
Crear un trabajo de contenedor básico
Puedes seleccionar o crear una imagen de contenedor para proporcionar el código y las dependencias para que tu trabajo se ejecute desde cualquier entorno de computación. Para obtener más información, consulta los artículos sobre cómo trabajar con imágenes de contenedor y ejecutar contenedores en instancias de VM.
Puedes crear un trabajo de contenedor básico mediante la Google Cloud consola, la CLI de gcloud, la API de Batch, Go, Java, Node.js, Python o C++.
Consola
Para crear un trabajo de contenedor básico con la Google Cloud consola, sigue estos pasos:
En la Google Cloud consola, ve a la página Lista de tareas.
Haz clic en
Crear. Se abrirá la página Crear tarea por lotes. En el panel de la izquierda, se selecciona la página Detalles de la tarea.Configura la página Detalles del empleo:
Opcional: En el campo Nombre del trabajo, personaliza el nombre del trabajo.
Por ejemplo, escribe
example-basic-job
.Configura la sección Detalles de la tarea:
En la ventana Nuevo ejecutable, añade al menos una secuencia de comandos o un contenedor para que se ejecute este trabajo.
Por ejemplo, para añadir un contenedor, haz lo siguiente:
Selecciona URL de la imagen del contenedor (opción predeterminada).
En el campo URL de la imagen del contenedor, introduce la URL de una imagen de contenedor que quieras ejecutar en cada tarea de este trabajo.
Por ejemplo, para usar la
busybox
imagen del contenedor de Docker, introduce la siguiente URL:gcr.io/google-containers/busybox
Opcional: Para anular el comando
ENTRYPOINT
de la imagen de contenedor, introduce un comando en el campo Punto de entrada.Por ejemplo, introduce lo siguiente:
/bin/sh
Opcional: Para anular el comando
CMD
de la imagen del contenedor, haz lo siguiente:Seleccione la casilla Anular el comando CMD de la imagen de contenedor. Aparecerá un campo.
En el campo, introduce uno o varios comandos, separando cada uno con un salto de línea.
Por ejemplo, introduce los siguientes comandos:
-c echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
Haz clic en Listo.
En el campo Número de tareas, introduce el número de tareas de este trabajo. El valor debe ser un número entero entre
1
y el límite de tareas por grupo de tareas.Por ejemplo, escribe
4
.En el campo Paralelismo, introduce el número de tareas que se van a ejecutar simultáneamente. El número no puede ser superior al número total de tareas y debe ser un número entero comprendido entre
1
y el límite de tareas paralelas por trabajo.Por ejemplo, escribe
2
.
Configura la página Especificaciones de recursos:
En el panel de la izquierda, haga clic en Especificaciones de recursos. Se abrirá la página Especificaciones de los recursos.
En la sección Modelo de aprovisionamiento de VMs, selecciona una de las siguientes opciones para el modelo de aprovisionamiento de las VMs de este trabajo:
Si tu tarea puede tolerar la interrupción temporal y quieres máquinas virtuales con descuento, selecciona Spot.
De lo contrario, selecciona Estándar.
Por ejemplo, selecciona Estándar (opción predeterminada).
Selecciona la ubicación de este trabajo:
En el campo Región, selecciona una región.
Por ejemplo, selecciona
us-central1 (Iowa)
(opción predeterminada).En el campo Zona, haz una de las siguientes acciones:
Si quieres que esta tarea se ejecute solo en una zona específica, selecciona una zona.
De lo contrario, selecciona cualquiera.
Por ejemplo, selecciona cualquiera (opción predeterminada).
Selecciona una de las siguientes familias de máquinas:
Para las cargas de trabajo habituales, haz clic en Uso general.
Para cargas de trabajo que requieran un alto rendimiento, haga clic en Optimizado para la computación.
Para cargas de trabajo que requieren un uso intensivo de la memoria, haz clic en Memoria optimizada.
En el caso de las cargas de trabajo optimizadas para aceleradores, haga clic en GPUs. Para obtener más información, consulta Crear y ejecutar un trabajo que use GPUs.
Por ejemplo, haz clic en Propósito general (opción predeterminada).
En el campo Serie, selecciona una serie de máquinas para las VMs de este trabajo.
Por ejemplo, si has seleccionado General purpose (Propósito general) para la familia de máquinas, selecciona E2 (predeterminado).
En el campo Tipo de máquina, selecciona un tipo de máquina para las VMs de este trabajo.
Por ejemplo, si has seleccionado E2 para la serie de máquinas, selecciona e2-medium (2 vCPU, 4 GB de memoria) (opción predeterminada).
Configura la cantidad de recursos de VM necesarios para cada tarea:
En el campo Cores (Núcleos), introduce la cantidad de vCPUs por tarea.
Por ejemplo, introduce
1
(valor predeterminado).En el campo Memoria, introduce la cantidad de RAM en GB por tarea.
Por ejemplo, introduce
0.5
(valor predeterminado).
Opcional: Para revisar la configuración del trabajo, en el panel de la izquierda, haz clic en Vista previa.
Haz clic en Crear.
En la página Detalles de la tarea se muestra la tarea que has creado.
gcloud
Para crear un trabajo de contenedor básico con la CLI de gcloud, haz lo siguiente:
Crea un archivo JSON que especifique los detalles de configuración del trabajo. Por ejemplo, para crear un trabajo de contenedor básico, crea un archivo JSON con el siguiente contenido. Para obtener más información sobre todos los campos que puedes especificar en un trabajo, consulta la documentación de referencia del 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 } ] }
Haz los cambios siguientes:
CONTAINER
: el contenedor en el que se ejecuta cada tarea. Como mínimo, un contenedor debe especificar una imagen en el subcampoimageUri
, pero también se pueden requerir subcampos adicionales. Para obtener más información, consulta los subcamposcontainer
y el ejemplo de trabajo de contenedor de esta sección.CORES
: opcional. Cantidad de núcleos, concretamente vCPUs, que normalmente representan la mitad de un núcleo físico, que se asignará a cada tarea en unidades de miliCPU. Si no se especifica el campocpuMilli
, el valor se asigna a2000
(2 vCPUs).MEMORY
: opcional. Cantidad de memoria que se va a asignar a cada tarea en MB. Si no se especifica el campomemoryMib
, el valor se define como2000
(2 GB).MAX_RETRY_COUNT
: opcional. Número máximo de reintentos de una tarea. El valor debe ser un número entero entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor se asigna a0
, lo que significa que no se vuelve a intentar realizar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Automatizar los reintentos de tareas.MAX_RUN_DURATION
: opcional. Tiempo máximo que puede ejecutarse una tarea antes de que se vuelva a intentar o falle. Se indica como un valor en segundos seguido des
. Por ejemplo,3600s
equivale a 1 hora. Si no se especifica el campomaxRunDuration
, el valor se asigna al tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campomaxRunDuration
, consulta Limitar los tiempos de ejecución de tareas y elementos ejecutables mediante tiempos de espera.TASK_COUNT
: opcional. Número de tareas del trabajo. El valor debe ser un número entero entre1
y el límite de tareas por grupo de tareas. Si no se especifica el campotaskCount
, el valor se define como1
.PARALLELISM
: opcional. Número de tareas que ejecuta el trabajo simultáneamente. El número no puede ser superior al número de tareas y debe ser un número entero entre1
y el límite de tareas paralelas por trabajo. Si no se especifica el campoparallelism
, el valor se define como1
.
Crea un trabajo con el comando
gcloud batch jobs submit
.gcloud batch jobs submit JOB_NAME \ --location LOCATION \ --config JSON_CONFIGURATION_FILE
Haz los cambios siguientes:
JOB_NAME
: el nombre del puesto.LOCATION
: la ubicación del puesto.JSON_CONFIGURATION_FILE
: la ruta de un archivo JSON con los detalles de configuración del trabajo.
Por ejemplo, para crear un trabajo que ejecute tareas con la imagen de contenedor Docker busybox
, haz lo siguiente:
Crea un archivo JSON en el directorio actual llamado
hello-world-container.json
con el siguiente contenido:{ "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" } }
Ejecuta el siguiente comando:
gcloud batch jobs submit example-container-job \ --location us-central1 \ --config hello-world-container.json
API
Para crear un trabajo de contenedor básico con la API Batch, usa el método jobs.create
.
Para obtener más información sobre todos los campos que puede especificar en una tarea, consulte la documentación de referencia del 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
}
]
}
Haz los cambios siguientes:
PROJECT_ID
: el ID de proyecto de tu proyecto.LOCATION
: la ubicación del puesto.JOB_NAME
: el nombre del puesto.CONTAINER
: el contenedor en el que se ejecuta cada tarea. Como mínimo, un contenedor debe especificar una imagen en el subcampoimageUri
, pero también se pueden requerir subcampos adicionales. Para obtener más información, consulta los subcamposcontainer
y el ejemplo de trabajo de contenedor de esta sección.CORES
: opcional. La cantidad de núcleos, concretamente vCPUs, que suelen representar la mitad de un núcleo físico, que se asignará a cada tarea en unidades de miliCPU. Si no se especifica el campocpuMilli
, el valor se asigna a2000
(2 vCPUs).MEMORY
: opcional. Cantidad de memoria que se va a asignar a cada tarea en MB. Si no se especifica el campomemoryMib
, el valor se define como2000
(2 GB).MAX_RETRY_COUNT
: opcional. Número máximo de reintentos de una tarea. El valor debe ser un número entero entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor se asigna a0
, lo que significa que no se vuelve a intentar realizar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Automatizar los reintentos de tareas.MAX_RUN_DURATION
: opcional. Tiempo máximo que puede ejecutarse una tarea antes de que se vuelva a intentar o falle. Se indica como un valor en segundos seguido des
. Por ejemplo,3600s
equivale a 1 hora. Si no se especifica el campomaxRunDuration
, el valor se define como el tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campomaxRunDuration
, consulta Limitar los tiempos de ejecución de tareas y elementos ejecutables mediante tiempos de espera.TASK_COUNT
: opcional. El número de tareas del trabajo, que debe ser un número entero entre1
y el límite de tareas por grupo de tareas. Si no se especifica el campotaskCount
, el valor se define como1
.PARALLELISM
: opcional. Número de tareas que el trabajo ejecuta simultáneamente. El número no puede ser superior al número de tareas y debe ser un número entero entre1
y el límite de tareas paralelas por trabajo. Si no se especifica el campoparallelism
, el valor se define como1
.
Por ejemplo, para crear un trabajo que ejecute tareas con la imagen de contenedor Docker busybox
, usa la siguiente solicitud:
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"
}
}
donde PROJECT_ID
es el
ID del proyecto
de tu proyecto.
Go
Go
Para obtener más información, consulta la documentación de referencia de la API Batch Go.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la documentación de referencia de la API Batch Java.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la documentación de referencia de la API Batch Node.js.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la documentación de referencia de la API Batch Python.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la documentación de referencia de la API Batch C++.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Crear una tarea de secuencia de comandos básica
Puedes crear un trabajo de secuencia de comandos básico con la Google Cloud consola, la CLI de gcloud, la API Batch, Go, Java, Node.js, Python o C++.
Consola
Para crear un trabajo de secuencia de comandos básico con la consola, haz lo siguiente: Google Cloud
En la Google Cloud consola, ve a la página Lista de tareas.
Haz clic en
Crear. Se abrirá la página Crear tarea por lotes. En el panel de la izquierda, se selecciona la página Detalles de la tarea.Configura la página Detalles del empleo:
Opcional: En el campo Nombre del trabajo, personaliza el nombre del trabajo.
Por ejemplo, escribe
example-basic-job
.Configura la sección Detalles de la tarea:
En la ventana Nuevo ejecutable, añade al menos una secuencia de comandos o un contenedor para que se ejecute este trabajo.
Por ejemplo, para añadir una secuencia de comandos, haz lo siguiente:
Selecciona Guion. Aparecerá un campo.
En el campo, introduce una secuencia de comandos que quieras ejecutar para cada tarea de este trabajo.
Por ejemplo, introduce la siguiente secuencia de comandos:
echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
Haz clic en Listo.
En el campo Número de tareas, introduce el número de tareas de este trabajo. El valor debe ser un número entero comprendido entre
1
y el límite de tareas por grupo de tareas.Por ejemplo, escribe
4
.En el campo Paralelismo, introduce el número de tareas que se van a ejecutar simultáneamente. El número no puede ser superior al número total de tareas y debe ser un número entero comprendido entre
1
y el límite de tareas paralelas por trabajo.Por ejemplo, escribe
2
.
Configura la página Especificaciones de recursos:
En el panel de la izquierda, haga clic en Especificaciones de recursos. Se abrirá la página Especificaciones de los recursos.
En la sección Modelo de aprovisionamiento de VMs, selecciona una de las siguientes opciones para el modelo de aprovisionamiento de las VMs de este trabajo:
Si tu tarea puede tolerar la interrupción temporal y quieres máquinas virtuales con descuento, selecciona Spot.
De lo contrario, selecciona Estándar.
Por ejemplo, selecciona Estándar (opción predeterminada).
Selecciona la ubicación de este trabajo:
En el campo Región, selecciona una región.
Por ejemplo, selecciona
us-central1 (Iowa)
(opción predeterminada).En el campo Zona, haz una de las siguientes acciones:
Si quieres restringir la ejecución de este trabajo a una zona específica, selecciona una zona.
De lo contrario, selecciona cualquiera.
Por ejemplo, selecciona cualquiera (opción predeterminada).
Selecciona una de las siguientes familias de máquinas:
Para las cargas de trabajo habituales, haz clic en Uso general.
Para cargas de trabajo que requieran un alto rendimiento, haga clic en Optimizado para la computación.
Para cargas de trabajo que requieren un uso intensivo de la memoria, haz clic en Memoria optimizada.
En el caso de las cargas de trabajo optimizadas para aceleradores, haga clic en GPUs. Para obtener más información, consulta Crear y ejecutar un trabajo que use GPUs.
Por ejemplo, haz clic en Propósito general (opción predeterminada).
En el campo Serie, selecciona una serie de máquinas para las VMs de este trabajo.
Por ejemplo, si has seleccionado General purpose (Propósito general) para la familia de máquinas, selecciona E2 (predeterminado).
En el campo Tipo de máquina, selecciona un tipo de máquina para las VMs de este trabajo.
Por ejemplo, si has seleccionado E2 para la serie de máquinas, selecciona e2-medium (2 vCPU, 4 GB de memoria) (opción predeterminada).
Configura la cantidad de recursos de VM necesarios para cada tarea:
En el campo Cores (Núcleos), introduce la cantidad de vCPUs por tarea.
Por ejemplo, introduce
1
(valor predeterminado).En el campo Memoria, introduce la cantidad de RAM en GB por tarea.
Por ejemplo, introduce
0.5
(valor predeterminado).
Opcional: Para revisar la configuración del trabajo, en el panel de la izquierda, haz clic en Vista previa.
Haz clic en Crear.
En la página Detalles de la tarea se muestra la tarea que has creado.
gcloud
Para crear un trabajo de secuencia de comandos básico con gcloud CLI, haz lo siguiente:
Crea un archivo JSON que especifique los detalles de configuración del trabajo. Por ejemplo, para crear un trabajo de secuencia de comandos básico, crea un archivo JSON con el siguiente contenido. Para obtener más información sobre todos los campos que puedes especificar en un trabajo, consulta la documentación de referencia del 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 } ] }
Haz los cambios siguientes:
SCRIPT
: la secuencia de comandos que ejecuta cada tarea. Un script debe definirse como texto mediante el subcampotext
o como la ruta a un archivo accesible mediante el subcampopath
. Para obtener más información, consulta los subcamposscript
y el ejemplo de trabajo de secuencia de comandos de esta sección.CORES
: opcional. Cantidad de núcleos, concretamente vCPUs, que normalmente representan la mitad de un núcleo físico, que se asignará a cada tarea en unidades de miliCPU. Si no se especifica el campocpuMilli
, el valor se asigna a2000
(2 vCPUs).MEMORY
: opcional. Cantidad de memoria que se va a asignar a cada tarea en MB. Si no se especifica el campomemoryMib
, el valor se define como2000
(2 GB).MAX_RETRY_COUNT
: opcional. Número máximo de reintentos de una tarea. El valor debe ser un número entero entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor se asigna a0
, lo que significa que no se vuelve a intentar realizar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Automatizar los reintentos de tareas.MAX_RUN_DURATION
: opcional. Tiempo máximo que puede ejecutarse una tarea antes de que se vuelva a intentar o falle. Se indica como un valor en segundos seguido des
. Por ejemplo,3600s
equivale a 1 hora. Si no se especifica el campomaxRunDuration
, el valor se asigna al tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campomaxRunDuration
, consulta Limitar los tiempos de ejecución de tareas y elementos ejecutables mediante tiempos de espera.TASK_COUNT
: opcional. Número de tareas del trabajo. El valor debe ser un número entero entre1
y el límite de tareas por grupo de tareas. Si no se especifica el campotaskCount
, el valor se define como1
.PARALLELISM
: opcional. Número de tareas que ejecuta el trabajo simultáneamente. El número no puede ser superior al número de tareas y debe ser un número entero entre1
y el límite de tareas paralelas por trabajo. Si no se especifica el campoparallelism
, el valor se define como1
.
Crea un trabajo con el comando
gcloud batch jobs submit
.gcloud batch jobs submit JOB_NAME \ --location LOCATION \ --config JSON_CONFIGURATION_FILE
Haz los cambios siguientes:
JOB_NAME
: el nombre del puesto.LOCATION
: la ubicación del puesto.JSON_CONFIGURATION_FILE
: la ruta de un archivo JSON con los detalles de configuración del trabajo.
Por ejemplo, para crear un trabajo que ejecute tareas mediante una secuencia de comandos, haz lo siguiente:
Crea un archivo JSON en el directorio actual llamado
hello-world-script.json
con el siguiente contenido:{ "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" } }
Ejecuta el siguiente comando:
gcloud batch jobs submit example-script-job \ --location us-central1 \ --config hello-world-script.json
API
Para crear un trabajo de secuencia de comandos básico con la API Batch, usa el método jobs.create
.
Para obtener más información sobre todos los campos que puede especificar en una tarea, consulte la documentación de referencia del 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
}
]
}
Haz los cambios siguientes:
PROJECT_ID
: el ID de proyecto de tu proyecto.LOCATION
: la ubicación del puesto.JOB_NAME
: el nombre del puesto.SCRIPT
: la secuencia de comandos que ejecuta cada tarea. Un script debe definirse como texto mediante el subcampotext
o como la ruta a un archivo accesible mediante el subcampopath
. Para obtener más información, consulta los subcamposscript
y el ejemplo de trabajo de secuencia de comandos de esta sección.CORES
: opcional. La cantidad de núcleos, concretamente vCPUs, que suelen representar la mitad de un núcleo físico, que se asignará a cada tarea en unidades de miliCPU. Si no se especifica el campocpuMilli
, el valor se asigna a2000
(2 vCPUs).MEMORY
: opcional. Cantidad de memoria que se va a asignar a cada tarea en MB. Si no se especifica el campomemoryMib
, el valor se define como2000
(2 GB).MAX_RETRY_COUNT
: opcional. Número máximo de reintentos de una tarea. El valor debe ser un número entero entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor se asigna a0
, lo que significa que no se vuelve a intentar realizar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Automatizar los reintentos de tareas.MAX_RUN_DURATION
: opcional. Tiempo máximo que puede ejecutarse una tarea antes de que se vuelva a intentar o falle. Se indica como un valor en segundos seguido des
. Por ejemplo,3600s
equivale a 1 hora. Si no se especifica el campomaxRunDuration
, el valor se define como el tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campomaxRunDuration
, consulta Limitar los tiempos de ejecución de tareas y elementos ejecutables mediante tiempos de espera.TASK_COUNT
: opcional. Número de tareas del trabajo. El valor debe ser un número entero entre1
y el límite de tareas por grupo de tareas. Si no se especifica el campotaskCount
, el valor se define como1
.PARALLELISM
: opcional. Número de tareas que el trabajo ejecuta simultáneamente. El número no puede ser superior al número de tareas y debe ser un número entero entre1
y el límite de tareas paralelas por trabajo. Si no se especifica el campoparallelism
, el valor se define como1
.
Por ejemplo, para crear un trabajo que ejecute tareas mediante una secuencia de comandos, usa la siguiente solicitud:
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"
}
}
donde PROJECT_ID
es el
ID del proyecto
de tu proyecto.
Go
Go
Para obtener más información, consulta la documentación de referencia de la API Batch Go.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la documentación de referencia de la API Batch Java.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la documentación de referencia de la API Batch Node.js.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la documentación de referencia de la API Batch Python.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la documentación de referencia de la API Batch C++.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.
Usar variables de entorno
Usa variables de entorno cuando escribas una imagen de contenedor o una secuencia de comandos que quieras que ejecute un trabajo. Puedes usar cualquiera de las variables de entorno predefinidas para todos los trabajos por lotes y cualquier variable de entorno personalizada que definas al crear el trabajo.
Usar variables de entorno predefinidas
De forma predeterminada, los elementos ejecutables de tu trabajo pueden usar las siguientes variables de entorno predefinidas:
BATCH_TASK_COUNT
: el número total de tareas de este grupo de tareas.BATCH_TASK_INDEX
: el número de índice de esta tarea en el grupo de tareas. El índice de la primera tarea es0
y se incrementa con cada tarea adicional.BATCH_HOSTS_FILE
: la ruta a un archivo que contiene una lista de todas las instancias de VM en ejecución de este grupo de tareas. Para usar esta variable de entorno, el camporequireHostsFile
debe tener el valortrue
.BATCH_TASK_RETRY_ATTEMPT
: número de veces que ya se ha intentado realizar esta tarea. El valor es0
durante el primer intento de una tarea y se incrementa en cada reintento posterior. El número total de reintentos permitidos para una tarea se determina mediante el valor del campomaxRetryCount
, que es0
si no se define. Para obtener más información sobre los reintentos, consulta Automatizar los reintentos de tareas.
Para ver un ejemplo de cómo usar variables de entorno predefinidas, consulta los ejemplos ejecutables anteriores en Crear un trabajo básico en este documento.
Definir y usar variables de entorno personalizadas
También puedes definir una o varias variables de entorno personalizadas en un trabajo.
Define cada variable en un entorno específico en función del ámbito que quieras que tengan sus datos:
Si una variable tiene el mismo valor para todas las tareas, usa una de las siguientes opciones:
Si la variable tiene el mismo valor para todos los elementos ejecutables, usa el entorno de todos los elementos ejecutables (subcampo
environment
detaskSpec
).De lo contrario, si la variable tiene un valor independiente para todos los elementos ejecutables, utiliza uno o varios entornos de elementos ejecutables específicos (subcampo
environment
derunnables[]
).
De lo contrario, en el caso de una variable de matriz que tenga un valor independiente para cada tarea, usa el entorno de todas las tareas (
taskEnvironment
).
En el entorno seleccionado, define el nombre y los valores de cada variable mediante uno de los siguientes subcampos de entorno:
Para definir la variable directamente en el archivo JSON de configuración del trabajo, usa el subcampo de variables estándar (
variables
), como se muestra en esta sección. Recomendamos esta opción para los datos que no quieras cifrar.Para definir la variable con datos cifrados, puedes usar Secret Manager o Cloud Key Management Service:
Para usar el contenido cifrado de un secreto de Secret Manager, usa el subcampo de variables de secreto (
secretVariables
). Para obtener más información sobre cómo usar secretos en un trabajo, consulta Protege datos sensibles con Secret Manager.Para usar el contenido cifrado de una clave de Cloud Key Management Service, usa el subcampo de variables cifradas (
encryptedVariables
). Para obtener más información sobre las claves de Cloud KMS, consulta la documentación de Cloud Key Management Service.
Puedes definir y usar variables de entorno personalizadas para tu trabajo con la CLI de gcloud o la API Batch. En los siguientes ejemplos se explica cómo crear dos trabajos que definan y usen variables estándar. El primer trabajo de ejemplo tiene una variable para un elemento ejecutable específico. El segundo ejemplo de trabajo tiene una variable de array, que tiene un valor diferente para cada tarea.
gcloud
Si quieres definir un trabajo que transfiera una variable de entorno a un elemento ejecutable que ejecute cada tarea, consulta el ejemplo sobre cómo definir y usar una variable de entorno para un elemento ejecutable. De lo contrario, si quieres definir un trabajo que transfiera una lista de variables de entorno a diferentes tareas en función del índice de la tarea, consulta el ejemplo sobre cómo definir y usar una variable de entorno para cada tarea.
Definir y usar una variable de entorno para un elemento ejecutable
Para crear un trabajo que transfiera variables de entorno a un elemento ejecutable mediante la CLI de gcloud, usa el comando gcloud batch jobs submit
y especifica las variables de entorno en el archivo de configuración del trabajo.
Por ejemplo, para crear un trabajo de secuencia de comandos que defina una variable de entorno y la transfiera a las secuencias de comandos de 3 tareas, haz la siguiente solicitud:
Crea un archivo JSON en el directorio actual llamado
hello-world-environment-variables.json
con el siguiente contenido:{ "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" } } ] } }
Haz los cambios siguientes:
VARIABLE_NAME
: el nombre de la variable de entorno que se pasa a cada tarea. Por convención, los nombres de las variables de entorno se escriben en mayúsculas.VARIABLE_VALUE
: opcional. Valor de la variable de entorno que se transfiere a cada tarea.
Ejecuta el siguiente comando:
gcloud batch jobs submit example-environment-variables-job \ --location us-central1 \ --config hello-world-environment-variables.json
Definir y usar una variable de entorno para cada tarea
Para crear un trabajo que transfiera variables de entorno a una tarea basada en el índice de la tarea mediante la CLI de gcloud, usa el comando gcloud batch jobs submit
y especifica el campo de la matriz taskEnvironments
en el archivo de configuración del trabajo.
Por ejemplo, para crear un trabajo que incluya una matriz de 3 variables de entorno con nombres coincidentes y valores diferentes, y que transfiera las variables de entorno a las secuencias de comandos de las tareas cuyos índices coincidan con los índices de las variables de entorno de la matriz, haz lo siguiente:
Crea un archivo JSON en el directorio actual llamado
hello-world-task-environment-variables.json
con el siguiente contenido:{ "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" } } ] } }
Haz los cambios siguientes:
TASK_VARIABLE_NAME
: el nombre de las variables de entorno de la tarea que se han pasado a las tareas con índices coincidentes. Por convención, los nombres de las variables de entorno se escriben en mayúsculas.TASK_VARIABLE_VALUE_0
: el valor de la variable de entorno que se ha pasado a la primera tarea, para la queBATCH_TASK_INDEX
es igual a0
.TASK_VARIABLE_VALUE_1
: el valor de la variable de entorno que se ha pasado a la segunda tarea, para la queBATCH_TASK_INDEX
es igual a1
.TASK_VARIABLE_VALUE_2
: el valor de la variable de entorno que se ha pasado a la tercera tarea, para la queBATCH_TASK_INDEX
es igual a2
.
Ejecuta el siguiente comando:
gcloud batch jobs submit example-task-environment-variables-job \ --location us-central1 \ --config hello-world-task-environment-variables.json
API
Si quieres definir un trabajo que transfiera una variable de entorno a un elemento ejecutable que ejecute cada tarea, consulta el ejemplo sobre cómo definir y usar una variable de entorno para un elemento ejecutable. De lo contrario, si quieres definir un trabajo que transfiera una lista de variables de entorno a diferentes tareas en función del índice de la tarea, consulta el ejemplo sobre cómo definir y usar una variable de entorno para cada tarea.
Definir y usar una variable de entorno para un elemento ejecutable
Para crear un trabajo que transfiera variables de entorno a un elemento ejecutable mediante la API Batch, usa el comando gcloud batch jobs submit
y especifica las variables de entorno en el campo environment
.
Por ejemplo, para crear un trabajo que incluya una variable de entorno y la transfiera a las secuencias de comandos de 3 tareas, haz la siguiente solicitud:
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"
}
}
]
}
}
Haz los cambios siguientes:
PROJECT_ID
: el ID de proyecto de tu proyecto.VARIABLE_NAME
: el nombre de la variable de entorno que se pasa a cada tarea. Por convención, los nombres de las variables de entorno se escriben en mayúsculas.VARIABLE_VALUE
: el valor de la variable de entorno que se ha pasado a cada tarea.
Definir y usar una variable de entorno para cada tarea
Para crear un trabajo que transfiera variables de entorno a una tarea en función del índice de la tarea mediante la API Batch, usa el método jobs.create
y especifica las variables de entorno en el campo de matriz taskEnvironments
.
Por ejemplo, para crear un trabajo que incluya una matriz de 3 variables de entorno con nombres coincidentes y valores diferentes, y que transfiera las variables de entorno a las secuencias de comandos de 3 tareas en función de sus índices, haz la siguiente solicitud:
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" }
}
]
}
}
Haz los cambios siguientes:
PROJECT_ID
: el ID de proyecto de tu proyecto.TASK_VARIABLE_NAME
: el nombre de las variables de entorno que se han pasado a las tareas con índices coincidentes. Por convención, los nombres de las variables de entorno se escriben en mayúsculas.TASK_VARIABLE_VALUE_0
: el valor de la variable de entorno que se ha pasado a la primera tarea, para la queBATCH_TASK_INDEX
es igual a0
.TASK_VARIABLE_VALUE_1
: el valor de la variable de entorno que se ha pasado a la segunda tarea, para la queBATCH_TASK_INDEX
es igual a1
.TASK_VARIABLE_VALUE_2
: el valor de la variable de entorno que se ha pasado a la tercera tarea, para la queBATCH_TASK_INDEX
es igual a2
.
Siguientes pasos
- Si tienes problemas para crear o ejecutar un trabajo, consulta la sección Solución de problemas.
- Ver trabajos y tareas.
- Consulta más información sobre las opciones de creación de trabajos.