Créer et exécuter un job de base

Ce document présente les principes de base de la création de tâches par lot : comment créer et exécuter un job basé sur un script ou une image de conteneur, et utiliser des variables prédéfinies et personnalisées. Pour en savoir plus sur la création et l'exécution de jobs, consultez la page Présentation de la création et de l'exécution de tâches.

Avant de commencer

• Si vous n'avez jamais utilisé Batch, consultez la page Premiers pas avec Batch et activez Batch en remplissant les conditions préalables pour les projets et les utilisateurs.

• Pour obtenir les autorisations nécessaires pour créer une tâche, demandez à votre administrateur de vous attribuer les rôles IAM suivants:

  • Éditeur de tâches par lot (roles/batch.jobsEditor) sur le projet
  • Utilisateur du compte de service (roles/iam.serviceAccountUser) sur le compte de service du job, qui est par défaut le compte de service Compute Engine par défaut

  Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

  Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

• Chaque fois que vous créez une tâche, assurez-vous qu'elle dispose d'une configuration réseau valide.
  • Si vous n'avez pas d'exigences de mise en réseau spécifiques pour votre charge de travail ou votre projet et que vous n'avez pas modifié le réseau par défaut de votre projet, aucune action n'est requise.
  • Sinon, vous devez configurer la mise en réseau lorsque vous créez un job. Découvrez comment configurer la mise en réseau pour une tâche avant de créer une tâche de base. Vous pourrez ainsi modifier les exemples ci-dessous en fonction de vos exigences de mise en réseau.
  Pour en savoir plus sur la configuration réseau d'une tâche, consultez la page Présentation de la mise en réseau par lot.
• Chaque fois que vous créez une tâche, assurez-vous qu'elle dispose d'un environnement de système d'exploitation (OS) de VM valide.
  • Si vous n'avez pas d'exigences spécifiques concernant l'image de l'OS de la VM ou le disque de démarrage pour votre charge de travail ou votre projet, aucune action n'est requise.
  • Sinon, vous devez préparer une option d'environnement d'OS de VM valide. Avant de créer une tâche de base, autorisez la configuration par défaut pour l'environnement du système d'exploitation de la VM ou découvrez comment personnaliser celui-ci afin de pouvoir modifier les exemples ci-dessous en fonction de vos besoins.
  Pour en savoir plus sur l'environnement d'OS de VM pour une tâche, consultez la section Présentation de l'environnement d'OS de VM.

Créer une tâche de base

Pour en savoir plus sur tous les champs que vous pouvez spécifier pour une tâche, consultez la documentation de référence sur la ressource REST projects.locations.jobs. Pour résumer, une tâche se compose d'un tableau d'une ou de plusieurs tâches qui exécutent toutes un ou plusieurs exécutables, à savoir les scripts et/ou conteneurs exécutables de votre tâche. Pour couvrir les principes de base, cette section explique comment créer un exemple de tâche avec un seul exécutable (un script ou une image de conteneur) :

• Si vous souhaitez utiliser Batch pour écrire des tâches qui exécutent une image de conteneur, consultez la section Créer une tâche de conteneur.
• Dans le cas contraire, si vous ne savez pas si vous souhaitez utiliser des images de conteneurs ou si vous ne connaissez pas bien les conteneurs, nous vous recommandons de créer une tâche de script.

L'exemple de tâche pour ces deux types de tâches contient un groupe de tâches avec un tableau de quatre tâches. Chaque tâche imprime un message et son index vers la sortie standard et Cloud Logging. La définition de cette tâche spécifie un parallélisme de 2, ce qui indique que la tâche doit s'exécuter sur deux VM pour permettre l'exécution de deux tâches à la fois.

Créer une tâche de conteneur de base

Vous pouvez sélectionner ou créer une image de conteneur pour fournir le code et les dépendances de votre tâche à exécuter à partir de n'importe quel environnement de calcul. Pour en savoir plus, consultez les pages Utiliser des images de conteneurs et Exécuter des conteneurs sur des instances de VM.

Vous pouvez créer une tâche de conteneur de base à l'aide de la console Google Cloud, de la gcloud CLI, de l'API Batch, de Go, de Java, de Node.js, de Python ou de C++.

Console

Pour créer une tâche de conteneur de base à l'aide de la console Google Cloud, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page Liste des tâches.

   Accéder à la liste des jobs

2. Cliquez sur Créer. La page Créer un job par lot s'ouvre. Dans le volet de gauche, la page Informations sur le job est sélectionnée.

