Crea y ejecuta un trabajo básico

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

1. Si nunca usaste Batch, consulta Cómo comenzar a usar Batch y habilita Batch completando los requisitos previos para proyectos y usuarios.

2. Para obtener los permisos que necesitas para crear un trabajo, pídele a tu administrador que te otorgue 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.

3. 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.
   Para obtener más información sobre la configuración de red de un trabajo, consulta la descripción general de las redes de lotes.
4. 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.
   Para obtener más información sobre el entorno del SO de la VM de un trabajo, consulta la descripción general del entorno del SO de la VM.

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 del recurso REST de 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 deseas usar Batch para escribir trabajos que ejecuten una imagen de contenedor, consulta Cómo crear 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.

La tarea de ejemplo para ambos tipos de tareas 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 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:

1. En la consola de Google Cloud, ve a la página Lista de trabajos.

   Ir a la lista de trabajos

2. Haz clic en Crear. Se abrirá la página Create batch job. En el panel izquierdo, se selecciona la página Detalles del trabajo.

3. Configura la página Detalles del trabajo:

   1. Opcional: En el campo Nombre del trabajo, personaliza el nombre del trabajo.

      Por ejemplo, ingresa example-basic-job.

   2. Configura la sección Detalles de la tarea:

      1. 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:

         1. Selecciona URL de la imagen del contenedor (predeterminada).

         2. En el campo URL de la imagen del contenedor, ingresa la URL de una imagen de contenedor que deseas ejecutar para cada tarea de este trabajo.

            Por ejemplo, para usar la imagen del contenedor de Docker busybox, ingresa la siguiente URL:

            gcr.io/google-containers/busybox
            

         3. Opcional: Para anular el comando ENTRYPOINT de la imagen del contenedor, ingresa un comando en el campo Punto de entrada.

            Por ejemplo, ingresa lo siguiente:

            /bin/sh
            

         4. Opcional: Para anular el comando CMD de la imagen del contenedor, haz lo siguiente:

            1. Selecciona la casilla de verificación Anular el comando de CMD de la imagen del contenedor. Aparecerá un campo.

            2. En el campo, 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.
               

            3. Haz clic en Listo.

      2. En el campo Task count, ingresa la cantidad de tareas para 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.

      3. 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.

4. Configura la página Especificaciones de recursos:

   1. En el panel izquierdo, haz clic en Especificaciones de recursos. Se abrirá la página Especificaciones de recursos.

   2. 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 soportar la preempción y deseas obtener VMs con descuento, selecciona Spot.

      • De lo contrario, selecciona Estándar.

      Por ejemplo, selecciona Estándar (predeterminado).

   3. Selecciona la ubicación para este trabajo:

      1. En el campo Región, selecciona una región.

         Por ejemplo, selecciona us-central1 (Iowa) (opción predeterminada).

      2. En el campo Zona, realiza una de las siguientes acciones:

         • Si deseas restringir esta tarea para que se ejecute solo en una zona específica, selecciona una.

         • De lo contrario, selecciona cualquiera.

         Por ejemplo, selecciona cualquiera (opción predeterminada).

   4. Selecciona una de las siguientes familias de máquinas:

      • Para cargas de trabajo comunes, haz clic en Uso general.

      • Para cargas de trabajo de rendimiento intensivo, haz clic en Optimizado para procesamiento.

      • Para cargas de trabajo que requieren mucha memoria, haz clic en Optimización de memoria.

      • Para las cargas de trabajo optimizadas para aceleradores, haz clic en GPUs. Para obtener más información, consulta Cómo crear y ejecutar una tarea que use GPUs.

      Por ejemplo, haz clic en General (predeterminado).

   5. 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 (opción predeterminada).

   6. 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).

   7. Configura la cantidad de recursos de VM necesarios para cada tarea:

      1. En el campo Núcleos, ingresa la cantidad de CPU virtuales por tarea.

         Por ejemplo, ingresa 1 (predeterminado).

      2. En el campo Memoria, ingresa la cantidad de RAM en GB por tarea.

         Por ejemplo, ingresa 0.5 (predeterminado).

5. Opcional: Para revisar la configuración del trabajo, haz clic en Obtener vista previa en el panel izquierdo.

6. 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 la CLI de gcloud, haz lo siguiente:

1. 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.

   Nota: Si lo prefieres, puedes especificar los detalles de configuración de tu trabajo en un archivo YAML en lugar de un archivo JSON. Para ello, debes convertir la sintaxis JSON a la sintaxis YAML. Sin embargo, la documentación de Batch solo proporciona ejemplos de sintaxis JSON. Para obtener más información, consulta el comando gcloud batch jobs submit.

   {
       "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 en el que se ejecuta cada tarea. Como mínimo, un contenedor debe especificar una imagen en el subcampo imageUri, pero es posible que también se requieran subcampos adicionales. Para obtener más información, consulta los subcampos de container y el ejemplo de trabajo de contenedor 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 campo cpuMilli, el valor se establece en 2000 (2 vCPU).
   • MEMORY: Opcional Es la cantidad de memoria que se asignará para cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
   • MAX_RETRY_COUNT: Opcional Es la cantidad máxima de reintentos para una tarea. El valor debe ser un número entero entre 0 y 10. Si no se especifica el campo maxRetryCount, el valor se establece en 0, lo que significa que no se volverá a intentar la tarea. Para obtener más información sobre el campo maxRetryCount, consulta Cómo automatizar los reintentos de tareas.
   • MAX_RUN_DURATION: Opcional Es el tiempo máximo que se permite que se ejecute una tarea antes de que se vuelva a intentar o falle, con el formato de un valor en segundos seguido de s (por ejemplo, 3600s para 1 hora). Si no se especifica el campo maxRunDuration, el valor se establece en el tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campo maxRunDuration, 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 entre 1 y el límite de tareas por grupo de tareas. Si no se especifica el campo taskCount, el valor se establece en 1.
   • PARALLELISM: Opcional Es la cantidad de tareas que se ejecutan de forma simultánea. El número no puede ser mayor que la cantidad de tareas y debe ser un número entero entre 1 y el límite de tareas en paralelo por trabajo. Si no se especifica el campo parallelism, el valor se establece en 1.

2. 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 a un archivo JSON con los detalles de configuración de la tarea.

Por ejemplo, para crear un trabajo que ejecute tareas con la imagen de contenedor de Docker busybox, haz lo siguiente:

1. 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"
       }
   }
   

