Einfachen Job erstellen und ausführen

In diesem Dokument werden die Grundlagen der Batch-Joberstellung erläutert. Sie erfahren, wie Sie einen Job erstellen und ausführen, der auf einem Skript oder Container-Image basiert, und wie Sie vordefinierte und benutzerdefinierte Variablen verwenden. Weitere Informationen zum Erstellen und Ausführen von Jobs finden Sie unter Joberstellung und -ausführung – Übersicht.

Hinweise

  • Wenn Sie Batch noch nicht verwendet haben, lesen Sie Erste Schritte mit Batch. Aktivieren Sie Batch, indem Sie die Voraussetzungen für Projekte und Nutzer erfüllen.
  • Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zu gewähren, damit Sie die Berechtigungen erhalten, die Sie zum Erstellen eines Jobs benötigen:

    Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.

    Möglicherweise können Sie die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

  • Prüfen Sie bei jedem Erstellen eines Jobs, ob der Job eine gültige Netzwerkkonfiguration hat.
    • Wenn für Ihre Arbeitslast oder Ihr Projekt keine spezifischen Netzwerkanforderungen gelten und Sie das Standardnetzwerk für Ihr Projekt nicht geändert haben, sind keine Maßnahmen erforderlich.
    • Andernfalls müssen Sie das Netzwerk beim Erstellen eines Jobs konfigurieren. Erfahren Sie, wie Sie das Netzwerk für einen Job konfigurieren, bevor Sie einen einfachen Job erstellen, damit Sie die folgenden Beispiele an Ihre Netzwerkanforderungen anpassen können.
    Weitere Informationen zur Netzwerkkonfiguration für einen Job finden Sie unter Batch-Netzwerkübersicht.
  • Prüfen Sie bei jedem Erstellen eines Jobs, ob dieser eine gültige VM-Betriebssystemumgebung hat.
    • Wenn Sie für Ihre Arbeitslast oder Ihr Projekt keine spezifischen Anforderungen für VM-Betriebssystem-Images oder Bootlaufwerke haben, sind keine Maßnahmen erforderlich.
    • Andernfalls müssen Sie eine gültige Option für die VM-Betriebssystemumgebung vorbereiten. Bevor Sie einen einfachen Job erstellen, müssen Sie entweder die Standardkonfiguration für die VM-Betriebssystemumgebung zulassen oder sich damit vertraut machen, wie Sie die VM-Betriebssystemumgebung anpassen können, um die folgenden Beispiele an Ihre Anforderungen anzupassen.
    Weitere Informationen zur VM-Betriebssystemumgebung für einen Job finden Sie unter VM-Betriebssystemumgebung – Übersicht.

Einfachen Job erstellen

Informationen zu allen Feldern, die Sie für einen Job angeben können, finden Sie in der Referenzdokumentation zur REST-Ressource projects.locations.jobs. Zusammenfassend lässt sich sagen, dass ein Job aus einem Array mit einer oder mehreren Aufgaben besteht, die alle ein oder mehrere runnables ausführen. Dies sind die ausführbaren Skripts und/oder Container für Ihren Job. In diesem Abschnitt wird erläutert, wie Sie einen Beispieljob mit nur einem Runnable erstellen, entweder mit einem Skript oder mit einem Container-Image, um die Grundlagen zu vermitteln:

  • Wenn Sie Batch zum Schreiben von Jobs verwenden möchten, die ein Container-Image ausführen, lesen Sie Containerjob erstellen.
  • Wenn Sie nicht sicher sind, ob Sie Container-Images verwenden sollen, oder wenn Sie mit Containern nicht vertraut sind, sollten Sie einen Skriptjob erstellen.

Der Beispieljob für beide Arten von Jobs enthält eine Aufgabengruppe mit einem Array aus vier Aufgaben. Jede Aufgabe gibt eine Nachricht und ihren Index in der Standardausgabe und in Cloud Logging aus. Die Definition für diesen Job gibt eine Parallelität von 2 an. Dies bedeutet, dass der Job auf 2 VMs ausgeführt werden soll, damit zwei Aufgaben gleichzeitig ausgeführt werden können.

Einfachen Containerjob erstellen

Sie können ein Container-Image auswählen oder erstellen, um den Code und die Abhängigkeiten bereitzustellen, damit Ihr Job in einer beliebigen Computing-Umgebung ausgeführt werden kann. Weitere Informationen finden Sie unter Mit Container-Images arbeiten und Container auf VM-Instanzen ausführen.

Sie können einen einfachen Containerjob mit der Google Cloud Console, der gcloud CLI, Batch API, Go, Java, Node.js, Python oder C++ erstellen.

Console

