Crea y ejecuta un trabajo básico

En este documento, se explican los conceptos básicos de la creación de trabajos por lotes: 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 creación y ejecución de trabajos.

Antes de comenzar

  • Si no has usado Batch antes, revisa Comienza a usar Batch y completa los requisitos previos para los proyectos y usuarios a fin de habilitar Batch.

  • Si quieres obtener los permisos que necesitas para crear un trabajo, pídele a tu administrador que te otorgue los siguientes roles de IAM:

    Si quieres obtener más información para otorgar funciones, consulta Administra el acceso.

    Es posible que también puedas obtener los permisos necesarios a través de los roles personalizados o de otros roles predefinidos.

  • 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 del proyecto, no es necesario que realices ninguna acción.
    • De lo contrario, debes configurar las herramientas de redes cuando creas un trabajo. Aprende a configurar las herramientas de redes de un trabajo antes de crear un trabajo básico, de modo que puedas modificar los siguientes ejemplos para cumplir con los requisitos de red.
    Si quieres obtener más información sobre la configuración de red de un trabajo, consulta Descripción general de las redes por lotes.
  • 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 o de disco de arranque para tu carga de trabajo o proyecto, no se requiere 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 personalizar el entorno del SO de la VM para que puedas modificar los siguientes ejemplos según tus requisitos.
    Si deseas obtener más información sobre el entorno del SO de la VM para un trabajo, consulta la Descripción general del entorno del SO de VM.

Crea un trabajo básico

Si deseas obtener 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. 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 ejecutables o los contenedores para tu trabajo. Para cubrir los conceptos básicos, en esta sección, se explica cómo crear un trabajo de ejemplo con un solo ejecutable, ya sea una secuencia de comandos o una imagen de contenedor:

El trabajo de ejemplo para ambos tipos de trabajos contiene un grupo de tareas con un arreglo 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 a fin de 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, gcloud CLI, 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, haz lo siguiente:

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

    Ir a Lista de trabajos

  2. Haz clic en Crear. Se abrirá la página Crear trabajo por lotes. En el panel izquierdo, está seleccionada 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 Nuevo ejecutable, agrega al menos una secuencia de comandos o un contenedor para que se ejecute este trabajo.

        Por ejemplo, para agregar un contenedor, haz lo siguiente:

        1. Selecciona URL de la imagen del contenedor (Container image URL) (predeterminado).

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

          Por ejemplo, para usar la imagen de 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 de contenedor, haz lo siguiente:

          1. Selecciona la casilla de verificación Override container image's CMD command. Aparecerá un cuadro de texto.

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

          3. Haz clic en Listo.

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

      3. En el campo Paralelismo, ingresa la cantidad de tareas que se ejecutarán de forma simultánea. La cantidad 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 paralelas 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 resistir la interrupción y deseas VMs con descuento, selecciona Spot.

      • De lo contrario, selecciona Estándar.

      Por ejemplo, selecciona Estándar (predeterminado).

    3. Selecciona la ubicación de este trabajo:

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

        Por ejemplo, selecciona us-central1 (Iowa) (predeterminado).

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

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

        • De lo contrario, selecciona cualquiera.

        Por ejemplo, selecciona any (predeterminado).

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

      • Para las cargas de trabajo comunes, haz clic en De uso general.

      • Para cargas de trabajo de alto rendimiento, haz clic en Optimizada para procesamiento.

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

      Por ejemplo, haz clic en De uso general (predeterminado).

    5. En el campo Serie, selecciona una serie de máquinas para las VM de este trabajo.

      Por ejemplo, si seleccionaste De uso general como la familia de máquinas, selecciona E2 (predeterminado).

    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 CPU virtuales, 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 vCPUs por tarea.

        Por ejemplo, ingresa 1 (valor predeterminado).

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

        Por ejemplo, ingresa 0.5 (valor predeterminado).

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

  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 gcloud CLI, 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. Si deseas 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.

    {
    "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.
    • CORES: Opcional La cantidad de núcleos (específicamente vCPUs, que por lo general representan medio núcleo físico) para asignar a cada tarea en miliCPU. Si no se especifica el campo cpuMilli, el valor se establece en 2000 (2 CPU virtuales).
    • MEMORY: Opcional Es la cantidad de memoria que se asignará a cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
    • MAX_RETRY_COUNT: Opcional 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 debe reintentar la tarea.
    • MAX_RUN_DURATION: Opcional El tiempo máximo que se permite que se ejecute una tarea antes de que se reintente o falle, con el formato de un valor en segundos seguido de s. Si no se especifica el campo maxRunDuration, el valor se establece en 604800s (7 días), que es el valor máximo.
    • TASK_COUNT: Opcional La cantidad de tareas para el 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 La cantidad de tareas que el trabajo ejecuta en simultáneo. La cantidad no puede ser mayor que la cantidad de tareas y debe ser un número entero entre 1 y el límite de tareas paralelas 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 del trabajo.

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. Si quieres 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": [
                    {
                        "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.
  • LOCATION: Es la ubicación del trabajo.
  • JOB_NAME: Es el nombre del trabajo.
  • CONTAINER: Es el contenedor que ejecuta cada tarea.
  • CORES: Opcional La cantidad de núcleos (en particular, vCPUs, que por lo general representan medio núcleo físico) para asignar a cada tarea en milésimas de CPU. Si no se especifica el campo cpuMilli, el valor se establece en 2000 (2 CPU virtuales).
  • MEMORY: Opcional Es la cantidad de memoria que se asignará a cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
  • MAX_RETRY_COUNT: Opcional La cantidad máxima de reintentos para una tarea. El valor debe ser un número entero que se encuentre entre 0 y 10. Si no se especifica el campo maxRetryCount, el valor se establece en 0, lo que significa que no se debe reintentar la tarea.
  • MAX_RUN_DURATION: Opcional El tiempo máximo que se permite que se ejecute una tarea antes de que se reintente o falle, con el formato de un valor en segundos seguido de s. Si no se especifica el campo maxRunDuration, el valor se establece en 604800s (7 días), que es el valor máximo.
  • TASK_COUNT: Opcional La cantidad de tareas para el 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 La cantidad de tareas que el trabajo ejecuta en simultáneo. La cantidad no puede ser mayor que la cantidad de tareas y debe ser un número entero entre 1 y el límite de tareas paralelas por trabajo. Si no se especifica el campo parallelism, el valor se establece en 1.

Por ejemplo, para crear un trabajo 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"
    }
}