2. 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 en el que se ejecuta cada tarea. Como mínimo, un contenedor debe especificar una imagen en el subcampo imageUri, pero es posible que también se requieran subcampos adicionales. Para obtener más información, consulta los subcampos de container y el ejemplo de trabajo de contenedor 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 campo cpuMilli, el valor se establece en 2000 (2 vCPU).
• MEMORY: Opcional Es la cantidad de memoria que se asignará para cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
• MAX_RETRY_COUNT: Opcional Es la cantidad máxima de reintentos para una tarea. El valor debe ser un número entero entre 0 y 10. Si no se especifica el campo maxRetryCount, el valor se establece en 0, lo que significa que no se volverá a intentar la tarea. Para obtener más información sobre el campo maxRetryCount, consulta Cómo automatizar los reintentos de tareas.
• MAX_RUN_DURATION: Opcional Es el tiempo máximo que se permite que se ejecute una tarea antes de que se vuelva a intentar o falle, con el formato de un valor en segundos seguido de s (por ejemplo, 3600s para 1 hora). Si no se especifica el campo maxRunDuration, el valor se establece en el tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campo maxRunDuration, 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, que debe ser un número entero entre 1 y el límite de tareas por grupo de tareas. Si no se especifica el campo taskCount, el valor se establece en 1.
• 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 entre 1 y el límite de tareas en paralelo por trabajo. Si no se especifica el campo parallelism, el valor se establece en 1.

Por ejemplo, para crear una tarea que ejecute tareas con la imagen de contenedor de 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"
    }
}

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.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	durationpb "google.golang.org/protobuf/types/known/durationpb"
)

// Creates and runs a job that runs the specified container
func createContainerJob(w io.Writer, projectID, region, jobName string) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	container := &batchpb.Runnable_Container{
		ImageUri:   "gcr.io/google-containers/busybox",
		Commands:   []string{"-c", "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."},
		Entrypoint: "/bin/sh",
	}

	// We can specify what resources are requested by each task.
	resources := &batchpb.ComputeResource{
		// CpuMilli is milliseconds per cpu-second. This means the task requires 2 whole CPUs.
		CpuMilli:  2000,
		MemoryMib: 16,
	}

	taskSpec := &batchpb.TaskSpec{
		Runnables: []*batchpb.Runnable{{
			Executable: &batchpb.Runnable_Container_{Container: container},
		}},
		ComputeResource: resources,
		MaxRunDuration: &durationpb.Duration{
			Seconds: 3600,
		},
		MaxRetryCount: 2,
	}

	// Tasks are grouped inside a job using TaskGroups.
	taskGroups := []*batchpb.TaskGroup{
		{
			TaskCount: 4,
			TaskSpec:  taskSpec,
		},
	}

	// Policies are used to define on what kind of virtual machines the tasks will run on.
	// In this case, we tell the system to use "e2-standard-4" machine type.
	// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
	allocationPolicy := &batchpb.AllocationPolicy{
		Instances: []*batchpb.AllocationPolicy_InstancePolicyOrTemplate{{
			PolicyTemplate: &batchpb.AllocationPolicy_InstancePolicyOrTemplate_Policy{
				Policy: &batchpb.AllocationPolicy_InstancePolicy{
					MachineType: "e2-standard-4",
				},
			},
		}},
	}

	// We use Cloud Logging as it's an out of the box available option
	logsPolicy := &batchpb.LogsPolicy{
		Destination: batchpb.LogsPolicy_CLOUD_LOGGING,
	}

	jobLabels := map[string]string{"env": "testing", "type": "container"}

	// The job's parent is the region in which the job will run
	parent := fmt.Sprintf("projects/%s/locations/%s", projectID, region)

	job := batchpb.Job{
		TaskGroups:       taskGroups,
		AllocationPolicy: allocationPolicy,
		Labels:           jobLabels,
		LogsPolicy:       logsPolicy,
	}

	req := &batchpb.CreateJobRequest{
		Parent: parent,
		JobId:  jobName,
		Job:    &job,
	}

	created_job, err := batchClient.CreateJob(ctx, req)
	if err != nil {
		return fmt.Errorf("unable to create job: %w", err)
	}

	fmt.Fprintf(w, "Job created: %v\n", created_job)

	return nil
}

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.