3. Configurez la page Informations sur le job:

   1. (Facultatif) Dans le champ Nom de la tâche, personnalisez le nom de la tâche.

      Par exemple, saisissez example-basic-job.

   2. Configurez la section Task details (Détails de la tâche) :

      1. Dans la fenêtre Nouvel exécutable, ajoutez au moins un script ou un conteneur à exécuter pour cette tâche.

         Par exemple, pour ajouter un conteneur, procédez comme suit:

         1. Sélectionnez URL de l'image du conteneur (par défaut).

         2. Dans le champ URL de l'image du conteneur, saisissez l'URL d'une image de conteneur que vous souhaitez exécuter pour chaque tâche de cette tâche.

            Par exemple, pour utiliser l'image de conteneur Docker busybox, saisissez l'URL suivante:

            gcr.io/google-containers/busybox
            

         3. Facultatif: Pour remplacer la commande ENTRYPOINT de l'image de conteneur, saisissez une commande dans le champ Point d'entrée.

            Par exemple, saisissez ce qui suit:

            /bin/sh
            

         4. Facultatif: Pour ignorer la commande CMD de l'image de conteneur, procédez comme suit:

            1. Cochez la case Remplacer la commande CMD de l'image de conteneur. Une zone de texte s'affiche.

            2. Dans la zone de texte, saisissez une ou plusieurs commandes, en les séparant par une ligne.

               Par exemple, saisissez les commandes suivantes:

               -c
               echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
               

            3. Cliquez sur OK.

      2. Dans le champ Nombre de tâches, saisissez le nombre de tâches associées à cette tâche. La valeur doit être un nombre entier compris entre 1 et la limite de tâches par groupe de tâches.

         Par exemple, saisissez 4.

      3. Dans le champ Parallelism, saisissez le nombre de tâches à exécuter simultanément. Ce nombre ne peut pas être supérieur au nombre total de tâches et doit être un nombre entier compris entre 1 et la limite de tâches parallèles par tâche.

         Par exemple, saisissez 2.

4. Configurez la page Spécifications des ressources:

   1. Dans le volet de gauche, cliquez sur Spécifications des ressources. La page Spécifications des ressources s'ouvre.

   2. Dans la section Modèle de provisionnement de VM, sélectionnez l'une des options suivantes pour le modèle de provisionnement des VM de cette tâche:

      • Si votre tâche peut résister à la préemption et que vous souhaitez bénéficier de VM à prix réduit, sélectionnez Spot.

      • Sinon, sélectionnez Standard.

      Par exemple, sélectionnez Standard (par défaut).

   3. Sélectionnez le lieu pour cette tâche:

      1. Dans le champ Région, sélectionnez une région.

         Par exemple, sélectionnez us-central1 (Iowa) (par défaut).

      2. Dans le champ Zone, effectuez l'une des opérations suivantes:

         • Si vous souhaitez que cette tâche ne s'exécute que dans une zone spécifique, sélectionnez une zone.

         • Sinon, sélectionnez Toutes.

         Par exemple, sélectionnez any (par défaut).

   4. Sélectionnez l'une des familles de machines suivantes:

      • Pour les charges de travail courantes, cliquez sur Usage général.

      • Pour les charges de travail exigeantes en performances, cliquez sur Optimisé pour le calcul.

      • Pour les charges de travail exigeantes en mémoire, cliquez sur Mémoire optimisée.

      Par exemple, cliquez sur Usage général (par défaut).

   5. Dans le champ Série, sélectionnez une série de machines pour les VM de ce job.

      Par exemple, si vous avez sélectionné Usage général pour la famille de machines, sélectionnez E2 (par défaut).

   6. Dans le champ Type de machine, sélectionnez un type de machine pour les VM de ce job.

      Par exemple, si vous avez sélectionné E2 pour la série de machines, sélectionnez e2-medium (2 vCPU, 4 Go de mémoire) (par défaut).

   7. Configurez la quantité de ressources de VM requise pour chaque tâche:

      1. Dans le champ Cœurs, saisissez le nombre de vCPUs par tâche.

         Par exemple, saisissez 1 (par défaut).

      2. Dans le champ Memory (Mémoire), saisissez la quantité de RAM en Go par tâche.

         Par exemple, saisissez 0.5 (par défaut).

5. Facultatif: Pour vérifier la configuration de la tâche, cliquez sur Aperçu dans le volet de gauche.