So erstellen Sie einen einfachen Containerjob mit der Google Cloud Console:

  1. Rufen Sie in der Google Cloud Console die Seite Jobliste auf.

    Zur Jobliste

  2. Klicken Sie auf Erstellen. Die Seite Batchjob erstellen wird geöffnet. Im linken Bereich ist die Seite Jobdetails ausgewählt.

  3. Konfigurieren Sie die Seite Jobdetails:

    1. Optional: Passen Sie im Feld Jobname den Jobnamen an.

      Geben Sie beispielsweise example-basic-job ein.

    2. Konfigurieren Sie den Bereich Aufgabendetails:

      1. Fügen Sie im Fenster New runnable mindestens ein Script oder einen Container für die Ausführung dieses Jobs hinzu.

        So fügen Sie beispielsweise einen Container hinzu:

        1. Wählen Sie Container-Image-URL aus (Standard).

        2. Geben Sie im Feld Container-Image-URL die URL für ein Container-Image ein, das Sie für jede Aufgabe in diesem Job ausführen möchten.

          Wenn Sie beispielsweise das Docker-Container-Image busybox verwenden möchten, geben Sie die folgende URL ein:

          gcr.io/google-containers/busybox
          
        3. Optional: Geben Sie in das Feld Einstiegspunkt einen Befehl ein, um den Befehl ENTRYPOINT des Container-Images zu überschreiben.

          Geben Sie beispielsweise Folgendes ein:

          /bin/sh
          
        4. Optional: So überschreiben Sie den Befehl CMD des Container-Images:

          1. Klicken Sie das Kästchen CMD-Befehl des Container-Images überschreiben an. Ein Textfeld wird angezeigt.

          2. Geben Sie in das Textfeld einen oder mehrere Befehle ein und trennen Sie die einzelnen Befehle durch eine neue Zeile.

            Geben Sie beispielsweise die folgenden Befehle ein:

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

      2. Geben Sie im Feld Aufgabenanzahl die Anzahl der Aufgaben für diesen Job ein. Der Wert muss eine ganze Zahl zwischen 1 und dem Limit für Aufgaben pro Aufgabengruppe sein.

        Geben Sie beispielsweise 4 ein.

      3. Geben Sie in das Feld Parallelism die Anzahl der Tasks ein, die gleichzeitig ausgeführt werden sollen. Die Anzahl darf nicht größer als die Gesamtzahl der Aufgaben sein und muss eine ganze Zahl zwischen 1 und dem Limit für parallele Aufgaben pro Job sein.

        Geben Sie beispielsweise 2 ein.

  4. Konfigurieren Sie die Seite Ressourcenspezifikationen:

    1. Klicken Sie im linken Bereich auf Ressourcenspezifikationen. Die Seite Ressourcenspezifikationen wird geöffnet.

    2. Wählen Sie im Abschnitt VM-Bereitstellungsmodell eine der folgenden Optionen für das Bereitstellungsmodell für die VMs dieses Jobs aus:

      • Wenn Ihr Job einem vorzeitigen Beenden standhält und Sie ermäßigte VMs wünschen, wählen Sie Spot aus.

      • Wählen Sie andernfalls Standard aus.

      Wählen Sie beispielsweise Standard aus.

    3. Wählen Sie den Standort für diesen Job aus:

      1. Wählen Sie im Feld Region eine Region aus.

        Wählen Sie beispielsweise us-central1 (Iowa) (Standard) aus.

      2. Führen Sie im Feld Zone einen der folgenden Schritte aus:

        • Wenn Sie die Ausführung dieses Jobs in einer bestimmten Zone einschränken möchten, wählen Sie eine Zone aus.

        • Wählen Sie andernfalls beliebig aus.

        Wählen Sie beispielsweise beliebig (Standardeinstellung) aus.

    4. Wählen Sie eine der folgenden Maschinenfamilien aus:

      • Klicken Sie für gängige Arbeitslasten auf Allgemein.

      • Klicken Sie für leistungsintensive Arbeitslasten auf Computing-optimiert.

      • Klicken Sie für arbeitsspeicherintensive Arbeitslasten auf Arbeitsspeicheroptimiert.

      Klicken Sie beispielsweise auf Allgemein (Standardeinstellung).

    5. Wählen Sie im Feld Reihe eine Maschinenserie für die VMs dieses Jobs aus.

      Wenn Sie für die Maschinenfamilie beispielsweise Allgemein ausgewählt haben, wählen Sie E2 (Standard) aus.

    6. Wählen Sie im Feld Maschinentyp einen Maschinentyp für die VMs dieses Jobs aus.

      Wenn Sie beispielsweise E2 für die Maschinenserie ausgewählt haben, wählen Sie e2-medium (2 vCPUs, 4 GB Arbeitsspeicher) (Standard) aus.

    7. Konfigurieren Sie die für jede Aufgabe erforderliche Menge an VM-Ressourcen:

      1. Geben Sie im Feld Kerne die Anzahl der vCPUs pro Aufgabe ein.

        Geben Sie beispielsweise 1 (Standard) ein.

      2. Geben Sie im Feld Arbeitsspeicher die RAM-Menge in GB pro Task ein.

        Geben Sie beispielsweise 0.5 (Standard) ein.

  5. Optional: Klicken Sie im linken Bereich auf Vorschau, um die Jobkonfiguration zu prüfen.

  6. Klicken Sie auf Erstellen.