import com.google.cloud.batch.v1.AllocationPolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate;
import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.ComputeResource;
import com.google.cloud.batch.v1.CreateJobRequest;
import com.google.cloud.batch.v1.Job;
import com.google.cloud.batch.v1.LogsPolicy;
import com.google.cloud.batch.v1.LogsPolicy.Destination;
import com.google.cloud.batch.v1.Runnable;
import com.google.cloud.batch.v1.Runnable.Container;
import com.google.cloud.batch.v1.TaskGroup;
import com.google.cloud.batch.v1.TaskSpec;
import com.google.protobuf.Duration;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class CreateWithContainerNoMounting {

  public static void main(String[] args)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region you want to use to run the job. Regions that are
    // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
    String region = "europe-central2";

    // The name of the job that will be created.
    // It needs to be unique for each project and region pair.
    String jobName = "JOB_NAME";

    createContainerJob(projectId, region, jobName);
  }

  // This method shows how to create a sample Batch Job that will run a simple command inside a
  // container on Cloud Compute instances.
  public static void createContainerJob(String projectId, String region, String jobName)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      // Define what will be done as part of the job.
      Runnable runnable =
          Runnable.newBuilder()
              .setContainer(
                  Container.newBuilder()
                      .setImageUri("gcr.io/google-containers/busybox")
                      .setEntrypoint("/bin/sh")
                      .addCommands("-c")
                      .addCommands(
                          "echo Hello world! This is task ${BATCH_TASK_INDEX}. "
                              + "This job has a total of ${BATCH_TASK_COUNT} tasks.")
                      .build())
              .build();

      // We can specify what resources are requested by each task.
      ComputeResource computeResource =
          ComputeResource.newBuilder()
              // In milliseconds per cpu-second. This means the task requires 2 whole CPUs.
              .setCpuMilli(2000)
              // In MiB.
              .setMemoryMib(16)
              .build();

      TaskSpec task =
          TaskSpec.newBuilder()
              // Jobs can be divided into tasks. In this case, we have only one task.
              .addRunnables(runnable)
              .setComputeResource(computeResource)
              .setMaxRetryCount(2)
              .setMaxRunDuration(Duration.newBuilder().setSeconds(3600).build())
              .build();

      // Tasks are grouped inside a job using TaskGroups.
      // Currently, it's possible to have only one task group.
      TaskGroup taskGroup = TaskGroup.newBuilder().setTaskCount(4).setTaskSpec(task).build();

      // Policies are used to define on what kind of virtual machines the tasks will run on.
      // In this case, we tell the system to use "e2-standard-4" machine type.
      // Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
      InstancePolicy instancePolicy =
          InstancePolicy.newBuilder().setMachineType("e2-standard-4").build();

      AllocationPolicy allocationPolicy =
          AllocationPolicy.newBuilder()
              .addInstances(InstancePolicyOrTemplate.newBuilder().setPolicy(instancePolicy).build())
              .build();

      Job job =
          Job.newBuilder()
              .addTaskGroups(taskGroup)
              .setAllocationPolicy(allocationPolicy)
              .putLabels("env", "testing")
              .putLabels("type", "container")
              // We use Cloud Logging as it's an out of the box available option.
              .setLogsPolicy(
                  LogsPolicy.newBuilder().setDestination(Destination.CLOUD_LOGGING).build())
              .build();

      CreateJobRequest createJobRequest =
          CreateJobRequest.newBuilder()
              // The job's parent is the region in which the job will run.
              .setParent(String.format("projects/%s/locations/%s", projectId, region))
              .setJob(job)
              .setJobId(jobName)
              .build();

      Job result =
          batchServiceClient
              .createJobCallable()
              .futureCall(createJobRequest)
              .get(5, TimeUnit.MINUTES);

      System.out.printf("Successfully created the job: %s", result.getName());
    }
  }
}

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.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region you want to the job to run in. The regions that support Batch are listed here:
 * https://cloud.google.com/batch/docs/get-started#locations
 */
// const region = 'us-central-1';
/**
 * The name of the job that will be created.
 * It needs to be unique for each project and region pair.
 */
// const jobName = 'YOUR_JOB_NAME';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');
const batch = batchLib.protos.google.cloud.batch.v1;

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

// Define what will be done as part of the job.
const task = new batch.TaskSpec();
const runnable = new batch.Runnable();
runnable.container = new batch.Runnable.Container();
runnable.container.imageUri = 'gcr.io/google-containers/busybox';
runnable.container.entrypoint = '/bin/sh';
runnable.container.commands = [
  '-c',
  'echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.',
];
task.runnables = [runnable];

// We can specify what resources are requested by each task.
const resources = new batch.ComputeResource();
resources.cpuMilli = 2000; // in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
resources.memoryMib = 16;
task.computeResource = resources;

task.maxRetryCount = 2;
task.maxRunDuration = {seconds: 3600};

// Tasks are grouped inside a job using TaskGroups.
const group = new batch.TaskGroup();
group.taskCount = 4;
group.taskSpec = task;

// Policies are used to define on what kind of virtual machines the tasks will run on.
// In this case, we tell the system to use "e2-standard-4" machine type.
// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
const allocationPolicy = new batch.AllocationPolicy();
const policy = new batch.AllocationPolicy.InstancePolicy();
policy.machineType = 'e2-standard-4';
const instances = new batch.AllocationPolicy.InstancePolicyOrTemplate();
instances.policy = policy;
allocationPolicy.instances = [instances];

const job = new batch.Job();
job.name = jobName;
job.taskGroups = [group];
job.allocationPolicy = allocationPolicy;
job.labels = {env: 'testing', type: 'container'};
// We use Cloud Logging as it's an option available out of the box
job.logsPolicy = new batch.LogsPolicy();
job.logsPolicy.destination = batch.LogsPolicy.Destination.CLOUD_LOGGING;

// The job's parent is the project and region in which the job will run
const parent = `projects/${projectId}/locations/${region}`;

async function callCreateJob() {
  // Construct request
  const request = {
    parent,
    jobId: jobName,
    job,
  };

  // Run request
  const response = await batchClient.createJob(request);
  console.log(response);
}