6. Cliquez sur Créer.

La page Informations sur le job affiche le job que vous avez créé.

gcloud

Pour créer une tâche de conteneur de base à l'aide de la gcloud CLI, procédez comme suit:

1. Créez un fichier JSON qui spécifie les détails de configuration de votre job. Par exemple, pour créer une tâche de conteneur de base, créez un fichier JSON avec le contenu suivant. Pour en savoir plus sur tous les champs que vous pouvez spécifier pour une tâche, consultez la documentation de référence sur la ressource 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
           }
       ]
   }
   

   Remplacez les éléments suivants :

   • CONTAINER: conteneur exécuté par chaque tâche.
   • CORES : facultatif. Nombre de cœurs, en particulier les vCPUs, qui représentent généralement la moitié d'un cœur physique, à allouer à chaque tâche en unités de milliprocesseurs. Si le champ cpuMilli n'est pas spécifié, la valeur est définie sur 2000 (2 processeurs virtuels).
   • MEMORY : facultatif. Quantité de mémoire à allouer pour chaque tâche en Mo. Si le champ memoryMib n'est pas spécifié, la valeur est définie sur 2000 (2 Go).
   • MAX_RETRY_COUNT : facultatif. Nombre maximal de nouvelles tentatives pour une tâche. La valeur doit être un nombre entier compris entre 0 et 10. Si le champ maxRetryCount n'est pas spécifié, la valeur est définie sur 0, ce qui signifie qu'il n'est pas nécessaire de relancer la tâche. Pour en savoir plus sur le champ maxRetryCount, consultez la section Automatiser les nouvelles tentatives de tâches.
   • MAX_RUN_DURATION : facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, formatée en tant que valeur en secondes suivie de s (par exemple, 3600s pendant une heure). Si le champ maxRunDuration n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champ maxRunDuration, consultez Limiter la durée d'exécution des tâches et des exécutables à l'aide de délais d'inactivité.
   • TASK_COUNT : facultatif. Le nombre de tâches pour la tâche. La valeur doit être un nombre entier compris entre 1 et la limite de tâches par groupe de tâches. Si le champ taskCount n'est pas spécifié, la valeur est définie sur 1.
   • PARALLELISM : facultatif. Nombre de tâches que la tâche exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches et doit être un nombre entier compris entre 1 et la limite de tâches parallèles par tâche. Si le champ parallelism n'est pas spécifié, la valeur est définie sur 1.

2. Créez une tâche à l'aide de la commande gcloud batch jobs submit.

   gcloud batch jobs submit JOB_NAME \
     --location LOCATION \
     --config JSON_CONFIGURATION_FILE
   

   Remplacez les éléments suivants :

   • JOB_NAME: nom de la tâche.
   • LOCATION: lieu de la tâche.
   • JSON_CONFIGURATION_FILE: chemin d'accès à un fichier JSON contenant les détails de configuration de la tâche.

Par exemple, pour créer une tâche qui exécute des tâches à l'aide de l'image de conteneur Docker busybox:

1. Dans le répertoire actuel, créez un fichier JSON nommé hello-world-container.json avec le contenu suivant:

   {
       "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. Exécutez la commande ci-dessous.

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

API

Pour créer une tâche de conteneur de base à l'aide de l'API Batch, utilisez la méthode jobs.create. Pour en savoir plus sur tous les champs que vous pouvez spécifier pour une tâche, consultez la documentation de référence sur la ressource 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
        }
    ]
}

Remplacez les éléments suivants :