donde PROJECT_ID es el ID de tu proyecto.

Go

Go

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Go.

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

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Java.

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

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Node.js.

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);
}

callCreateJob();

Python

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Python.

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++

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch C++.

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 básico de secuencia de comandos

Puedes crear un trabajo de secuencia de comandos básico con la consola de Google Cloud, gcloud CLI, 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 Lista de trabajos

  2. Haz clic en Crear. Se abrirá la página Crear trabajo por lotes. En el panel izquierdo, está seleccionada 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 Nuevo ejecutable, agrega al menos una secuencia de comandos o un contenedor para que se ejecute este trabajo.

        Por ejemplo, para agregar una secuencia de comandos, haz lo siguiente:

        1. Selecciona Secuencia de comandos. Aparecerá un cuadro de texto.

        2. En el cuadro de texto, 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 Cantidad de tareas, 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. La cantidad 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 paralelas 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 resistir la interrupción y deseas VMs con descuento, selecciona Spot.

      • De lo contrario, selecciona Estándar.

      Por ejemplo, selecciona Estándar (predeterminado).

    3. Selecciona la ubicación de este trabajo:

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

        Por ejemplo, selecciona us-central1 (Iowa) (predeterminado).

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

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

        • De lo contrario, selecciona cualquiera.

        Por ejemplo, selecciona any (predeterminado).

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

      • Para las cargas de trabajo comunes, haz clic en De uso general.

      • Para cargas de trabajo de alto rendimiento, haz clic en Optimizada para procesamiento.

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

      Por ejemplo, haz clic en De uso general (predeterminado).

    5. En el campo Serie, selecciona una serie de máquinas para las VM de este trabajo.

      Por ejemplo, si seleccionaste De uso general como la familia de máquinas, selecciona E2 (predeterminado).

    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 CPU virtuales, 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 vCPUs por tarea.

        Por ejemplo, ingresa 1 (valor predeterminado).

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

        Por ejemplo, ingresa 0.5 (valor predeterminado).

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

  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 un trabajo básico de secuencia de comandos, crea un archivo JSON con el siguiente contenido. Si deseas 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.

    {
    "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.
    • CORES: Opcional La cantidad de núcleos (específicamente vCPUs, que por lo general representan medio núcleo físico) para asignar a cada tarea en miliCPU. Si no se especifica el campo cpuMilli, el valor se establece en 2000 (2 CPU virtuales).
    • MEMORY: Opcional Es la cantidad de memoria que se asignará a cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
    • MAX_RETRY_COUNT: Opcional 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 debe reintentar la tarea.
    • MAX_RUN_DURATION: Opcional El tiempo máximo que se permite que se ejecute una tarea antes de que se reintente o falle, con el formato de un valor en segundos seguido de s. Si no se especifica el campo maxRunDuration, el valor se establece en 604800s (7 días), que es el valor máximo.
    • TASK_COUNT: Opcional La cantidad de tareas para el 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 La cantidad de tareas que el trabajo ejecuta en simultáneo. La cantidad no puede ser mayor que la cantidad de tareas y debe ser un número entero entre 1 y el límite de tareas paralelas 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 del trabajo.

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. Si quieres 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.
  • LOCATION: Es la ubicación del trabajo.
  • JOB_NAME: Es el nombre del trabajo.
  • SCRIPT: Es la secuencia de comandos que ejecuta cada tarea.
  • CORES: Opcional La cantidad de núcleos (en particular, vCPUs, que por lo general representan medio núcleo físico) para asignar a cada tarea en milésimas de CPU. Si no se especifica el campo cpuMilli, el valor se establece en 2000 (2 CPU virtuales).
  • MEMORY: Opcional Es la cantidad de memoria que se asignará a cada tarea en MB. Si no se especifica el campo memoryMib, el valor se establece en 2000 (2 GB).
  • MAX_RETRY_COUNT: Opcional La cantidad máxima de reintentos para una tarea. El valor debe ser un número entero que se encuentre entre 0 y 10. Si no se especifica el campo maxRetryCount, el valor se establece en 0, lo que significa que no se debe reintentar la tarea.
  • MAX_RUN_DURATION: Opcional El tiempo máximo que se permite que se ejecute una tarea antes de que se reintente o falle, con el formato de un valor en segundos seguido de s. Si no se especifica el campo maxRunDuration, el valor se establece en 604800s (7 días), que es el valor máximo.
  • 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 La cantidad de tareas que el trabajo ejecuta en simultáneo. La cantidad no puede ser mayor que la cantidad de tareas y debe ser un número entero entre 1 y el límite de tareas paralelas por trabajo. Si no se especifica el campo parallelism, el valor se establece en 1.

Por ejemplo, para crear un trabajo 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"
    }
}