await callCreateJob();

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.

from google.cloud import batch_v1


def create_container_job(project_id: str, region: str, job_name: str) -> batch_v1.Job:
    """
    This method shows how to create a sample Batch Job that will run
    a simple command inside a container on Cloud Compute instances.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region you want to use to run the job. Regions that are
            available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
        job_name: the name of the job that will be created.
            It needs to be unique for each project and region pair.

    Returns:
        A job object representing the job created.
    """
    client = batch_v1.BatchServiceClient()

    # Define what will be done as part of the job.
    runnable = batch_v1.Runnable()
    runnable.container = batch_v1.Runnable.Container()
    runnable.container.image_uri = "gcr.io/google-containers/busybox"
    runnable.container.entrypoint = "/bin/sh"
    runnable.container.commands = [
        "-c",
        "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.",
    ]

    # Jobs can be divided into tasks. In this case, we have only one task.
    task = batch_v1.TaskSpec()
    task.runnables = [runnable]

    # We can specify what resources are requested by each task.
    resources = batch_v1.ComputeResource()
    resources.cpu_milli = 2000  # in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
    resources.memory_mib = 16  # in MiB
    task.compute_resource = resources

    task.max_retry_count = 2
    task.max_run_duration = "3600s"

    # Tasks are grouped inside a job using TaskGroups.
    # Currently, it's possible to have only one task group.
    group = batch_v1.TaskGroup()
    group.task_count = 4
    group.task_spec = task

    # Policies are used to define on what kind of virtual machines the tasks will run on.
    # In this case, we tell the system to use "e2-standard-4" machine type.
    # Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
    policy = batch_v1.AllocationPolicy.InstancePolicy()
    policy.machine_type = "e2-standard-4"
    instances = batch_v1.AllocationPolicy.InstancePolicyOrTemplate()
    instances.policy = policy
    allocation_policy = batch_v1.AllocationPolicy()
    allocation_policy.instances = [instances]

    job = batch_v1.Job()
    job.task_groups = [group]
    job.allocation_policy = allocation_policy
    job.labels = {"env": "testing", "type": "container"}
    # We use Cloud Logging as it's an out of the box available option
    job.logs_policy = batch_v1.LogsPolicy()
    job.logs_policy.destination = batch_v1.LogsPolicy.Destination.CLOUD_LOGGING

    create_request = batch_v1.CreateJobRequest()
    create_request.job = job
    create_request.job_id = job_name
    # The job's parent is the region in which the job will run
    create_request.parent = f"projects/{project_id}/locations/{region}"

    return client.create_job(create_request)

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.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id) {
    // Initialize the request; start with the fields that depend on the sample
    // input.
    google::cloud::batch::v1::CreateJobRequest request;
    request.set_parent("projects/" + project_id + "/locations/" + location_id);
    request.set_job_id(job_id);
    // Most of the job description is fixed in this example; use a string to
    // initialize it.
    auto constexpr kText = R"pb(
      task_groups {
        task_count: 4
        task_spec {
          compute_resource { cpu_milli: 500 memory_mib: 16 }
          max_retry_count: 2
          max_run_duration { seconds: 3600 }
          runnables {
            container {
              image_uri: "gcr.io/google-containers/busybox"
              entrypoint: "/bin/sh"
              commands: "-c"
              commands: "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
            }
          }
        }
      }
      allocation_policy {
        instances {
          policy { machine_type: "e2-standard-4" provisioning_model: STANDARD }
        }
      }
      labels { key: "env" value: "testing" }
      labels { key: "type" value: "container" }
      logs_policy { destination: CLOUD_LOGGING }
    )pb";
    auto* job = request.mutable_job();
    if (!google::protobuf::TextFormat::ParseFromString(kText, job)) {
      throw std::runtime_error("Error parsing Job description");
    }
    // Create a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.CreateJob(request);
    if (!response) throw std::move(response).status();
    std::cout << "Job : " << response->DebugString() << "\n";
  }

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, haz lo siguiente:

1. En la consola de Google Cloud, ve a la página Lista de trabajos.

   Ir a la lista de trabajos

2. Haz clic en Crear. Se abrirá la página Create batch job. En el panel izquierdo, se selecciona la página Detalles del trabajo.

3. Configura la página Detalles del trabajo:

   1. Opcional: En el campo Nombre del trabajo, personaliza el nombre del trabajo.

      Por ejemplo, ingresa example-basic-job.

   2. Configura la sección Detalles de la tarea:

      1. 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 una secuencia de comandos, haz lo siguiente:

         1. Selecciona Secuencia de comandos. Aparecerá un campo.

         2. En el campo, ingresa una secuencia de comandos que deseas ejecutar para 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.
            

         3. Haz clic en Listo.

      2. En el campo Task count, ingresa la cantidad de tareas para 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.

      3. 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.