• PROJECT_ID: ID de votre projet.
• LOCATION: lieu de la tâche.
• JOB_NAME: nom de la tâche.
• CONTAINER: conteneur exécuté par chaque tâche.
• CORES : facultatif. Nombre de cœurs (en particulier les vCPUs, qui représentent généralement la moitié d'un cœur physique) à allouer à chaque tâche en unités de milliprocesseurs. Si le champ cpuMilli n'est pas spécifié, la valeur est définie sur 2000 (2 processeurs virtuels).
• MEMORY : facultatif. Quantité de mémoire à allouer pour chaque tâche en Mo. Si le champ memoryMib n'est pas spécifié, la valeur est définie sur 2000 (2 Go).
• MAX_RETRY_COUNT : facultatif. Nombre maximal de nouvelles tentatives pour une tâche. La valeur doit être un nombre entier compris entre 0 et 10. Si le champ maxRetryCount n'est pas spécifié, la valeur est définie sur 0, ce qui signifie qu'il n'est pas nécessaire de relancer la tâche. Pour en savoir plus sur le champ maxRetryCount, consultez la section Automatiser les nouvelles tentatives de tâches.
• MAX_RUN_DURATION : facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, formatée en tant que valeur en secondes suivie de s (par exemple, 3600s pendant une heure). Si le champ maxRunDuration n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champ maxRunDuration, consultez Limiter la durée d'exécution des tâches et des exécutables à l'aide de délais d'inactivité.
• TASK_COUNT : facultatif. Nombre de tâches de la tâche, qui doit être un nombre entier compris entre 1 et la limite de tâches par groupe de tâches. Si le champ taskCount n'est pas spécifié, la valeur est définie sur 1.
• PARALLELISM : facultatif. Nombre de tâches que la tâche exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches. Il doit être un nombre entier compris entre 1 et la limite de tâches parallèles par tâche. Si le champ parallelism n'est pas spécifié, la valeur est définie sur 1.

Par exemple, pour créer une tâche qui exécute des tâches à l'aide de l'image de conteneur Docker busybox, utilisez la requête suivante:

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

où PROJECT_ID est l'ID de votre projet.

Go

Go

Pour en savoir plus, consultez la documentation de référence de l'API Batch Go.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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

Pour en savoir plus, consultez la documentation de référence de l'API Batch Java.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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

Pour en savoir plus, consultez la documentation de référence de l'API Batch Node.js.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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

Pour en savoir plus, consultez la documentation de référence de l'API Batch Python.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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++

Pour en savoir plus, consultez la documentation de référence de l'API Batch C++.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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";
  }

Créer une tâche de script de base

Vous pouvez créer une tâche de script de base à l'aide de la console Google Cloud, de la gcloud CLI, de l'API Batch, de Go, de Java, de Node.js, de Python ou de C++.

Console

Pour créer une tâche de script de base à l'aide de la console Google Cloud, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page Liste des tâches.

   Accéder à la liste des jobs

2. Cliquez sur Créer. La page Créer un job par lot s'ouvre. Dans le volet de gauche, la page Informations sur le job est sélectionnée.

3. Configurez la page Informations sur le job:

   1. (Facultatif) Dans le champ Nom de la tâche, personnalisez le nom de la tâche.

      Par exemple, saisissez example-basic-job.

   2. Configurez la section Task details (Détails de la tâche) :

      1. Dans la fenêtre Nouvel exécutable, ajoutez au moins un script ou un conteneur à exécuter pour cette tâche.

         Par exemple, pour ajouter un script, procédez comme suit:

         1. Sélectionnez Script. Une zone de texte s'affiche.

         2. Dans la zone de texte, saisissez le script que vous souhaitez exécuter pour chaque tâche de ce job.

            Par exemple, saisissez le script suivant:

            echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
            

         3. Cliquez sur OK.

      2. Dans le champ Nombre de tâches, saisissez le nombre de tâches associées à cette tâche. La valeur doit être un nombre entier compris entre 1 et la limite de tâches par groupe de tâches.

         Par exemple, saisissez 4.

      3. Dans le champ Parallelism, saisissez le nombre de tâches à exécuter simultanément. Ce nombre ne peut pas être supérieur au nombre total de tâches et doit être un nombre entier compris entre 1 et la limite de tâches parallèles par tâche.

         Par exemple, saisissez 2.

