En este documento, se explican los conceptos básicos para la creación de trabajos de Batch: cómo crear y ejecutar un trabajo basado en una secuencia de comandos o una imagen de contenedor y usar variables predefinidas y personalizadas. Para obtener más información sobre cómo crear y ejecutar trabajos, consulta Descripción general de la creación y ejecución de trabajos.
Antes de comenzar
- Si nunca antes usaste Batch, consulta Cómo comenzar a usar Batch y habilita Batch completando los requisitos previos para proyectos y usuarios.
-
A fin de obtener los permisos que necesitas para crear un trabajo, solicita a tu administrador que te otorgue el los siguientes roles de IAM:
-
Editor de trabajos por lotes (
roles/batch.jobsEditor
) en el proyecto -
Usuario de la 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 otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.
-
Editor de trabajos por lotes (
-
Cada vez que crees un trabajo, asegúrate de que tenga una configuración de red válida.
- Si no tienes ningún requisito de red específico para tu carga de trabajo o proyecto, y no modificaste la red predeterminada de tu proyecto, no es necesario que realices ninguna acción.
- De lo contrario, debes configurar la red cuando crees un trabajo. Aprende a configurar las redes para una tarea antes de crear una tarea básica, de modo que puedas modificar los ejemplos que se indican a continuación para cumplir con tus requisitos de red.
-
Cada vez que crees un trabajo, asegúrate de que tenga un entorno de sistema operativo (SO) de VM válido.
- Si no tienes ningún requisito específico de imagen de SO de VM ni de disco de arranque para tu carga de trabajo o proyecto, no es necesario que realices ninguna acción.
- De lo contrario, debes preparar una opción válida de entorno de SO de VM. Antes de crear un trabajo básico, permite la configuración predeterminada para el entorno del SO de la VM o aprende a personalizarlo para que puedas modificar los ejemplos que se indican a continuación y cumplir con tus requisitos.
Crea un trabajo básico
Para obtener información sobre todos los campos que puedes especificar para un trabajo, consulta la
documentación de referencia para el
Recurso de REST projects.locations.jobs
.
En resumen, un trabajo consta de un array de una o más tareas que ejecutan uno o más ejecutables, que son las secuencias de comandos o los contenedores ejecutables de tu trabajo.
Para explicar los conceptos básicos, en esta sección se explica cómo crear un trabajo de ejemplo con
solo un elemento ejecutable, ya sea una secuencia de comandos o una imagen de contenedor:
- Si quieres usar Batch para escribir trabajos que ejecutan una imagen de contenedor, consulta Crea un trabajo de contenedor.
- De lo contrario, si no estás seguro de querer usar imágenes de contenedor o si no conoces los contenedores, se recomienda crear un trabajo de secuencia de comandos.
El trabajo de ejemplo para ambos tipos de trabajos contiene un grupo de tareas con un 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.
Crea 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 procesamiento. Para obtener más información, consulta Trabaja con imágenes de contenedor y Ejecuta contenedores en instancias de VM.
Puedes crear un trabajo de contenedor básico con la consola de Google Cloud, la CLI de gcloud, la API de Batch, Go, Java, Node.js, Python o C++.
Console
Para crear un trabajo de contenedor básico con la consola de Google Cloud, sigue estos pasos:
En la consola de Google Cloud, ve a la página Lista de trabajos.
Haz clic en
Crear. Se abrirá la página Create batch job. En el panel izquierdo, La página Detalles del trabajo está seleccionada.Configura la página Detalles del trabajo:
Opcional: En el campo Nombre del trabajo, personaliza el nombre del trabajo.
Por ejemplo, ingresa
example-basic-job
.Configura la sección Detalles de la tarea:
En la ventana New runnable, agrega al menos una secuencia de comandos o un contenedor para que se ejecute esta tarea.
Por ejemplo, para agregar un contenedor, haz lo siguiente:
Selecciona URL de la imagen del contenedor (predeterminada).
En el campo URL de la imagen del contenedor, ingresa la URL de una de contenedor que deseas ejecutar para cada tarea de esta el trabajo.
Por ejemplo, para usar el contenedor de Docker
busybox
imagen, ingresa el siguiente URL:gcr.io/google-containers/busybox
Opcional: Para anular el valor de la imagen
ENTRYPOINT
, ingresa un comando Campo Punto de entrada.Por ejemplo, ingresa lo siguiente:
/bin/sh
Opcional: Para anular el comando
CMD
de la imagen del contenedor, haz lo siguiente: haz lo siguiente:Selecciona la casilla de verificación Anular el comando de CMD de la imagen del contenedor. Aparecerá un cuadro de texto.
En el cuadro de texto, ingresa uno o más comandos, y separa cada uno con una línea nueva.
Por ejemplo, ingresa 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 Cantidad de tareas, ingresa la cantidad de tareas correspondientes a esta el trabajo. El valor debe ser un número entero entre
1
y el límite de tareas por grupo de tareas.Por ejemplo, ingresa
4
.En el campo Paralelismo, ingresa la cantidad de tareas que se ejecutarán de forma simultánea. El número no puede ser mayor que la cantidad total de tareas y debe ser un número entero entre
1
y el límite de tareas en paralelo por trabajo.Por ejemplo, ingresa
2
.
Configura la página Especificaciones de recursos:
En el panel izquierdo, haz clic en Especificaciones de recursos. Se abrirá la página Especificaciones de recursos.
En la sección Modelo de aprovisionamiento de VM, selecciona una de las siguientes opciones para el modelo de aprovisionamiento de las VMs de este trabajo:
Si tu trabajo puede resistir la interrupción y quieres VMs con descuento, selecciona Spot.
De lo contrario, selecciona Estándar.
Por ejemplo, selecciona Estándar (predeterminada).
Selecciona la ubicación de este trabajo:
En el campo Región, selecciona una región.
Por ejemplo, selecciona
us-central1 (Iowa)
(predeterminada).En el campo Zona, realiza una de las siguientes acciones:
Si quieres restringir la ejecución de este trabajo solo para una zona específica, selecciona una zona.
De lo contrario, selecciona cualquiera.
Por ejemplo, selecciona any (predeterminado).
Selecciona una de las siguientes opciones: Familias de máquinas:
Para cargas de trabajo comunes, haz clic en General.
Para las cargas de trabajo de alto rendimiento, haz clic en Optimizada para procesamiento.
En el caso de las cargas de trabajo que requieren mucha memoria, haz clic en Con optimización de memoria.
Por ejemplo, haz clic en General (predeterminada).
En el campo Serie, selecciona una serie de máquinas para las VMs de este trabajo.
Por ejemplo, si seleccionaste De uso general en la selecciona E2 (predeterminada).
En el campo Tipo de máquina, selecciona un tipo de máquina para las VMs de este trabajo.
Por ejemplo, si seleccionaste E2 para la serie de máquinas, selecciona e2-medium (2 vCPU, 4 GB de memoria) (predeterminado).
Configura la cantidad de recursos de VM necesarios para cada tarea:
En el campo Núcleos, ingresa la cantidad de vCPUs por tarea.
Por ejemplo, ingresa
1
(valor predeterminado).En el campo Memoria, ingresa la cantidad de RAM en GB por tarea.
Por ejemplo, ingresa
0.5
(predeterminada).
Opcional: Para revisar la configuración del trabajo, haz clic en Obtener vista previa en el panel izquierdo.
Haz clic en Crear.
En la página Detalles del trabajo, se muestra el trabajo que creaste.
gcloud
Para crear un trabajo de contenedor básico con gcloud CLI, haz lo siguiente lo siguiente:
Crea un archivo JSON que especifique los detalles de configuración de tu 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 para 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 } ] }
Reemplaza lo siguiente:
CONTAINER
: Es el contenedor que ejecuta cada tarea. Como mínimo, un contenedor debe especificar una imagen en el archivoimageUri
. subcampo, pero es posible que también se requieran subcampos adicionales. Para ver más información, consulta lacontainer
subcampo y el trabajo del contenedor de ejemplo en esta sección.CORES
: Opcional La cantidad de específicamente, las vCPUs, que suelen representar la mitad de un núcleo físico, para asignar a cada tarea en unidades de miliCPU. Si no se especifica el campocpuMilli
, el valor se establece en2000
(2 vCPU).MEMORY
: Opcional La cantidad de memoria asignar a cada tarea en MB. Si el campomemoryMib
no es especificado, el valor se establece en2000
(2 GB).MAX_RETRY_COUNT
: Opcional La cantidad máxima de reintentos de una tarea. El valor debe ser un número entero entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor es Se establece en0
, lo que significa que no se debe reintentar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Cómo automatizar los reintentos de tareas.MAX_RUN_DURATION
: Opcional Tiempo máximo una tarea puede ejecutarse antes de que se reintente o falle, con el formato un valor en segundos seguido des
; por ejemplo,3600s
para 1 hora. Si no se especifica el campomaxRunDuration
, se establece en el valor tiempo de ejecución máximo para un trabajo. Para obtener más información sobre el campomaxRunDuration
, consulta Limita los tiempos de ejecución de tareas y ejecutables con tiempos de espera.TASK_COUNT
: Opcional La cantidad de tareas para el 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 establece en1
.PARALLELISM
: Opcional Es la cantidad de tareas que ejecuta el trabajo de forma simultánea. El número no puede ser mayor que la cantidad de tareas y debe ser un número entero entre1
y el límite de tareas en paralelo por trabajo. Si no se especifica el campoparallelism
, el valor se establece en1
.
Crea un trabajo con el comando
gcloud batch jobs submit
.gcloud batch jobs submit JOB_NAME \ --location LOCATION \ --config JSON_CONFIGURATION_FILE
Reemplaza lo siguiente:
JOB_NAME
: Es el nombre del trabajo.LOCATION
: Es la ubicación del trabajo.JSON_CONFIGURATION_FILE
: Es la ruta de acceso para un JSON. con los detalles de configuración del trabajo.
Por ejemplo, para crear un trabajo que ejecute tareas con la imagen de contenedor de 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 de Batch, usa el método jobs.create
.
Para obtener más información sobre todos los campos que puedes especificar para un trabajo, consulta 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
}
]
}
Reemplaza lo siguiente:
PROJECT_ID
: Es el ID del proyecto de tu proyecto.LOCATION
: Es la ubicación. del trabajo.JOB_NAME
: Es el nombre del trabajo.CONTAINER
: Es el contenedor que ejecuta cada tarea. Como mínimo, un contenedor debe especificar una imagen en el archivoimageUri
. subcampo, pero es posible que también se requieran subcampos adicionales. Para obtener más información, consulta los subcamposcontainer
y el trabajo de contenedor de ejemplo en esta sección.CORES
: Opcional Es la cantidad de núcleos, específicamente CPUs virtuales, que suelen representar la mitad de un núcleo físico, que se asignarán a cada tarea en unidades de miliCPU. Si no se especifica el campocpuMilli
, se establece el valor. a2000
(2 CPU virtuales).MEMORY
: Opcional La cantidad de memoria asignar a cada tarea en MB. Si no se especifica el campomemoryMib
, el valor se establece en2000
(2 GB).MAX_RETRY_COUNT
: Opcional Es la cantidad máxima de reintentos para una tarea. El valor debe ser un número entero entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor se establece en0
, lo que significa que no se volverá a intentar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Cómo automatizar los reintentos de tareas.MAX_RUN_DURATION
: Opcional Tiempo máximo una tarea puede ejecutarse antes de que se reintente o falle, con el formato un valor en segundos seguido des
; por ejemplo,3600s
para 1 hora. Si no se especifica el campomaxRunDuration
, el valor se establece en tiempo de ejecución máximo para un trabajo. Para obtener más información sobre el campomaxRunDuration
, consulta Cómo limitar los tiempos de ejecución de tareas y elementos ejecutables con tiempos de espera.TASK_COUNT
: Opcional La cantidad de tareas del trabajo, que debe ser un número entero entre1
y el límite de tareas por grupo de tareas. Si el botón No se especificó el campotaskCount
; el valor se establece en1
.PARALLELISM
: Opcional El número de tareas que el trabajo se ejecuta de forma simultánea. El número no puede ser mayor que la cantidad de tareas y debe ser un número entero entre1
y el límite de tareas en paralelo por trabajo. Si no se especifica el campoparallelism
, el valor se establece en1
.
Por ejemplo, para crear un trabajo que ejecute tareas con el
Imagen de contenedor de Docker de 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"
}
}
En el ejemplo anterior, PROJECT_ID
es el ID del proyecto.
Go
Go
Para obtener más información, consulta la documentación de referencia de la API de Go de lotes.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la documentación de referencia de la API de Java de lotes.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la API de Node.js por lotes documentación de referencia.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la documentación de referencia de la API de Python de lotes.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la API de C++ por lotes documentación de referencia.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Crea un trabajo de secuencia de comandos básico
Puedes crear un trabajo de secuencia de comandos básico con la consola de Google Cloud, la CLI de gcloud, la API de Batch, Go, Java, Node.js, Python o C++.
Console
Para crear un trabajo de secuencia de comandos básico con la consola de Google Cloud, sigue estos pasos: lo siguiente:
En la consola de Google Cloud, ve a la página Lista de trabajos.
Haz clic en
Crear. El Se abrirá la página Crear trabajo por lotes. En el panel izquierdo, se selecciona la página Detalles del trabajo.Configura la página Detalles del trabajo:
Opcional: En el campo Nombre del trabajo, personaliza el nombre del trabajo.
Por ejemplo, ingresa
example-basic-job
.Configura la sección Detalles de la tarea:
En la ventana Nuevo ejecutable, agrega al menos una secuencia de comandos. o contenedor para que se ejecute este trabajo.
Por ejemplo, para agregar una secuencia de comandos, haz lo siguiente:
Selecciona Secuencia de comandos. Aparecerá un cuadro de texto.
En el cuadro de texto, ingresa la secuencia de comandos que quieras ejecutar. cada tarea de este trabajo.
Por ejemplo, ingresa 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 Cantidad de tareas, ingresa la cantidad 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, ingresa
4
.En el campo Paralelismo, ingresa la cantidad de tareas que se ejecutarán. de forma simultánea. El número no puede ser mayor que el número total de tareas y debe ser un número entero entre
1
y el límite de tareas paralelas por trabajo.Por ejemplo, ingresa
2
.
Configura la página Especificaciones de recursos:
En el panel izquierdo, haz clic en Especificaciones de recursos. Se abrirá la página Especificaciones de recursos.
En la sección Modelo de aprovisionamiento de la VM, selecciona una de las siguientes opciones modelo de aprovisionamiento VMs de este trabajo:
Si tu trabajo puede soportar la preempción y deseas obtener VMs con descuento, selecciona Spot.
De lo contrario, selecciona Estándar.
Por ejemplo, selecciona Estándar (predeterminado).
Selecciona la ubicación de este trabajo:
En el campo Región, selecciona una región.
Por ejemplo, selecciona
us-central1 (Iowa)
(predeterminada).En el campo Zona, realiza una de las siguientes acciones:
Si quieres restringir este trabajo para que se ejecute en un solo en una zona específica, selecciona una zona.
De lo contrario, selecciona cualquiera.
Por ejemplo, selecciona any (predeterminado).
Selecciona una de las siguientes opciones: Familias de máquinas:
Para las cargas de trabajo comunes, haz clic en Uso general.
Para las cargas de trabajo de alto rendimiento, haz clic en Optimizada para procesamiento.
En el caso de las cargas de trabajo que requieren mucha memoria, haz clic en Con optimización de memoria.
Por ejemplo, haz clic en General (predeterminada).
En el campo Serie, selecciona una serie de máquinas para las VMs de este trabajo.
Por ejemplo, si seleccionaste Uso 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 seleccionaste E2 para la serie de máquinas, selecciona e2-medium (2 vCPU, 4 GB de memoria) (predeterminado).
Configura la cantidad de recursos de VM necesarios para cada tarea:
En el campo Núcleos, ingresa la cantidad de vCPUs por tarea.
Por ejemplo, ingresa
1
(predeterminada).En el campo Memoria, ingresa la cantidad de RAM en GB por tarea.
Por ejemplo, ingresa
0.5
(predeterminada).
Opcional: Para revisar la configuración del trabajo, haz clic en Obtener vista previa en el panel izquierdo.
Haz clic en Crear.
En la página Detalles del trabajo, se muestra el trabajo que creaste.
gcloud
Para crear un trabajo de secuencia de comandos básico con gcloud CLI, sigue estos pasos: lo siguiente:
Crea un archivo JSON que especifique los detalles de configuración de tu trabajo. Para 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 específicas para un trabajo, consulta la documentación de referencia del Recurso de 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 } ] }
Reemplaza lo siguiente:
SCRIPT
: Es la secuencia de comandos que ejecuta cada tarea. Una secuencia de comandos se debe definir como texto con el subcampotext
o como la ruta de acceso a un archivo accesible con el subcampofile
. Para ver más información, consulta lascript
subcampo y el trabajo de secuencia de comandos de ejemplo en esta sección.CORES
: Opcional Es la cantidad de núcleos, específicamente CPUs virtuales, que suelen representar la mitad de un núcleo físico, que se asignarán a cada tarea en unidades de milliCPU. Si no se especifica el campocpuMilli
, el valor esté configurada en2000
(2 CPU virtuales).MEMORY
: Opcional La cantidad de memoria asignar a cada tarea en MB. Si el campomemoryMib
no es especificado, el valor se establece en2000
(2 GB).MAX_RETRY_COUNT
: Opcional Es la cantidad máxima de reintentos para una tarea. El valor debe ser un número entero que se encuentre entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor es Se establece en0
, lo que significa que no se debe reintentar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Cómo automatizar los reintentos de tareas.MAX_RUN_DURATION
: Opcional Tiempo máximo una tarea puede ejecutarse antes de que se reintente o falle, con el formato un valor en segundos seguido des
; por ejemplo,3600s
para 1 hora. Si no se especifica el campomaxRunDuration
, se establece en el valor tiempo de ejecución máximo para un trabajo. Para obtener más información sobre el campomaxRunDuration
, consulta Cómo limitar los tiempos de ejecución de tareas y elementos ejecutables con tiempos de espera.TASK_COUNT
: Opcional Es la cantidad de tareas del trabajo. El valor debe ser un número entero entre1
y el límite de tareas por grupo de tareas. Si Si no se especifica el campotaskCount
, el valor se establece en1
.PARALLELISM
: Opcional Es la cantidad de tareas que ejecuta el trabajo de forma simultánea. El número no puede ser mayor que la cantidad de tareas y debe ser un número entero entre1
y el límite de tareas en paralelo por trabajo. Si el botón No se especificó el campoparallelism
; el valor se establece en1
.
Crea un trabajo con el comando
gcloud batch jobs submit
.gcloud batch jobs submit JOB_NAME \ --location LOCATION \ --config JSON_CONFIGURATION_FILE
Reemplaza lo siguiente:
JOB_NAME
: Es el nombre del trabajo.LOCATION
: Es la ubicación del trabajo.JSON_CONFIGURATION_FILE
: Es la ruta de acceso para un JSON. con los detalles de configuración del trabajo.
Por ejemplo, para crear un trabajo que ejecute tareas con 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 básico de secuencia de comandos con la API de Batch, usa el
Método jobs.create
.
Para obtener más información sobre todos los campos que puedes especificar para un trabajo, consulta la
documentación de referencia del recurso de 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
}
]
}
Reemplaza lo siguiente:
PROJECT_ID
: Es el ID del proyecto de tu proyecto.LOCATION
: Es la ubicación del trabajo.JOB_NAME
: Es el nombre del trabajo.SCRIPT
: Es la secuencia de comandos que ejecuta cada tarea. R La secuencia de comandos debe definirse como texto mediante el subcampotext
o como la ruta de acceso a un archivo accesible mediante el subcampofile
. Para ver más información, consulta lascript
subcampo y el trabajo de secuencia de comandos de ejemplo en esta sección.CORES
: Opcional Es la cantidad de núcleos, específicamente CPUs virtuales, que suelen representar la mitad de un núcleo físico, que se asignarán a cada tarea en unidades de miliCPU. Si no se especifica el campocpuMilli
, se establece el valor. a2000
(2 CPU virtuales).MEMORY
: Opcional La cantidad de memoria asignar a cada tarea en MB. Si no se especifica el campomemoryMib
, el valor se establece en2000
(2 GB).MAX_RETRY_COUNT
: Opcional La cantidad máxima de reintentos de una tarea. El valor debe ser un número entero entre0
y10
. Si no se especifica el campomaxRetryCount
, el valor es Se establece en0
, lo que significa que no se debe reintentar la tarea. Para obtener más información sobre el campomaxRetryCount
, consulta Cómo automatizar los reintentos de tareas.MAX_RUN_DURATION
: Opcional Tiempo máximo una tarea puede ejecutarse antes de que se reintente o falle, con el formato un valor en segundos seguido des
; por ejemplo,3600s
para 1 hora. Si no se especifica el campomaxRunDuration
, el valor se establece en el tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campomaxRunDuration
, consulta Cómo limitar los tiempos de ejecución de tareas y elementos ejecutables con tiempos de espera.TASK_COUNT
: Opcional Es la cantidad 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 establece en1
.PARALLELISM
: Opcional Es la cantidad de tareas que ejecuta el trabajo de forma simultánea. El número no puede ser mayor que la cantidad de tareas y debe ser un número entero entre1
y el límite de tareas en paralelo por trabajo. Si no se especifica el campoparallelism
, el valor se establece en1
.
Por ejemplo, para crear una tarea que ejecute tareas con 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"
}
}
En el ejemplo anterior, PROJECT_ID
es el ID del proyecto.
Go
Go
Para obtener más información, consulta la documentación de referencia de la API de Go de lotes.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Java
Java
Para obtener más información, consulta la API de Java por lotes documentación de referencia.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Node.js
Node.js
Para obtener más información, consulta la documentación de referencia de la API de Node.js de lotes.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Python
Python
Para obtener más información, consulta la API de Python por lotes documentación de referencia.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
C++
C++
Para obtener más información, consulta la documentación de referencia de la API de C++ de lotes.
Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.
Usa variables de entorno
Usa variables de entorno cuando escribas una imagen de contenedor o una secuencia de comandos que quieras que se ejecute una tarea. Puedes usar cualquiera de las variables de entorno predefinidas para todos Los trabajos por lotes y las variables de entorno personalizadas que que defines cuando creas el trabajo.
Usa variables de entorno predefinidas
De forma predeterminada, los elementos ejecutables de tu trabajo pueden usar las siguientes variables de entorno predefinidas:
BATCH_TASK_COUNT
: Es la cantidad total de tareas en este grupo de tareas.BATCH_TASK_INDEX
: Es el número de índice de esta tarea en el grupo de tareas. El índice de la primera tarea es0
y se incrementa para cada tarea adicional.BATCH_HOSTS_FILE
: Es la ruta de acceso a un archivo que enumera todas las VM en ejecución. instancias en este grupo de tareas. Para usar esta variable de entorno, el camporequireHostsFile
debe establecerse entrue
.BATCH_TASK_RETRY_ATTEMPT
: Es la cantidad de veces que ya se intentó esta tarea. El valor es0
durante el primer intento de una tarea y aumenta en cada reintento siguiente. La cantidad total de reintentos permitidos para una tarea se determina según el valor de el campomaxRetryCount
, que es0
si no está definido. Para obtener más información sobre los reintentos, consulta Automatiza los reintentos de tareas.
Para ver un ejemplo de cómo usar variables de entorno predefinidas, consulta el ejecutables de ejemplo anterior en Crea un trabajo básico en este documento.
Define y usa variables de entorno personalizadas
De manera opcional, puedes definir una o más variables de entorno personalizadas en un trabajo.
Debes definir cada variable en un entorno específico en función del alcance deseado de sus datos:
Para una variable que tenga el mismo valor para todas las tareas, usa una de las siguientes opciones:
Si la variable tiene el mismo valor para todos los ejecutables, usa el entorno de todos los ejecutables (subcampo
environment
detaskSpec
).De lo contrario, si la variable tiene un valor independiente para todos los elementos ejecutables, usa uno o más entornos de elementos ejecutables específicos (subcampo
environment
derunnables[]
).
De lo contrario, para una variable de array que tenga un valor independiente para cada tarea, usa el entorno de todas las tareas (
taskEnvironment
).
En el entorno seleccionado, tú defines el nombre y los valores de cada con uno de los siguientes subcampos de entorno:
Para definir la variable directamente en el archivo JSON de configuración del trabajo, usa la subcampo de variables estándar (
variables
), como se muestra en esta sección. Se recomienda esta opción para los datos que no que quieres encriptar.Para definir la variable con datos encriptados, puedes usar Secret Manager o Cloud Key Management Service:
Para usar el contenido encriptado de un secreto de Secret Manager existente, usa el subcampo de variables secretas (
secretVariables
). Para obtener más información sobre el uso de Secrets en un trabajo, consulta Protege datos sensibles con Secret Manager.Para usar el contenido encriptado de una cuenta de Cloud Key Management Service, usa el subcampo de variables encriptadas (
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 gcloud CLI o la API de Batch. En los siguientes ejemplos, se explica cómo crear dos trabajos que definen y usan variables estándar. El primer trabajo de ejemplo tiene una variable para un elemento ejecutable específico. El segundo trabajo de ejemplo tiene una variable de array, que tiene un valor diferente para cada tarea.
gcloud
Si deseas definir un trabajo que pase una variable de entorno a un ejecutable que ejecuta cada tarea, consulta el ejemplo para definir y usar una variable de entorno para un ejecutable. De lo contrario, si deseas definir una tarea que pase una lista de variables de entorno a diferentes tareas según el índice de tareas, consulta el ejemplo sobre cómo definir y usar una variable de entorno para cada tarea.
Define y usa una variable de entorno para un clúster
Para crear un trabajo que pase variables de entorno a un ejecutable con 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 lo pasa a las secuencias de comandos de 3 tareas, realiza 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" } } ] } }
Reemplaza lo siguiente:
VARIABLE_NAME
: Es el nombre de la variable de entorno pasados a cada tarea. Por convención, los nombres de las variables de entorno están en mayúsculas.VARIABLE_VALUE
: Opcional Es el valor de la variable de entorno que se pasa 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 pase variables de entorno a una tarea según el índice de tareas con la CLI de gcloud, usa el comando gcloud batch jobs submit
y especifica el campo del array taskEnvironments
en el archivo de configuración del trabajo.
Por ejemplo, para crear un trabajo que incluya un array de 3 entornos variables con nombres coincidentes y valores diferentes, y pasa el variables de entorno a las secuencias de comandos de las tareas cuyos índices coinciden con variables de entorno índices en el array:
Crea un archivo JSON en el directorio actual llamado
hello-world-task-environment-variables.json
por lo siguiente contenidos:{ "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" } } ] } }
Reemplaza lo siguiente:
TASK_VARIABLE_NAME
: Es el nombre de las variables de entorno de la tarea que se pasan a las tareas con índices coincidentes. De convención, los nombres de variable de entorno mayúsculas.TASK_VARIABLE_VALUE_0
: Es el valor del variable de entorno pasada a la primera tarea, para la cualBATCH_TASK_INDEX
es igual a0
.TASK_VARIABLE_VALUE_1
: Es el valor de la variable de entorno que se pasa a la segunda tarea, para la queBATCH_TASK_INDEX
es igual a1
.TASK_VARIABLE_VALUE_2
: Es el valor de la variable de entorno que se pasa 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 deseas definir un trabajo que pase una variable de entorno a una ejecutable que se ejecute cada tarea, consulta el ejemplo para Define y usa una variable de entorno para un ejecutable. De lo contrario, si deseas definir una tarea que pase una lista de variables de entorno a diferentes tareas según el índice de tareas, consulta el ejemplo sobre cómo definir y usar una variable de entorno para cada tarea.
Define y usa una variable de entorno para un clúster
Para crear un trabajo que pase variables de entorno a un elemento ejecutable con la API de 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 pase a las secuencias de comandos de 3 tareas, realiza 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"
}
}
]
}
}
Reemplaza lo siguiente:
PROJECT_ID
: el ID del proyecto de tu proyecto.VARIABLE_NAME
: Es el nombre de la entorno variable pasada a cada tarea. Por convención, los nombres de variable de entorno Están en mayúscula.VARIABLE_VALUE
: El valor de la variable de entorno que se pasa a cada tarea.
Define y usa una variable de entorno para cada tarea
Crear un trabajo que pase variables de entorno a una tarea según la tarea
índice con la API de Batch, usa el método jobs.create
y especifica las variables de entorno en el campo de array taskEnvironments
.
Por ejemplo, para crear un trabajo que incluya un array de 3 variables de entorno con nombres coincidentes y valores diferentes, y pasar las variables de entorno a las secuencias de comandos de 3 tareas según sus índices, realiza 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" }
}
]
}
}
Reemplaza lo siguiente:
PROJECT_ID
: el ID del proyecto de tu proyecto.TASK_VARIABLE_NAME
: Es el nombre del entorno. variables pasadas 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
: Es el valor del variable de entorno pasada a la primera tarea, para la cualBATCH_TASK_INDEX
es igual a0
.TASK_VARIABLE_VALUE_1
: Es el valor de la variable de entorno que se pasa a la segunda tarea, para la queBATCH_TASK_INDEX
es igual a1
.TASK_VARIABLE_VALUE_2
: Es el valor del variable de entorno pasada a la tercera tarea, para la cualBATCH_TASK_INDEX
es igual a2
.
¿Qué sigue?
- Si tienes problemas para crear o ejecutar un trabajo, consulta Solución de problemas.
- Visualiza trabajos y tareas.
- Obtén más información sobre las opciones de creación de trabajos.