Auf der Seite Jobdetails wird der von Ihnen erstellte Job angezeigt.

gcloud

So erstellen Sie einen einfachen Containerjob mit der gcloud CLI:

  1. Erstellen Sie eine JSON-Datei, in der die Konfigurationsdetails des Jobs angegeben sind. Um beispielsweise einen einfachen Containerjob zu erstellen, erstellen Sie eine JSON-Datei mit dem folgenden Inhalt. Weitere Informationen zu allen Feldern, die Sie für einen Job angeben können, finden Sie in der Referenzdokumentation zur REST-Ressource 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
            }
        ]
    }
    

    Ersetzen Sie Folgendes:

    • CONTAINER: der von jeder Aufgabe ausgeführte Container.
    • CORES: Optional. Die Anzahl der Kerne – insbesondere vCPUs, die in der Regel einen halben physischen Kern darstellen –, die jeder Aufgabe in MilliCPU-Einheiten zugewiesen werden soll. Wenn das Feld cpuMilli nicht angegeben ist, wird der Wert auf 2000 (2 vCPUs) festgelegt.
    • MEMORY: Optional. Die Größe des Arbeitsspeichers, der jeder Aufgabe zugewiesen werden soll, in MB. Wenn das Feld memoryMib nicht angegeben ist, wird der Wert auf 2000 (2 GB) festgelegt.
    • MAX_RETRY_COUNT: Optional. Die maximale Anzahl der Wiederholungsversuche für eine Aufgabe. Der Wert muss eine ganze Zahl zwischen 0 und 10 sein. Wenn das Feld maxRetryCount nicht angegeben ist, wird der Wert auf 0 gesetzt. Die Aufgabe wird dann nicht wiederholt.
    • MAX_RUN_DURATION: Optional. Die maximale Zeit, die eine Aufgabe ausgeführt werden darf, bevor sie wiederholt wird oder fehlschlägt, formatiert als Wert in Sekunden, gefolgt von s. Wenn das Feld maxRunDuration nicht angegeben ist, wird der Wert auf 604800s (7 Tage) festgelegt. Dies ist der Höchstwert.
    • TASK_COUNT: Optional. Die Anzahl der Aufgaben für den Job. Der Wert muss eine ganze Zahl zwischen 1 und dem Limit für Aufgaben pro Aufgabengruppe sein. Wenn das Feld taskCount nicht angegeben ist, wird der Wert auf 1 festgelegt.
    • PARALLELISM: Optional. Die Anzahl der Aufgaben, die der Job gleichzeitig ausführt. Die Anzahl darf nicht größer als die Anzahl der Aufgaben sein und muss eine ganze Zahl zwischen 1 und dem Limit für parallele Aufgaben pro Job sein. Wenn das Feld parallelism nicht angegeben ist, wird der Wert auf 1 festgelegt.
  2. Erstellen Sie einen Job mit dem Befehl gcloud batch jobs submit.

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

    Ersetzen Sie Folgendes:

    • JOB_NAME: der Name des Jobs.
    • LOCATION: der Standort des Jobs.
    • JSON_CONFIGURATION_FILE: der Pfad für eine JSON-Datei mit den Konfigurationsdetails des Jobs.

So erstellen Sie beispielsweise einen Job, der Aufgaben mit dem Docker-Container-Image busybox ausführt:

  1. Erstellen Sie im aktuellen Verzeichnis eine JSON-Datei mit dem Namen hello-world-container.json und folgendem Inhalt:

    {
        "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. Führen Sie dazu diesen Befehl aus:

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

API

Verwenden Sie die Methode jobs.create, um einen einfachen Containerjob mit der Batch API zu erstellen. Weitere Informationen zu allen Feldern, die Sie für einen Job angeben können, finden Sie in der Referenzdokumentation zur REST-Ressource 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
        }
    ]
}