4. Configurez la page Spécifications des ressources:

   1. Dans le volet de gauche, cliquez sur Spécifications des ressources. La page Spécifications des ressources s'ouvre.

   2. Dans la section Modèle de provisionnement de VM, sélectionnez l'une des options suivantes pour le modèle de provisionnement des VM de cette tâche:

      • Si votre tâche peut résister à la préemption et que vous souhaitez bénéficier de VM à prix réduit, sélectionnez Spot.

      • Sinon, sélectionnez Standard.

      Par exemple, sélectionnez Standard (par défaut).

   3. Sélectionnez le lieu pour cette tâche:

      1. Dans le champ Région, sélectionnez une région.

         Par exemple, sélectionnez us-central1 (Iowa) (par défaut).

      2. Dans le champ Zone, effectuez l'une des opérations suivantes:

         • Si vous souhaitez que ce job ne s'exécute que dans une zone spécifique, sélectionnez une zone.

         • Sinon, sélectionnez Toutes.

         Par exemple, sélectionnez any (par défaut).

   4. Sélectionnez l'une des familles de machines suivantes:

      • Pour les charges de travail courantes, cliquez sur Usage général.

      • Pour les charges de travail exigeantes en performances, cliquez sur Optimisé pour le calcul.

      • Pour les charges de travail exigeantes en mémoire, cliquez sur Mémoire optimisée.

      Par exemple, cliquez sur Usage général (par défaut).

   5. Dans le champ Série, sélectionnez une série de machines pour les VM de ce job.

      Par exemple, si vous avez sélectionné Usage général pour la famille de machines, sélectionnez E2 (par défaut).

   6. Dans le champ Type de machine, sélectionnez un type de machine pour les VM de ce job.

      Par exemple, si vous avez sélectionné E2 pour la série de machines, sélectionnez e2-medium (2 vCPU, 4 Go de mémoire) (par défaut).

   7. Configurez la quantité de ressources de VM requise pour chaque tâche:

      1. Dans le champ Cœurs, saisissez le nombre de vCPUs par tâche.

         Par exemple, saisissez 1 (par défaut).

      2. Dans le champ Memory (Mémoire), saisissez la quantité de RAM en Go par tâche.

         Par exemple, saisissez 0.5 (par défaut).

5. Facultatif: Pour vérifier la configuration de la tâche, cliquez sur Aperçu dans le volet de gauche.

6. Cliquez sur Créer.

La page Informations sur le job affiche le job que vous avez créé.

gcloud

Pour créer une tâche de script de base à l'aide de la gcloud CLI, procédez comme suit:

1. Créez un fichier JSON qui spécifie les détails de configuration de votre job. Par exemple, pour créer une tâche de script de base, créez un fichier JSON avec le contenu suivant. Pour en savoir plus sur tous les champs que vous pouvez spécifier pour une tâche, consultez la documentation de référence sur la ressource 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
           }
       ]
   }
   

   Remplacez les éléments suivants :

   • SCRIPT: script exécuté par chaque tâche.
   • CORES : facultatif. Nombre de cœurs, en particulier les vCPUs, qui représentent généralement la moitié d'un cœur physique, à allouer à chaque tâche en unités de milliprocesseurs. Si le champ cpuMilli n'est pas spécifié, la valeur est définie sur 2000 (2 processeurs virtuels).
   • MEMORY : facultatif. Quantité de mémoire à allouer pour chaque tâche en Mo. Si le champ memoryMib n'est pas spécifié, la valeur est définie sur 2000 (2 Go).
   • MAX_RETRY_COUNT : facultatif. Nombre maximal de nouvelles tentatives pour une tâche. La valeur doit être un nombre entier compris entre 0 et 10. Si le champ maxRetryCount n'est pas spécifié, la valeur est définie sur 0, ce qui signifie qu'il n'est pas nécessaire de relancer la tâche. Pour en savoir plus sur le champ maxRetryCount, consultez la section Automatiser les nouvelles tentatives de tâches.
   • MAX_RUN_DURATION : facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, formatée en tant que valeur en secondes suivie de s (par exemple, 3600s pendant une heure). Si le champ maxRunDuration n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champ maxRunDuration, consultez Limiter la durée d'exécution des tâches et des exécutables à l'aide de délais d'inactivité.
   • TASK_COUNT : facultatif. Le nombre de tâches pour la tâche. La valeur doit être un nombre entier compris entre 1 et la limite de tâches par groupe de tâches. Si le champ taskCount n'est pas spécifié, la valeur est définie sur 1.
   • PARALLELISM : facultatif. Nombre de tâches que la tâche exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches et doit être un nombre entier compris entre 1 et la limite de tâches parallèles par tâche. Si le champ parallelism n'est pas spécifié, la valeur est définie sur 1.

2. Créez une tâche à l'aide de la commande gcloud batch jobs submit.

   gcloud batch jobs submit JOB_NAME \
     --location LOCATION \
     --config JSON_CONFIGURATION_FILE
   

   Remplacez les éléments suivants :

   • JOB_NAME: nom de la tâche.
   • LOCATION: lieu de la tâche.
   • JSON_CONFIGURATION_FILE: chemin d'accès à un fichier JSON contenant les détails de configuration de la tâche.

Par exemple, pour créer une tâche qui exécute des tâches à l'aide d'un script:

1. Dans le répertoire actuel, créez un fichier JSON nommé hello-world-script.json avec le contenu suivant:

   {
       "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. Exécutez la commande ci-dessous.

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

API

Pour créer une tâche de script de base à l'aide de l'API Batch, utilisez la méthode jobs.create. Pour en savoir plus sur tous les champs que vous pouvez spécifier pour une tâche, consultez la documentation de référence sur la ressource 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
        }
    ]
}

Remplacez les éléments suivants :

• PROJECT_ID: ID de votre projet.
• LOCATION: lieu de la tâche.
• JOB_NAME: nom de la tâche.
• SCRIPT: script exécuté par chaque tâche.
• CORES : facultatif. Nombre de cœurs (en particulier les vCPUs, qui représentent généralement la moitié d'un cœur physique) à allouer à chaque tâche en unités de milliprocesseurs. Si le champ cpuMilli n'est pas spécifié, la valeur est définie sur 2000 (2 processeurs virtuels).
• MEMORY : facultatif. Quantité de mémoire à allouer pour chaque tâche en Mo. Si le champ memoryMib n'est pas spécifié, la valeur est définie sur 2000 (2 Go).
• MAX_RETRY_COUNT : facultatif. Nombre maximal de nouvelles tentatives pour une tâche. La valeur doit être un nombre entier compris entre 0 et 10. Si le champ maxRetryCount n'est pas spécifié, la valeur est définie sur 0, ce qui signifie qu'il n'est pas nécessaire de relancer la tâche. Pour en savoir plus sur le champ maxRetryCount, consultez la section Automatiser les nouvelles tentatives de tâches.
• MAX_RUN_DURATION : facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, formatée en tant que valeur en secondes suivie de s (par exemple, 3600s pendant une heure). Si le champ maxRunDuration n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champ maxRunDuration, consultez Limiter la durée d'exécution des tâches et des exécutables à l'aide de délais d'inactivité.
• TASK_COUNT : facultatif. Nombre de tâches associées au job. La valeur doit être un nombre entier compris entre 1 et la limite de tâches par groupe de tâches. Si le champ taskCount n'est pas spécifié, la valeur est définie sur 1.
• PARALLELISM : facultatif. Nombre de tâches que la tâche exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches. Il doit être un nombre entier compris entre 1 et la limite de tâches parallèles par tâche. Si le champ parallelism n'est pas spécifié, la valeur est définie sur 1.

Par exemple, pour créer une tâche qui exécute des tâches à l'aide d'un script, utilisez la requête suivante:

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

où PROJECT_ID est l'ID de votre projet.

Go

Go

Pour en savoir plus, consultez la documentation de référence de l'API Batch Go.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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

Pour en savoir plus, consultez la documentation de référence de l'API Batch Java.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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

Pour en savoir plus, consultez la documentation de référence de l'API Batch Node.js.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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

Pour en savoir plus, consultez la documentation de référence de l'API Batch Python.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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++

Pour en savoir plus, consultez la documentation de référence de l'API Batch C++.

Pour vous authentifier auprès de Batch, configurez les Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement 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";
  }

Utiliser des variables d'environnement

Utilisez des variables d'environnement lorsque vous écrivez une image de conteneur ou un script que vous souhaitez exécuter par une tâche. Vous pouvez utiliser n'importe quelle variable d'environnement prédéfinie pour tous les jobs par lot et toutes les variables d'environnement personnalisées que vous définissez lors de la création de la tâche.

Utiliser des variables d'environnement prédéfinies

Par défaut, les exécutables de votre tâche peuvent utiliser les variables d'environnement prédéfinies suivantes:

• BATCH_TASK_COUNT: nombre total de tâches dans ce groupe de tâches.
• BATCH_TASK_INDEX: numéro d'index de cette tâche dans le groupe de tâches. L'index de la première tâche est 0 et est incrémenté pour chaque tâche supplémentaire.
• BATCH_HOSTS_FILE: chemin d'accès à un fichier listant toutes les instances de VM en cours d'exécution dans ce groupe de tâches. Pour utiliser cette variable d'environnement, le champ requireHostsFile doit être défini sur true.
• BATCH_TASK_RETRY_ATTEMPT: nombre de fois où cette tâche a déjà été tentée. La valeur est 0 lors de la première tentative d'une tâche et est incrémentée à chaque nouvelle tentative. Le nombre total de tentatives autorisées pour une tâche est déterminé par la valeur du champ maxRetryCount, qui est 0 si elle n'est pas définie. Pour en savoir plus sur la répétition des tentatives, consultez la section Automatiser les nouvelles tentatives d'exécution de tâches.