4. Configura la página Especificaciones de recursos:

   1. En el panel izquierdo, haz clic en Especificaciones de recursos. Se abrirá la página Especificaciones de recursos.

   2. 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 soportar la preempción y deseas obtener VMs con descuento, selecciona Spot.

      • De lo contrario, selecciona Estándar.

      Por ejemplo, selecciona Estándar (predeterminado).

   3. Selecciona la ubicación para este trabajo:

      1. En el campo Región, selecciona una región.

         Por ejemplo, selecciona us-central1 (Iowa) (opción predeterminada).

      2. En el campo Zona, realiza una de las siguientes acciones:

         • Si deseas restringir esta tarea para que se ejecute solo en una zona específica, selecciona una.

         • De lo contrario, selecciona cualquiera.

         Por ejemplo, selecciona cualquiera (opción predeterminada).

   4. Selecciona una de las siguientes familias de máquinas:

      • Para cargas de trabajo comunes, haz clic en Uso general.

      • Para cargas de trabajo de rendimiento intensivo, haz clic en Optimizado para procesamiento.

      • Para cargas de trabajo que requieren mucha memoria, haz clic en Optimización de memoria.

      • Para las cargas de trabajo optimizadas para aceleradores, haz clic en GPUs. Para obtener más información, consulta Cómo crear y ejecutar una tarea que use GPUs.

      Por ejemplo, haz clic en General (predeterminado).

   5. 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 (opción predeterminada).

   6. 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).

   7. Configura la cantidad de recursos de VM necesarios para cada tarea:

      1. En el campo Núcleos, ingresa la cantidad de CPU virtuales por tarea.

         Por ejemplo, ingresa 1 (predeterminado).

      2. En el campo Memoria, ingresa la cantidad de RAM en GB por tarea.

         Por ejemplo, ingresa 0.5 (predeterminado).

5. Opcional: Para revisar la configuración del trabajo, haz clic en Obtener vista previa en el panel izquierdo.

6. 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, haz lo siguiente:

1. Crea un archivo JSON que especifique los detalles de configuración de tu trabajo. Por ejemplo, para crear una tarea de secuencia de comandos básica, 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.

   Nota: Si lo prefieres, puedes especificar los detalles de configuración de tu trabajo en un archivo YAML en lugar de un archivo JSON. Para ello, debes convertir la sintaxis JSON a la sintaxis YAML. Sin embargo, la documentación de Batch solo proporciona ejemplos de sintaxis JSON. Para obtener más información, consulta el comando gcloud batch jobs submit.

   {
       "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 subcampo text o como la ruta de acceso a un archivo accesible con el subcampo path. Para obtener más información, consulta los subcampos script 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 campo cpuMilli, el valor se establece en 2000 (2 vCPU).
   • MEMORY: Opcional Es la cantidad de memoria que se asignará para cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
   • MAX_RETRY_COUNT: Opcional Es la cantidad máxima de reintentos para una tarea. El valor debe ser un número entero entre 0 y 10. Si no se especifica el campo maxRetryCount, el valor se establece en 0, lo que significa que no se volverá a intentar la tarea. Para obtener más información sobre el campo maxRetryCount, consulta Cómo automatizar los reintentos de tareas.
   • MAX_RUN_DURATION: Opcional Es el tiempo máximo que se permite que se ejecute una tarea antes de que se vuelva a intentar o falle, con el formato de un valor en segundos seguido de s (por ejemplo, 3600s para 1 hora). Si no se especifica el campo maxRunDuration, el valor se establece en el tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campo maxRunDuration, 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 entre 1 y el límite de tareas por grupo de tareas. Si no se especifica el campo taskCount, el valor se establece en 1.
   • PARALLELISM: Opcional Es la cantidad de tareas que se ejecutan de forma simultánea. El número no puede ser mayor que la cantidad de tareas y debe ser un número entero entre 1 y el límite de tareas en paralelo por trabajo. Si no se especifica el campo parallelism, el valor se establece en 1.

2. 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 a un archivo JSON con los detalles de configuración de la tarea.

Por ejemplo, para crear un trabajo que ejecute tareas con una secuencia de comandos, haz lo siguiente:

1. 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"
       }
   }
   

2. 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 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": [
                    {
                        "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. Una secuencia de comandos se debe definir como texto con el subcampo text o como la ruta de acceso a un archivo accesible con el subcampo path. Para obtener más información, consulta los subcampos script 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 campo cpuMilli, el valor se establece en 2000 (2 vCPU).
• MEMORY: Opcional Es la cantidad de memoria que se asignará para cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
• MAX_RETRY_COUNT: Opcional Es la cantidad máxima de reintentos para una tarea. El valor debe ser un número entero entre 0 y 10. Si no se especifica el campo maxRetryCount, el valor se establece en 0, lo que significa que no se volverá a intentar la tarea. Para obtener más información sobre el campo maxRetryCount, consulta Cómo automatizar los reintentos de tareas.
• MAX_RUN_DURATION: Opcional Es el tiempo máximo que se permite que se ejecute una tarea antes de que se vuelva a intentar o falle, con el formato de un valor en segundos seguido de s (por ejemplo, 3600s para 1 hora). Si no se especifica el campo maxRunDuration, el valor se establece en el tiempo de ejecución máximo de una tarea. Para obtener más información sobre el campo maxRunDuration, 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 entre 1 y el límite de tareas por grupo de tareas. Si no se especifica el campo taskCount, el valor se establece en 1.
• 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 entre 1 y el límite de tareas en paralelo por trabajo. Si no se especifica el campo parallelism, el valor se establece en 1.

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.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	durationpb "google.golang.org/protobuf/types/known/durationpb"
)