Ersetzen Sie Folgendes:

  • PROJECT_ID: die Projekt-ID Ihres Projekts.
  • LOCATION: der Standort des Jobs.
  • JOB_NAME: der Name des Jobs.
  • CONTAINER: der von jeder Aufgabe ausgeführte Container.
  • CORES: Optional. Die Anzahl der Kerne – insbesondere vCPUs, die in der Regel einen halben physischen Kern darstellen –, die jeder Aufgabe in MiliCPU-Einheiten zugewiesen werden soll. Wenn das Feld cpuMilli nicht angegeben ist, wird der Wert auf 2000 (2 vCPUs) festgelegt.
  • MEMORY: Optional. Die Größe des Arbeitsspeichers, der jeder Aufgabe zugewiesen werden soll, in MB. Wenn das Feld memoryMib nicht angegeben ist, wird der Wert auf 2000 (2 GB) festgelegt.
  • MAX_RETRY_COUNT: Optional. Die maximale Anzahl von Wiederholungen für eine Aufgabe. Der Wert muss eine ganze Zahl zwischen 0 und 10 sein. Wenn das Feld maxRetryCount nicht angegeben ist, wird der Wert auf 0 gesetzt. Die Aufgabe wird dann nicht wiederholt.
  • MAX_RUN_DURATION: Optional. Die maximale Zeit, die eine Aufgabe ausgeführt werden darf, bevor sie wiederholt wird oder fehlschlägt, formatiert als Wert in Sekunden, gefolgt von s. Wenn das Feld maxRunDuration nicht angegeben ist, wird der Wert auf 604800s (7 Tage) festgelegt. Dies ist der Höchstwert.
  • TASK_COUNT: Optional. Die Anzahl der Aufgaben für den Job. Diese muss eine ganze Zahl zwischen 1 und dem Limit für Aufgaben pro Aufgabengruppe sein. Wenn das Feld taskCount nicht angegeben ist, wird der Wert auf 1 festgelegt.
  • PARALLELISM: Optional. Die Anzahl der Aufgaben, die der Job gleichzeitig ausführt. Die Anzahl darf nicht größer als die Anzahl der Aufgaben sein und muss eine ganze Zahl zwischen 1 und dem Limit für parallele Aufgaben pro Job sein. Wenn das Feld parallelism nicht angegeben ist, wird der Wert auf 1 festgelegt.

Um beispielsweise einen Job zu erstellen, der Aufgaben mit dem Docker-Container-Image busybox ausführt, verwenden Sie die folgende Anfrage:

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

Dabei ist PROJECT_ID die Projekt-ID Ihres Projekts.

Einfach loslegen (Go)

Go

Weitere Informationen findest du in der Referenzdokumentation zur Batch Go API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Weitere Informationen findest du in der Referenzdokumentation zur Batch Java API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Weitere Informationen findest du in der Referenzdokumentation zur Batch Node.js API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