Pour obtenir un exemple d'utilisation de variables d'environnement prédéfinies, consultez les exemples d'exécutables précédents dans la section Créer une tâche de base de ce document.

Définir et utiliser des variables d'environnement personnalisées

Vous pouvez éventuellement définir une ou plusieurs variables d'environnement personnalisées dans une tâche.

Vous définissez chaque variable dans un environnement spécifique en fonction du champ d'application souhaité de ses données:

• Pour une variable ayant la même valeur pour toutes les tâches, utilisez l'une des options suivantes:

  • Si la variable a la même valeur pour tous les exécutables, utilisez l'environnement de tous les exécutables (sous-champ environment de taskSpec).

  • Sinon, si la variable possède une valeur distincte pour tous les exécutables, utilisez un ou plusieurs environnements d'exécutables spécifiques (sous-champ environment de runnables[]).

• Sinon, pour une variable de tableau ayant une valeur distincte pour chaque tâche, utilisez l'environnement de toutes les tâches (taskEnvironment).

Dans l'environnement sélectionné, définissez le nom et les valeurs de chaque variable à l'aide de l'un des sous-champs d'environnement suivants:

• Pour définir la variable directement dans le fichier JSON de configuration de la tâche, utilisez le sous-champ des variables standards (variables), comme indiqué dans cette section. Cette option est recommandée pour les données que vous ne souhaitez pas chiffrer.

• Pour définir la variable à l'aide de données chiffrées, vous pouvez utiliser Secret Manager ou Cloud Key Management Service:

  • Pour utiliser le contenu chiffré d'un secret Secret Manager existant, utilisez le sous-champ des variables secrètes (secretVariables). Pour en savoir plus sur l'utilisation de secrets dans une tâche, consultez la page Protéger les données sensibles à l'aide de Secret Manager.

  • Pour utiliser le contenu chiffré d'une clé Cloud Key Management Service existante, utilisez le sous-champ des variables chiffrées (encryptedVariables). Pour en savoir plus sur les clés Cloud KMS, consultez la documentation de Cloud Key Management Service.

Vous pouvez définir et utiliser des variables d'environnement personnalisées pour votre job à l'aide de gcloud CLI ou de l'API Batch. Les exemples suivants expliquent comment créer deux tâches qui définissent et utilisent des variables standards. Le premier exemple de job comporte une variable pour un exécutable spécifique. Le deuxième exemple de tâche comporte une variable de tableau, qui a une valeur différente pour chaque tâche.

gcloud

Si vous souhaitez définir une tâche qui transmet une variable d'environnement à un exécutable que chaque tâche exécute, consultez l'exemple pour savoir comment définir et utiliser une variable d'environnement pour un exécutable. Sinon, si vous souhaitez définir une tâche qui transmet une liste de variables d'environnement à différentes tâches en fonction de l'index de tâches, consultez l'exemple Définir et utiliser une variable d'environnement pour chaque tâche.

Définir et utiliser une variable d'environnement pour un exécutable

Pour créer une tâche qui transmet des variables d'environnement à un exécutable à l'aide de gcloud CLI, utilisez la commande gcloud batch jobs submit et spécifiez les variables d'environnement dans le fichier de configuration de la tâche.

Par exemple, pour créer une tâche de script qui définit une variable d'environnement et la transmet aux scripts de trois tâches, exécutez la requête suivante:

1. Dans le répertoire actuel, créez un fichier JSON nommé hello-world-environment-variables.json avec le contenu suivant:

   {
       "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"
                   }
               }
           ]
       }
   }
   

   Remplacez les éléments suivants :

   • VARIABLE_NAME: nom de la variable d'environnement transmise à chaque tâche. Par convention, les noms des variable d'environnement commencent par une majuscule.
   • VARIABLE_VALUE : facultatif. La valeur de la variable d'environnement transmise à chaque tâche.

2. Exécutez la commande ci-dessous.

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

Définir et utiliser une variable d'environnement pour chaque tâche

Pour créer une tâche qui transmet des variables d'environnement à une tâche en fonction de l'index de tâches à l'aide de gcloud CLI, utilisez la commande gcloud batch jobs submit et spécifiez le champ de tableau taskEnvironments dans le fichier de configuration de la tâche.