// Creates and runs a job that executes the specified script
func createScriptJob(w io.Writer, projectID, region, jobName string) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	// Define what will be done as part of the job.
	command := &batchpb.Runnable_Script_Text{
		Text: "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.",
	}
	// You can also run a script from a file. Just remember, that needs to be a script that's
	// already on the VM that will be running the job.
	// Using runnable.script.text and runnable.script.path is mutually exclusive.
	// command := &batchpb.Runnable_Script_Path{
	// 	Path: "/tmp/test.sh",
	// }

	// We can specify what resources are requested by each task.
	resources := &batchpb.ComputeResource{
		// CpuMilli is milliseconds per cpu-second. This means the task requires 2 whole CPUs.
		CpuMilli:  2000,
		MemoryMib: 16,
	}

	taskSpec := &batchpb.TaskSpec{
		Runnables: []*batchpb.Runnable{{
			Executable: &batchpb.Runnable_Script_{
				Script: &batchpb.Runnable_Script{Command: command},
			},
		}},
		ComputeResource: resources,
		MaxRunDuration: &durationpb.Duration{
			Seconds: 3600,
		},
		MaxRetryCount: 2,
	}

	// Tasks are grouped inside a job using TaskGroups.
	taskGroups := []*batchpb.TaskGroup{
		{
			TaskCount: 4,
			TaskSpec:  taskSpec,
		},
	}

	// Policies are used to define on what kind of virtual machines the tasks will run on.
	// In this case, we tell the system to use "e2-standard-4" machine type.
	// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
	allocationPolicy := &batchpb.AllocationPolicy{
		Instances: []*batchpb.AllocationPolicy_InstancePolicyOrTemplate{{
			PolicyTemplate: &batchpb.AllocationPolicy_InstancePolicyOrTemplate_Policy{
				Policy: &batchpb.AllocationPolicy_InstancePolicy{
					MachineType: "e2-standard-4",
				},
			},
		}},
	}

	// We use Cloud Logging as it's an out of the box available option
	logsPolicy := &batchpb.LogsPolicy{
		Destination: batchpb.LogsPolicy_CLOUD_LOGGING,
	}

	jobLabels := map[string]string{"env": "testing", "type": "script"}

	// The job's parent is the region in which the job will run
	parent := fmt.Sprintf("projects/%s/locations/%s", projectID, region)

	job := batchpb.Job{
		TaskGroups:       taskGroups,
		AllocationPolicy: allocationPolicy,
		Labels:           jobLabels,
		LogsPolicy:       logsPolicy,
	}

	req := &batchpb.CreateJobRequest{
		Parent: parent,
		JobId:  jobName,
		Job:    &job,
	}

	created_job, err := batchClient.CreateJob(ctx, req)
	if err != nil {
		return fmt.Errorf("unable to create job: %w", err)
	}

	fmt.Fprintf(w, "Job created: %v\n", created_job)

	return nil
}

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.

import com.google.cloud.batch.v1.AllocationPolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicy;
import com.google.cloud.batch.v1.AllocationPolicy.InstancePolicyOrTemplate;
import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.ComputeResource;
import com.google.cloud.batch.v1.CreateJobRequest;
import com.google.cloud.batch.v1.Job;
import com.google.cloud.batch.v1.LogsPolicy;
import com.google.cloud.batch.v1.LogsPolicy.Destination;
import com.google.cloud.batch.v1.Runnable;
import com.google.cloud.batch.v1.Runnable.Script;
import com.google.cloud.batch.v1.TaskGroup;
import com.google.cloud.batch.v1.TaskSpec;
import com.google.protobuf.Duration;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class CreateWithScriptNoMounting {

  public static void main(String[] args)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region you want to use to run the job. Regions that are
    // available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
    String region = "europe-central2";

    // The name of the job that will be created.
    // It needs to be unique for each project and region pair.
    String jobName = "JOB_NAME";

    createScriptJob(projectId, region, jobName);
  }

  // This method shows how to create a sample Batch Job that will run
  // a simple command on Cloud Compute instances.
  public static void createScriptJob(String projectId, String region, String jobName)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      // Define what will be done as part of the job.
      Runnable runnable =
          Runnable.newBuilder()
              .setScript(
                  Script.newBuilder()
                      .setText(
                          "echo Hello world! This is task ${BATCH_TASK_INDEX}. "
                              + "This job has a total of ${BATCH_TASK_COUNT} tasks.")
                      // You can also run a script from a file. Just remember, that needs to be a
                      // script that's already on the VM that will be running the job.
                      // Using setText() and setPath() is mutually exclusive.
                      // .setPath("/tmp/test.sh")
                      .build())
              .build();

      // We can specify what resources are requested by each task.
      ComputeResource computeResource =
          ComputeResource.newBuilder()
              // In milliseconds per cpu-second. This means the task requires 2 whole CPUs.
              .setCpuMilli(2000)
              // In MiB.
              .setMemoryMib(16)
              .build();

      TaskSpec task =
          TaskSpec.newBuilder()
              // Jobs can be divided into tasks. In this case, we have only one task.
              .addRunnables(runnable)
              .setComputeResource(computeResource)
              .setMaxRetryCount(2)
              .setMaxRunDuration(Duration.newBuilder().setSeconds(3600).build())
              .build();

      // Tasks are grouped inside a job using TaskGroups.
      // Currently, it's possible to have only one task group.
      TaskGroup taskGroup = TaskGroup.newBuilder().setTaskCount(4).setTaskSpec(task).build();

      // Policies are used to define on what kind of virtual machines the tasks will run on.
      // In this case, we tell the system to use "e2-standard-4" machine type.
      // Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
      InstancePolicy instancePolicy =
          InstancePolicy.newBuilder().setMachineType("e2-standard-4").build();

      AllocationPolicy allocationPolicy =
          AllocationPolicy.newBuilder()
              .addInstances(InstancePolicyOrTemplate.newBuilder().setPolicy(instancePolicy).build())
              .build();

      Job job =
          Job.newBuilder()
              .addTaskGroups(taskGroup)
              .setAllocationPolicy(allocationPolicy)
              .putLabels("env", "testing")
              .putLabels("type", "script")
              // We use Cloud Logging as it's an out of the box available option.
              .setLogsPolicy(
                  LogsPolicy.newBuilder().setDestination(Destination.CLOUD_LOGGING).build())
              .build();

      CreateJobRequest createJobRequest =
          CreateJobRequest.newBuilder()
              // The job's parent is the region in which the job will run.
              .setParent(String.format("projects/%s/locations/%s", projectId, region))
              .setJob(job)
              .setJobId(jobName)
              .build();

      Job result =
          batchServiceClient
              .createJobCallable()
              .futureCall(createJobRequest)
              .get(5, TimeUnit.MINUTES);

      System.out.printf("Successfully created the job: %s", result.getName());
    }
  }
}

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.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region you want to the job to run in. The regions that support Batch are listed here:
 * https://cloud.google.com/batch/docs/get-started#locations
 */