/**
 * 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

Weitere Informationen findest du in der Referenzdokumentation zur Batch Python API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Weitere Informationen findest du in der Referenzdokumentation zur Batch C++ API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Einfachen Skriptjob erstellen

Sie können einen einfachen Skriptjob mit der Google Cloud Console, der gcloud CLI, Batch API, Go, Java, Node.js, Python oder C++ erstellen.

Console

So erstellen Sie einen einfachen Skriptjob mit der Google Cloud Console:

  1. Rufen Sie in der Google Cloud Console die Seite Jobliste auf.

    Zur Jobliste

  2. Klicken Sie auf Erstellen. Die Seite Batchjob erstellen wird geöffnet. Im linken Bereich ist die Seite Jobdetails ausgewählt.

  3. Konfigurieren Sie die Seite Jobdetails:

    1. Optional: Passen Sie im Feld Jobname den Jobnamen an.

      Geben Sie beispielsweise example-basic-job ein.

    2. Konfigurieren Sie den Bereich Aufgabendetails:

      1. Fügen Sie im Fenster New runnable mindestens ein Script oder einen Container für die Ausführung dieses Jobs hinzu.

        So fügen Sie beispielsweise ein Skript hinzu:

        1. Wählen Sie Skript aus. Ein Textfeld wird angezeigt.

        2. Geben Sie im Textfeld ein Skript ein, das Sie für jede Aufgabe in diesem Job ausführen möchten.

          Geben Sie beispielsweise das folgende Skript ein:

          echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
          
        3. Klicken Sie auf Fertig.

      2. Geben Sie im Feld Aufgabenanzahl die Anzahl der Tasks für diesen Job ein. Der Wert muss eine ganze Zahl zwischen 1 und dem Limit für Aufgaben pro Aufgabengruppe sein.

        Geben Sie beispielsweise 4 ein.

      3. Geben Sie in das Feld Parallelism die Anzahl der Tasks ein, die gleichzeitig ausgeführt werden sollen. Die Anzahl darf nicht größer als die Gesamtzahl der Aufgaben sein und muss eine ganze Zahl zwischen 1 und dem Limit für parallele Aufgaben pro Job sein.

        Geben Sie beispielsweise 2 ein.

  4. Konfigurieren Sie die Seite Ressourcenspezifikationen:

    1. Klicken Sie im linken Bereich auf Ressourcenspezifikationen. Die Seite Ressourcenspezifikationen wird geöffnet.

    2. Wählen Sie im Abschnitt VM-Bereitstellungsmodell eine der folgenden Optionen für das Bereitstellungsmodell für die VMs dieses Jobs aus:

      • Wenn Ihr Job einem vorzeitigen Beenden standhält und Sie ermäßigte VMs wünschen, wählen Sie Spot aus.

      • Wählen Sie andernfalls Standard aus.

      Wählen Sie beispielsweise Standard aus.

    3. Wählen Sie den Standort für diesen Job aus:

      1. Wählen Sie im Feld Region eine Region aus.

        Wählen Sie beispielsweise us-central1 (Iowa) (Standard) aus.

      2. Führen Sie im Feld Zone einen der folgenden Schritte aus:

        • Wenn Sie die Ausführung dieses Jobs in einer bestimmten Zone einschränken möchten, wählen Sie eine Zone aus.

        • Wählen Sie andernfalls beliebig aus.

        Wählen Sie beispielsweise beliebig (Standardeinstellung) aus.

    4. Wählen Sie eine der folgenden Maschinenfamilien aus:

      • Klicken Sie für gängige Arbeitslasten auf Allgemein.

      • Klicken Sie für leistungsintensive Arbeitslasten auf Computing-optimiert.

      • Klicken Sie für arbeitsspeicherintensive Arbeitslasten auf Arbeitsspeicheroptimiert.

      Klicken Sie beispielsweise auf Allgemein (Standardeinstellung).

    5. Wählen Sie im Feld Reihe eine Maschinenserie für die VMs dieses Jobs aus.

      Wenn Sie für die Maschinenfamilie beispielsweise Allgemein ausgewählt haben, wählen Sie E2 (Standard) aus.

    6. Wählen Sie im Feld Maschinentyp einen Maschinentyp für die VMs dieses Jobs aus.

      Wenn Sie beispielsweise E2 für die Maschinenserie ausgewählt haben, wählen Sie e2-medium (2 vCPUs, 4 GB Arbeitsspeicher) (Standard) aus.

    7. Konfigurieren Sie die für jede Aufgabe erforderliche Menge an VM-Ressourcen:

      1. Geben Sie im Feld Kerne die Anzahl der vCPUs pro Aufgabe ein.

        Geben Sie beispielsweise 1 (Standard) ein.

      2. Geben Sie im Feld Arbeitsspeicher die RAM-Menge in GB pro Task ein.

        Geben Sie beispielsweise 0.5 (Standard) ein.

  5. Optional: Klicken Sie im linken Bereich auf Vorschau, um die Jobkonfiguration zu prüfen.

  6. Klicken Sie auf Erstellen.

Auf der Seite Jobdetails wird der von Ihnen erstellte Job angezeigt.

gcloud

So erstellen Sie einen einfachen Skriptjob über die gcloud CLI:

  1. Erstellen Sie eine JSON-Datei, in der die Konfigurationsdetails des Jobs angegeben sind. Um beispielsweise einen einfachen Skriptjob zu erstellen, erstellen Sie eine JSON-Datei mit dem folgenden Inhalt. Weitere Informationen zu allen Feldern, die Sie für einen Job angeben können, finden Sie in der Referenzdokumentation zur REST-Ressource 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
            }
        ]
    }
    

    Ersetzen Sie Folgendes:

    • SCRIPT: das Skript, das von jeder Aufgabe ausgeführt wird.
    • CORES: Optional. Die Anzahl der Kerne – insbesondere vCPUs, die in der Regel einen halben physischen Kern darstellen –, die jeder Aufgabe in MilliCPU-Einheiten zugewiesen werden soll. Wenn das Feld cpuMilli nicht angegeben ist, wird der Wert auf 2000 (2 vCPUs) festgelegt.
    • MEMORY: Optional. Die Größe des Arbeitsspeichers, der jeder Aufgabe zugewiesen werden soll, in MB. Wenn das Feld memoryMib nicht angegeben ist, wird der Wert auf 2000 (2 GB) festgelegt.
    • MAX_RETRY_COUNT: Optional. Die maximale Anzahl der Wiederholungsversuche für eine Aufgabe. Der Wert muss eine ganze Zahl zwischen 0 und 10 sein. Wenn das Feld maxRetryCount nicht angegeben ist, wird der Wert auf 0 gesetzt. Die Aufgabe wird dann nicht wiederholt.
    • MAX_RUN_DURATION: Optional. Die maximale Zeit, die eine Aufgabe ausgeführt werden darf, bevor sie wiederholt wird oder fehlschlägt, formatiert als Wert in Sekunden, gefolgt von s. Wenn das Feld maxRunDuration nicht angegeben ist, wird der Wert auf 604800s (7 Tage) festgelegt. Dies ist der Höchstwert.
    • TASK_COUNT: Optional. Die Anzahl der Aufgaben für den Job. Der Wert muss eine ganze Zahl zwischen 1 und dem Limit für Aufgaben pro Aufgabengruppe sein. Wenn das Feld taskCount nicht angegeben ist, wird der Wert auf 1 festgelegt.
    • PARALLELISM: Optional. Die Anzahl der Aufgaben, die der Job gleichzeitig ausführt. Die Anzahl darf nicht größer als die Anzahl der Aufgaben sein und muss eine ganze Zahl zwischen 1 und dem Limit für parallele Aufgaben pro Job sein. Wenn das Feld parallelism nicht angegeben ist, wird der Wert auf 1 festgelegt.
  2. Erstellen Sie einen Job mit dem Befehl gcloud batch jobs submit.

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

    Ersetzen Sie Folgendes:

    • JOB_NAME: der Name des Jobs.
    • LOCATION: der Standort des Jobs.
    • JSON_CONFIGURATION_FILE: der Pfad für eine JSON-Datei mit den Konfigurationsdetails des Jobs.

So erstellen Sie beispielsweise einen Job, der Aufgaben mit einem Skript ausführt:

  1. Erstellen Sie im aktuellen Verzeichnis eine JSON-Datei mit dem Namen hello-world-script.json und folgendem Inhalt:

    {
        "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. Führen Sie dazu diesen Befehl aus:

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

API

Verwenden Sie die Methode jobs.create, um einen einfachen Skriptjob mit der Batch API zu erstellen. Weitere Informationen zu allen Feldern, die Sie für einen Job angeben können, finden Sie in der Referenzdokumentation zur REST-Ressource 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
        }
    ]
}

Ersetzen Sie Folgendes:

  • PROJECT_ID: die Projekt-ID Ihres Projekts.
  • LOCATION: der Standort des Jobs.
  • JOB_NAME: der Name des Jobs.
  • SCRIPT: das Skript, das von jeder Aufgabe ausgeführt wird.
  • CORES: Optional. Die Anzahl der Kerne – insbesondere vCPUs, die in der Regel einen halben physischen Kern darstellen –, die jeder Aufgabe in MiliCPU-Einheiten zugewiesen werden soll. Wenn das Feld cpuMilli nicht angegeben ist, wird der Wert auf 2000 (2 vCPUs) festgelegt.
  • MEMORY: Optional. Die Größe des Arbeitsspeichers, der jeder Aufgabe zugewiesen werden soll, in MB. Wenn das Feld memoryMib nicht angegeben ist, wird der Wert auf 2000 (2 GB) festgelegt.
  • MAX_RETRY_COUNT: Optional. Die maximale Anzahl von Wiederholungen für eine Aufgabe. Der Wert muss eine ganze Zahl zwischen 0 und 10 sein. Wenn das Feld maxRetryCount nicht angegeben ist, wird der Wert auf 0 gesetzt. Die Aufgabe wird dann nicht wiederholt.
  • MAX_RUN_DURATION: Optional. Die maximale Zeit, die eine Aufgabe ausgeführt werden darf, bevor sie wiederholt wird oder fehlschlägt, formatiert als Wert in Sekunden, gefolgt von s. Wenn das Feld maxRunDuration nicht angegeben ist, wird der Wert auf 604800s (7 Tage) festgelegt. Dies ist der Höchstwert.
  • TASK_COUNT: Optional. Die Anzahl der Aufgaben für den Job. Der Wert muss eine ganze Zahl zwischen 1 und dem Limit für Aufgaben pro Aufgabengruppe sein. Wenn das Feld taskCount nicht angegeben ist, wird der Wert auf 1 festgelegt.
  • PARALLELISM: Optional. Die Anzahl der Aufgaben, die der Job gleichzeitig ausführt. Die Anzahl darf nicht größer als die Anzahl der Aufgaben sein und muss eine ganze Zahl zwischen 1 und dem Limit für parallele Aufgaben pro Job sein. Wenn das Feld parallelism nicht angegeben ist, wird der Wert auf 1 festgelegt.

Verwenden Sie beispielsweise die folgende Anfrage, um einen Job zu erstellen, bei dem Aufgaben mit einem Skript ausgeführt werden:

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

Dabei ist PROJECT_ID die Projekt-ID Ihres Projekts.

Einfach loslegen (Go)

Go

Weitere Informationen findest du in der Referenzdokumentation zur Batch Go API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Weitere Informationen findest du in der Referenzdokumentation zur Batch Java API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Weitere Informationen findest du in der Referenzdokumentation zur Batch Node.js API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

/**
 * 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

Weitere Informationen findest du in der Referenzdokumentation zur Batch Python API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Weitere Informationen findest du in der Referenzdokumentation zur Batch C++ API.

Richten Sie Standardanmeldedaten für Anwendungen ein, um sich bei Batch zu authentifizieren. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.

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

Umgebungsvariablen verwenden

Verwenden Sie Umgebungsvariablen, wenn Sie ein Container-Image oder Skript schreiben, das ein Job ausführen soll. Sie können alle Umgebungsvariablen verwenden, die für alle Batchjobs vordefiniert sind, sowie alle benutzerdefinierten Umgebungsvariablen, die Sie beim Erstellen des Jobs definieren.

Vordefinierte Umgebungsvariablen verwenden

Standardmäßig können die Runnables in Ihrem Job die folgenden vordefinierten Umgebungsvariablen verwenden:

  • BATCH_TASK_COUNT: die Anzahl der Aufgaben in einer Aufgabengruppe.
  • BATCH_TASK_INDEX: die Indexnummer einer Aufgabe in einer Aufgabengruppe. Die Indexnummerierung beginnt bei 0.
  • BATCH_HOSTS_FILE: Optional. Der Pfad zur Datei, die alle ausgeführten VM-Instanzen in einer Aufgabengruppe auflistet. Wenn Sie diese Umgebungsvariable verwenden möchten, ist das Feld requireHostsFile erforderlich und muss auf „true“ gesetzt werden.

Ein Beispiel für die Verwendung vordefinierter Umgebungsvariablen finden Sie in den vorherigen Beispielen für Runnables unter Grundlegenden Job erstellen in diesem Dokument.

Benutzerdefinierte Umgebungsvariablen definieren und verwenden

Optional können Sie eine oder mehrere benutzerdefinierte Umgebungsvariablen in einem Job definieren.

Sie definieren jede Variable in einer bestimmten Umgebung basierend auf dem gewünschten Datenbereich:

In der ausgewählten Umgebung definieren Sie den Namen und die Werte jeder Variablen mithilfe eines der folgenden Unterfelder für die Umgebung:

Sie können mit der gcloud CLI oder Batch API benutzerdefinierte Umgebungsvariablen für Ihren Job definieren und verwenden. In den folgenden Beispielen wird erläutert, wie Sie zwei Jobs erstellen, die Standardvariablen definieren und verwenden. Der erste Beispieljob hat eine Variable für ein bestimmtes ausführbares Objekt. Der zweite Beispieljob hat eine Arrayvariable, die für jede Aufgabe einen anderen Wert hat.

gcloud

Wenn Sie einen Job definieren möchten, der eine Umgebungsvariable an ein ausführbares Objekt übergibt, das von jeder Aufgabe ausgeführt wird, lesen Sie das Beispiel zum Definieren und Verwenden einer Umgebungsvariable für ein Runnable. Wenn Sie einen Job definieren möchten, der eine Liste von Umgebungsvariablen basierend auf dem Aufgabenindex an verschiedene Aufgaben übergibt, lesen Sie das Beispiel unter Umgebungsvariablen für jede Aufgabe definieren und verwenden.

Umgebungsvariable für ein Runnable definieren und verwenden

Verwenden Sie den Befehl gcloud batch jobs submit und geben Sie die Umgebungsvariablen in der Konfigurationsdatei des Jobs an, um einen Job zu erstellen, der Umgebungsvariablen über die gcloud CLI an ein ausführbares Objekt übergibt.

Um beispielsweise einen Skriptjob zu erstellen, der eine Umgebungsvariable definiert und an die Skripts von drei Aufgaben übergibt, stellen Sie die folgende Anfrage:

  1. Erstellen Sie im aktuellen Verzeichnis eine JSON-Datei mit dem Namen hello-world-environment-variables.json und folgendem Inhalt:

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

    Ersetzen Sie Folgendes:

    • VARIABLE_NAME: der Name der Umgebungsvariablen, die an jede Aufgabe übergeben wird. Konventionsgemäß werden Namen von Umgebungsvariablen großgeschrieben.
    • VARIABLE_VALUE: Optional. Der Wert der Umgebungsvariablen, die an jede Aufgabe übergeben wird.
  2. Führen Sie dazu diesen Befehl aus:

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

Für jede Aufgabe eine Umgebungsvariable definieren und verwenden

Verwenden Sie den Befehl gcloud batch jobs submit und geben Sie in der Konfigurationsdatei des Jobs das Arrayfeld taskEnvironments an, um über die gcloud CLI einen Job zu erstellen, der Umgebungsvariablen an eine Aufgabe übergibt, die auf dem Aufgabenindex basiert.

So erstellen Sie beispielsweise einen Job, der ein Array von drei Umgebungsvariablen mit übereinstimmenden Namen und unterschiedlichen Werten enthält und die Umgebungsvariablen an die Skripts der Aufgaben übergibt, deren Indexe den Indexen der Umgebungsvariablen im Array entsprechen:

  1. Erstellen Sie im aktuellen Verzeichnis eine JSON-Datei mit dem Namen hello-world-task-environment-variables.json und folgendem Inhalt:

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

    Ersetzen Sie Folgendes:

    • TASK_VARIABLE_NAME: der Name der Aufgabenumgebungsvariablen, die an die Aufgaben mit übereinstimmenden Indexen übergeben werden Konventionsgemäß werden Namen von Umgebungsvariablen großgeschrieben.
    • TASK_VARIABLE_VALUE_0: der Wert der Umgebungsvariablen, die an die erste Aufgabe übergeben wird und für die BATCH_TASK_INDEX gleich 0 ist.
    • TASK_VARIABLE_VALUE_1: der Wert der Umgebungsvariablen, die an die zweite Aufgabe übergeben wird und für die BATCH_TASK_INDEX gleich 1 ist.
    • TASK_VARIABLE_VALUE_2: der Wert der Umgebungsvariablen, die an die dritte Aufgabe übergeben wird und für die BATCH_TASK_INDEX gleich 2 ist.
  2. Führen Sie dazu diesen Befehl aus:

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

API

Wenn Sie einen Job definieren möchten, der eine Umgebungsvariable an ein ausführbares Objekt übergibt, das von jeder Aufgabe ausgeführt wird, lesen Sie das Beispiel zum Definieren und Verwenden einer Umgebungsvariable für ein Runnable. Wenn Sie einen Job definieren möchten, der eine Liste von Umgebungsvariablen basierend auf dem Aufgabenindex an verschiedene Aufgaben übergibt, lesen Sie das Beispiel unter Umgebungsvariablen für jede Aufgabe definieren und verwenden.

Umgebungsvariable für ein Runnable definieren und verwenden

Verwenden Sie den Befehl gcloud batch jobs submit und geben Sie die Umgebungsvariablen im Feld environment an, um einen Job zu erstellen, der Umgebungsvariablen mit der Batch API an ein ausführbares Objekt übergibt.

Um beispielsweise einen Job zu erstellen, der eine Umgebungsvariable enthält und an die Skripts von drei Aufgaben übergibt, stellen Sie die folgende Anfrage:

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

Ersetzen Sie Folgendes:

  • PROJECT_ID: die Projekt-ID Ihres Projekts.
  • VARIABLE_NAME: der Name der Umgebungsvariablen, die an jede Aufgabe übergeben wird Konventionsgemäß werden Namen von Umgebungsvariablen großgeschrieben.
  • VARIABLE_VALUE: der Wert der Umgebungsvariablen, die an jede Aufgabe übergeben wird.

Für jede Aufgabe eine Umgebungsvariable definieren und verwenden

Wenn Sie einen Job erstellen möchten, der Umgebungsvariablen mit der Batch API basierend auf dem Aufgabenindex an eine Aufgabe übergibt, verwenden Sie die Methode jobs.create und geben die Umgebungsvariablen im Arrayfeld taskEnvironments an.

Wenn Sie beispielsweise einen Job erstellen möchten, der ein Array von drei Umgebungsvariablen mit übereinstimmenden Namen und unterschiedlichen Werten enthält und die Umgebungsvariablen anhand ihrer Indexe an die Skripts von drei Aufgaben übergibt, senden Sie die folgende Anfrage:

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

Ersetzen Sie Folgendes:

  • PROJECT_ID: die Projekt-ID Ihres Projekts.
  • TASK_VARIABLE_NAME: der Name der Umgebungsvariablen, die mit übereinstimmenden Indexen an die Aufgaben übergeben werden Konventionsgemäß werden Namen von Umgebungsvariablen großgeschrieben.
  • TASK_VARIABLE_VALUE_0: der Wert der Umgebungsvariablen, die an die erste Aufgabe übergeben wird und für die BATCH_TASK_INDEX gleich 0 ist.
  • TASK_VARIABLE_VALUE_1: der Wert der Umgebungsvariablen, die an die zweite Aufgabe übergeben wird und für die BATCH_TASK_INDEX gleich 1 ist.
  • TASK_VARIABLE_VALUE_2: der Wert der Umgebungsvariablen, die an die dritte Aufgabe übergeben wird und für die BATCH_TASK_INDEX gleich 2 ist.

Nächste Schritte