Par exemple, pour créer une tâche qui inclut un tableau de trois variables d'environnement avec des noms correspondants et des valeurs différentes, puis transmettre les variables d'environnement aux scripts des tâches dont les index correspondent aux index des variables d'environnement dans le tableau:

1. Dans le répertoire actuel, créez un fichier JSON nommé hello-world-task-environment-variables.json avec le contenu suivant:

   {
       "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"
                   }
               }
           ]
       }
   }
   

   Remplacez les éléments suivants :

   • TASK_VARIABLE_NAME: nom des variables d'environnement de tâche transmises aux tâches dont les index correspondent. Par convention, les noms de variable d'environnement sont en majuscules.
   • TASK_VARIABLE_VALUE_0: valeur de la variable d'environnement transmise à la première tâche, pour laquelle BATCH_TASK_INDEX est égal à 0.
   • TASK_VARIABLE_VALUE_1: valeur de la variable d'environnement transmise à la deuxième tâche, pour laquelle BATCH_TASK_INDEX est égal à 1.
   • TASK_VARIABLE_VALUE_2: valeur de la variable d'environnement transmise à la troisième tâche, pour laquelle BATCH_TASK_INDEX est égal à 2.
   Remarque :Si une variable d'environnement est spécifiée dans le champ de tableau taskEnvironments, la valeur du champ taskCount doit alors être égale à la longueur du tableau taskEnvironments. La longueur maximale du tableau taskEnvironments est de 200.

2. Exécutez la commande ci-dessous.

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

API

Si vous souhaitez définir une tâche qui transmet une variable d'environnement à un exécutable que chaque tâche exécute, consultez l'exemple pour savoir comment définir et utiliser une variable d'environnement pour un exécutable. Sinon, si vous souhaitez définir une tâche qui transmet une liste de variables d'environnement à différentes tâches en fonction de l'index de tâches, consultez l'exemple Définir et utiliser une variable d'environnement pour chaque tâche.

Définir et utiliser une variable d'environnement pour un exécutable

Pour créer une tâche qui transmet des variables d'environnement à un exécutable à l'aide de l'API Batch, utilisez la commande gcloud batch jobs submit et spécifiez les variables d'environnement dans le champ environment.

Par exemple, pour créer une tâche qui inclut une variable d'environnement et la transmet aux scripts de trois tâches, exécutez la requête suivante:

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

Remplacez les éléments suivants :

• PROJECT_ID: ID de votre projet.
• VARIABLE_NAME: nom de la variable d'environnement transmise à chaque tâche. Par convention, les noms des variable d'environnement sont en majuscules.
• VARIABLE_VALUE: valeur de la variable d'environnement transmise à chaque tâche.

Définir et utiliser une variable d'environnement pour chaque tâche

Pour créer une tâche qui transmet des variables d'environnement à une tâche en fonction de l'index de tâches à l'aide de l'API Batch, utilisez la méthode jobs.create et spécifiez les variables d'environnement dans le champ de tableau taskEnvironments.

Par exemple, pour créer une tâche qui inclut un tableau de trois variables d'environnement avec des noms correspondants et des valeurs différentes, puis transmettre les variables d'environnement aux scripts de trois tâches en fonction de leurs index, exécutez la requête suivante:

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

Remplacez les éléments suivants :

• PROJECT_ID: ID de votre projet.
• TASK_VARIABLE_NAME: nom des variables d'environnement transmises aux tâches dont les index correspondent. Par convention, les noms de variable d'environnement sont en majuscules.
• TASK_VARIABLE_VALUE_0: valeur de la variable d'environnement transmise à la première tâche, pour laquelle BATCH_TASK_INDEX est égal à 0.
• TASK_VARIABLE_VALUE_1: valeur de la variable d'environnement transmise à la deuxième tâche, pour laquelle BATCH_TASK_INDEX est égal à 1.
• TASK_VARIABLE_VALUE_2: valeur de la variable d'environnement transmise à la troisième tâche, pour laquelle BATCH_TASK_INDEX est égal à 2.

Remarque :Si une variable d'environnement est spécifiée dans le champ de tableau taskEnvironments, la valeur du champ taskCount doit être égale à la longueur du tableau taskEnvironments. La longueur maximale du tableau taskEnvironments est de 200.

Étapes suivantes

• Si vous rencontrez des problèmes pour créer ou exécuter un job, consultez la section Dépannage.
• Afficher les jobs et les tâches
• Apprenez-en plus sur les options de création de tâches.