// const region = 'us-central-1';
/**
 * The name of the job that will be created.
 * It needs to be unique for each project and region pair.
 */
// const jobName = 'YOUR_JOB_NAME';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');
const batch = batchLib.protos.google.cloud.batch.v1;

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

// Define what will be done as part of the job.
const task = new batch.TaskSpec();
const runnable = new batch.Runnable();
runnable.script = new batch.Runnable.Script();
runnable.script.text =
  'echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.';
// You can also run a script from a file. Just remember, that needs to be a script that's
// already on the VM that will be running the job. Using runnable.script.text and runnable.script.path is mutually
// exclusive.
// runnable.script.path = '/tmp/test.sh'
task.runnables = [runnable];

// We can specify what resources are requested by each task.
const resources = new batch.ComputeResource();
resources.cpuMilli = 2000; // in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
resources.memoryMib = 16;
task.computeResource = resources;

task.maxRetryCount = 2;
task.maxRunDuration = {seconds: 3600};

// Tasks are grouped inside a job using TaskGroups.
const group = new batch.TaskGroup();
group.taskCount = 4;
group.taskSpec = task;

// Policies are used to define on what kind of virtual machines the tasks will run on.
// In this case, we tell the system to use "e2-standard-4" machine type.
// Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
const allocationPolicy = new batch.AllocationPolicy();
const policy = new batch.AllocationPolicy.InstancePolicy();
policy.machineType = 'e2-standard-4';
const instances = new batch.AllocationPolicy.InstancePolicyOrTemplate();
instances.policy = policy;
allocationPolicy.instances = [instances];

const job = new batch.Job();
job.name = jobName;
job.taskGroups = [group];
job.allocationPolicy = allocationPolicy;
job.labels = {env: 'testing', type: 'script'};
// We use Cloud Logging as it's an option available out of the box
job.logsPolicy = new batch.LogsPolicy();
job.logsPolicy.destination = batch.LogsPolicy.Destination.CLOUD_LOGGING;

// The job's parent is the project and region in which the job will run
const parent = `projects/${projectId}/locations/${region}`;

async function callCreateJob() {
  // Construct request
  const request = {
    parent,
    jobId: jobName,
    job,
  };

  // Run request
  const response = await batchClient.createJob(request);
  console.log(response);
}

await callCreateJob();

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.

from google.cloud import batch_v1


def create_script_job(project_id: str, region: str, job_name: str) -> batch_v1.Job:
    """
    This method shows how to create a sample Batch Job that will run
    a simple command on Cloud Compute instances.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region you want to use to run the job. Regions that are
            available for Batch are listed on: https://cloud.google.com/batch/docs/get-started#locations
        job_name: the name of the job that will be created.
            It needs to be unique for each project and region pair.

    Returns:
        A job object representing the job created.
    """
    client = batch_v1.BatchServiceClient()

    # Define what will be done as part of the job.
    task = batch_v1.TaskSpec()
    runnable = batch_v1.Runnable()
    runnable.script = batch_v1.Runnable.Script()
    runnable.script.text = "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
    # You can also run a script from a file. Just remember, that needs to be a script that's
    # already on the VM that will be running the job. Using runnable.script.text and runnable.script.path is mutually
    # exclusive.
    # runnable.script.path = '/tmp/test.sh'
    task.runnables = [runnable]

    # We can specify what resources are requested by each task.
    resources = batch_v1.ComputeResource()
    resources.cpu_milli = 2000  # in milliseconds per cpu-second. This means the task requires 2 whole CPUs.
    resources.memory_mib = 16
    task.compute_resource = resources

    task.max_retry_count = 2
    task.max_run_duration = "3600s"

    # Tasks are grouped inside a job using TaskGroups.
    # Currently, it's possible to have only one task group.
    group = batch_v1.TaskGroup()
    group.task_count = 4
    group.task_spec = task

    # Policies are used to define on what kind of virtual machines the tasks will run on.
    # In this case, we tell the system to use "e2-standard-4" machine type.
    # Read more about machine types here: https://cloud.google.com/compute/docs/machine-types
    allocation_policy = batch_v1.AllocationPolicy()
    policy = batch_v1.AllocationPolicy.InstancePolicy()
    policy.machine_type = "e2-standard-4"
    instances = batch_v1.AllocationPolicy.InstancePolicyOrTemplate()
    instances.policy = policy
    allocation_policy.instances = [instances]

    job = batch_v1.Job()
    job.task_groups = [group]
    job.allocation_policy = allocation_policy
    job.labels = {"env": "testing", "type": "script"}
    # We use Cloud Logging as it's an out of the box available option
    job.logs_policy = batch_v1.LogsPolicy()
    job.logs_policy.destination = batch_v1.LogsPolicy.Destination.CLOUD_LOGGING

    create_request = batch_v1.CreateJobRequest()
    create_request.job = job
    create_request.job_id = job_name
    # The job's parent is the region in which the job will run
    create_request.parent = f"projects/{project_id}/locations/{region}"

    return client.create_job(create_request)

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.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id) {
    // Initialize the request; start with the fields that depend on the sample
    // input.
    google::cloud::batch::v1::CreateJobRequest request;
    request.set_parent("projects/" + project_id + "/locations/" + location_id);
    request.set_job_id(job_id);
    // Most of the job description is fixed in this example; use a string to
    // initialize it.
    auto constexpr kText = R"pb(
      task_groups {
        task_count: 4
        task_spec {
          compute_resource { cpu_milli: 500 memory_mib: 16 }
          max_retry_count: 2
          max_run_duration { seconds: 3600 }
          runnables {
            script {
              text: "echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks."
            }
          }
        }
      }
      allocation_policy {
        instances {
          policy { machine_type: "e2-standard-4" provisioning_model: STANDARD }
        }
      }
      labels { key: "env" value: "testing" }
      labels { key: "type" value: "script" }
      logs_policy { destination: CLOUD_LOGGING }
    )pb";
    auto* job = request.mutable_job();
    if (!google::protobuf::TextFormat::ParseFromString(kText, job)) {
      throw std::runtime_error("Error parsing Job description");
    }
    // Create a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.CreateJob(request);
    if (!response) throw std::move(response).status();
    std::cout << "Job : " << response->DebugString() << "\n";
  }

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 de lote y las variables de entorno personalizadas que definas mientras 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 es 0 y se incrementa para cada tarea adicional.
• BATCH_HOSTS_FILE: Es la ruta de acceso a un archivo que enumera todas las instancias de VM en ejecución en este grupo de tareas. Para usar esta variable de entorno, el campo requireHostsFile debe establecerse en true.
• BATCH_TASK_RETRY_ATTEMPT: Es la cantidad de veces que ya se intentó esta tarea. El valor es 0 durante el primer intento de una tarea y se incrementa para cada reintento posterior. La cantidad total de reintentos permitidos para una tarea se determina según el valor del campo maxRetryCount, que es 0 si no se define. Para obtener más información sobre los reintentos, consulta Cómo automatizar los reintentos de tareas.