donde PROJECT_ID es el ID de tu proyecto.

Go

Go

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Go.

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

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Java.

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

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Node.js.

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);
}

callCreateJob();

Python

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Python.

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++

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch C++.

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 ejecute un trabajo. Puedes usar cualquiera de las variables de entorno predefinidas para todos los trabajos por lotes y cualquier variable de entorno personalizada que definas mientras creas el trabajo.

Usa variables de entorno predefinidas

De forma predeterminada, los ejecutables de tu trabajo pueden usar las siguientes variables de entorno predefinidas:

  • BATCH_TASK_COUNT: Es la cantidad de tareas en un grupo de tareas.
  • BATCH_TASK_INDEX: Es el número de índice de una tarea en un grupo de tareas. La numeración del índice comienza en 0.
  • BATCH_HOSTS_FILE: Opcional La ruta de acceso al archivo que enumera todas las instancias de VM en ejecución en un grupo de tareas. Para usar esta variable de entorno, se requiere el campo requireHostsFile y se debe configurar como verdadero.

Para ver un ejemplo de cómo usar variables de entorno predefinidas, consulta los ejecutables del 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:

En el entorno seleccionado, defines el nombre y los valores de cada variable mediante uno de los siguientes subcampos de entorno:

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 definan y usen variables estándar. El primer trabajo de ejemplo tiene una variable para un ejecutable específico. El segundo trabajo de ejemplo tiene una variable de array con 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 de Define y usa una variable de entorno para un ejecutable. De lo contrario, si deseas definir un trabajo que pase una lista de variables de entorno a diferentes tareas según el índice de tarea, consulta el ejemplo a fin de obtener información sobre Define y usa una variable de entorno para cada tarea.

Define y usa una variable de entorno para un ejecutable

Para crear un trabajo que pase variables de entorno a un ejecutable con la gcloud CLI, 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 variable de entorno llevan 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

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 la tarea con gcloud CLI, usa el comando gcloud batch jobs submit y especifica el campo de array taskEnvironments en el archivo de configuración del trabajo.

Por ejemplo, para crear un trabajo que incluya un arreglo de 3 variables de entorno con nombres coincidentes y valores diferentes, y pase las variables de entorno a las secuencias de comandos de las tareas que coinciden con los índices de las variables del entorno en el arreglo:

  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 variable de entorno tienen 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: Es el valor de la variable de entorno que se pasa a la tercera tarea, para la que BATCH_TASK_INDEX es igual a 2.

  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 de Define y usa una variable de entorno para un ejecutable. De lo contrario, si deseas definir un trabajo que pase una lista de variables de entorno a diferentes tareas según el índice de tarea, consulta el ejemplo a fin de obtener información sobre Define y usa una variable de entorno para cada tarea.

Define y usa una variable de entorno para un ejecutable

Para crear un trabajo que pase variables de entorno a un 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.
  • VARIABLE_NAME: Es el nombre de la variable de entorno que se pasa a cada tarea. Por convención, los nombres de variable de entorno llevan mayúsculas.
  • VARIABLE_VALUE: Es el valor de la variable de entorno que se pasa a cada tarea.

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 la tarea 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 arreglo de 3 variables de entorno con nombres coincidentes y valores diferentes, y pase las variables de entorno a las secuencias de comandos de 3 tareas basadas en 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.
  • TASK_VARIABLE_NAME: Es el nombre de las variables de entorno que se pasaron a las tareas con índices coincidentes. Por convención, los nombres de variable de entorno tienen 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: Es el valor de la variable de entorno que se pasa a la tercera tarea, para la que BATCH_TASK_INDEX es igual a 2.

¿Qué sigue?