Para ver un ejemplo de cómo usar variables de entorno predefinidas, consulta los ejecutables de ejemplo anteriores en Cómo crear una tarea básica 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.

Define cada variable en un entorno específico según el 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 de taskSpec).

  • 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 de runnables[]).

• 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, puedes definir el nombre y los valores de cada variable con 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. Se recomienda esta opción para los datos que no 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 secretos en una tarea, consulta Cómo proteger datos sensibles con Secret Manager.

  • Para usar el contenido encriptado de una clave existente 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 la CLI de gcloud 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 elemento ejecutable

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 la pase a las secuencias de comandos de 3 tareas, realiza la siguiente solicitud:

1. 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 que se pasa 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.

2. Ejecuta el siguiente comando:

   gcloud batch jobs submit example-environment-variables-job \
     --location us-central1 \
     --config hello-world-environment-variables.json
   

Define y usa 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 variables de entorno con nombres coincidentes y valores diferentes, y pasar las variables de entorno a las secuencias de comandos de las tareas cuyos índices coinciden con los índices de las variables de entorno en el array:

1. 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"
                   }
               }
           ]
       }
   }
   

   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. Por convención, los nombres de las variables de entorno se escriben en mayúsculas.
   • TASK_VARIABLE_VALUE_0: Es el valor de la variable de entorno que se pasa a la primera tarea, para la que BATCH_TASK_INDEX es igual a 0.
   • TASK_VARIABLE_VALUE_1: Es el valor de la variable de entorno que se pasa a la segunda tarea, para la que BATCH_TASK_INDEX es igual a 1.
   • TASK_VARIABLE_VALUE_2: El valor de la variable de entorno que se pasa a la tercera tarea, para la que BATCH_TASK_INDEX es igual a 2.
   Nota: Si se especifica una variable de entorno en el campo del array taskEnvironments, el valor del campo taskCount debe ser igual a la longitud del array taskEnvironments. La longitud máxima del array taskEnvironments es de 200.

2. 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 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 elemento ejecutable

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: Es el ID del proyecto de tu proyecto.
• VARIABLE_NAME: Es el nombre de la variable de entorno que se pasa a cada tarea. Por convención, los nombres de las variables de entorno están en mayúsculas.
• 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

Para crear un trabajo que pase variables de entorno a una tarea según el índice de tareas con la API de Batch, usa el método jobs.create y especifica las variables de entorno en el campo del array taskEnvironments.

Por ejemplo, para crear una tarea 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: Es el ID del proyecto de tu proyecto.
• TASK_VARIABLE_NAME: Es el nombre de las variables de entorno que se pasan 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 de la variable de entorno que se pasa a la primera tarea, para la que BATCH_TASK_INDEX es igual a 0.
• TASK_VARIABLE_VALUE_1: Es el valor de la variable de entorno que se pasa a la segunda tarea, para la que BATCH_TASK_INDEX es igual a 1.
• TASK_VARIABLE_VALUE_2: El valor de la variable de entorno que se pasa a la tercera tarea, para la que BATCH_TASK_INDEX es igual a 2.

Nota: Si se especifica una variable de entorno en el campo del array taskEnvironments, el valor del campo taskCount debe ser igual a la longitud del array taskEnvironments. La longitud máxima del array taskEnvironments es de 200.

¿Qué sigue?

• Si tienes problemas para crear o ejecutar una tarea, consulta Solución de problemas.
• Ver trabajos y tareas.
• Obtén más información sobre las opciones de creación de trabajos.