Ce document explique les principes de base de la création de tâches par lot : comment créer et exécuter une tâche basée sur un script ou une image de conteneur, et comment utiliser des variables prédéfinies et personnalisées. Pour en savoir plus sur la création et l'exécution de tâches, 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 auparavant, 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 à la création d'une tâche, demandez à votre administrateur de vous attribuer les rôles IAM suivants:
-
Éditeur de jobs 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.
-
Éditeur de jobs par lot (
-
Chaque fois que vous créez un job, assurez-vous qu'il dispose d'une configuration réseau valide.
- Si vous n'avez pas d'exigences 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. Apprenez à configurer la mise en réseau d'une tâche avant de créer une tâche de base, afin de pouvoir modifier les exemples ci-dessous pour répondre à vos exigences de mise en réseau.
-
Chaque fois que vous créez une tâche, assurez-vous qu'elle dispose d'un environnement de système d'exploitation de VM valide.
- Si vous n'avez pas d'exigences particulières concernant l'image d'OS de 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 de l'environnement d'OS de la VM ou découvrez comment personnaliser cet environnement afin de pouvoir modifier les exemples ci-dessous en fonction de vos besoins.
Créer un job 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 de la ressource REST projects.locations.jobs
.
Pour résumer, une tâche est constituée d'un tableau d'une ou de plusieurs tâches qui exécutent toutes un ou plusieurs exécutables, qui sont les scripts et/ou les 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.
- Sinon, si vous ne savez pas si vous souhaitez utiliser des images de conteneurs ou si vous ne connaissez pas les conteneurs, il est recommandé de créer une tâche de script.
L'exemple de tâche pour les deux types de tâches contient un groupe de tâches comportant un tableau de quatre tâches. Chaque tâche imprime un message et son index sur la sortie standard et dans 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 un job de conteneur de base
Vous pouvez sélectionner ou créer une image de conteneur pour fournir le code et les dépendances que votre tâche doit 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 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:
Dans la console Google Cloud, accédez à la page Liste des tâches.
Cliquez sur
Créer. La page Créer un job par lot s'ouvre. Dans le volet de gauche, la page Job details (Informations sur la tâche) est sélectionnée.Configurez la page Détails de la tâche:
(Facultatif) Dans le champ Job name (Nom du job), personnalisez le nom du job.
Par exemple, saisissez
example-basic-job
.Configurez la section Détails de la tâche:
Dans la fenêtre New runnable (Nouvel exécutable), ajoutez au moins un script ou un conteneur que cette tâche doit exécuter.
Par exemple, pour ajouter un conteneur, procédez comme suit:
Sélectionnez URL de l'image du conteneur (par défaut).
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
Facultatif: Pour ignorer 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
Facultatif: Pour ignorer la commande
CMD
de l'image de conteneur, procédez comme suit:Cochez la case Remplacer la commande CMD de l'image du conteneur. Une zone de texte s'affiche.
Dans la zone de texte, saisissez une ou plusieurs commandes en les séparant par un saut de 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.
Cliquez sur OK.
Dans le champ Nombre de tâches, saisissez le nombre de tâches associées à cette tâche. Cette valeur doit être un nombre entier compris entre
1
et la limite de tâches par groupe de tâches.Par exemple, saisissez
4
.Dans le champ Parallélisme, saisissez le nombre de tâches à exécuter simultanément. Ce nombre ne peut pas être supérieur au nombre total de tâches. Il doit s'agir d'un nombre entier compris entre
1
et la limite de tâches parallèles par tâche.Par exemple, saisissez
2
.
Configurez la page Spécifications des ressources:
Dans le volet de gauche, cliquez sur Spécifications de ressources. La page Spécifications des ressources s'ouvre.
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 à tarif réduit, sélectionnez Spot.
Sinon, sélectionnez Standard.
Par exemple, sélectionnez Standard (par défaut).
Sélectionnez le lieu de cette mission:
Dans le champ Région, sélectionnez une région.
Par exemple, sélectionnez
us-central1 (Iowa)
(par défaut).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 n'importe quelle option.
Par exemple, sélectionnez toutes (par défaut).
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 (option par défaut).
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).
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 comme série de machines, sélectionnez e2-medium (2 vCPU, 4 Go de mémoire) (par défaut).
Configurez la quantité de ressources de VM requises pour chaque tâche:
Dans le champ Cœurs, saisissez le nombre de vCPUs par tâche.
Par exemple, saisissez
1
(valeur par défaut).Dans le champ Mémoire, saisissez la quantité de RAM (en Go) par tâche.
Par exemple, saisissez
0.5
(valeur par défaut).
Facultatif: Pour vérifier la configuration de la tâche, cliquez sur Aperçu dans le volet de gauche.
Cliquez sur Créer.
La page Informations sur la tâche affiche la tâche que vous avez créée.
gcloud
Pour créer une tâche de conteneur de base à l'aide de la gcloud CLI, procédez comme suit:
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 de vCPUs, qui représentent généralement un demi-cœur physique) à allouer à chaque tâche, en milliprocesseurs d'unités de processeur. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(2 processeurs virtuels).MEMORY
: facultatif. Quantité de mémoire à allouer à chaque tâche, en Mo. Si le champmemoryMib
n'est pas spécifié, la valeur est définie sur2000
(2 Go).MAX_RETRY_COUNT
: facultatif. Nombre maximal de tentatives pour une tâche. La valeur doit être un nombre entier compris entre0
et10
. Si le champmaxRetryCount
n'est pas spécifié, la valeur est définie sur0
, ce qui signifie que vous ne devez pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez la section Automatiser les nouvelles tentatives d'exécution des tâches.MAX_RUN_DURATION
: facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, sous la forme d'une valeur en secondes suivie des
(par exemple,3600s
pendant une heure). Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée maximale d'exécution d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez la section Limiter les durées d'exécution des tâches et des exécutables à l'aide de délais avant expiration.TASK_COUNT
: facultatif. Le nombre de tâches pour la tâche. Cette valeur doit être un nombre entier compris entre1
et la limite de tâches par groupe de tâches. Si le champtaskCount
n'est pas spécifié, la valeur est définie sur1
.PARALLELISM
: facultatif. Nombre de tâches que le job exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches et doit être un nombre entier compris entre1
et la limite de tâches parallèles par tâche. Si le champparallelism
n'est pas spécifié, la valeur est définie sur1
.
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
: emplacement 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
:
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" } }
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
: emplacement 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 de vCPUs, qui représentent généralement un demi-cœur physique) à allouer à chaque tâche, en milliprocesseurs d'unités de processeur. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(2 processeurs virtuels).MEMORY
: facultatif. Quantité de mémoire à allouer à chaque tâche, en Mo. Si le champmemoryMib
n'est pas spécifié, la valeur est définie sur2000
(2 Go).MAX_RETRY_COUNT
: facultatif. Nombre maximal de tentatives pour une tâche. La valeur doit être un nombre entier compris entre0
et10
. Si le champmaxRetryCount
n'est pas spécifié, la valeur est définie sur0
, ce qui signifie que vous ne devez pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez la section Automatiser les nouvelles tentatives d'exécution des tâches.MAX_RUN_DURATION
: facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, sous la forme d'une valeur en secondes suivie des
(par exemple,3600s
pendant une heure). Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée maximale d'exécution d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez la section Limiter les durées d'exécution des tâches et des exécutables à l'aide de délais avant expiration.TASK_COUNT
: facultatif. Nombre de tâches pour la tâche, qui doit être un nombre entier compris entre1
et la limite de tâches par groupe de tâches. Si le champtaskCount
n'est pas spécifié, la valeur est définie sur1
.PARALLELISM
: facultatif. Nombre de tâches que le job exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches et doit être un nombre entier compris entre1
et la limite de tâches parallèles par tâche. Si le champparallelism
n'est pas spécifié, la valeur est définie sur1
.
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.
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.
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.
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.
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.
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 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:
Dans la console Google Cloud, accédez à la page Liste des tâches.
Cliquez sur
Créer. La page Créer un job par lot s'ouvre. Dans le volet de gauche, la page Job details (Informations sur la tâche) est sélectionnée.Configurez la page Détails de la tâche:
(Facultatif) Dans le champ Job name (Nom du job), personnalisez le nom du job.
Par exemple, saisissez
example-basic-job
.Configurez la section Détails de la tâche:
Dans la fenêtre New runnable (Nouvel exécutable), ajoutez au moins un script ou un conteneur que cette tâche doit exécuter.
Par exemple, pour ajouter un script, procédez comme suit:
Sélectionnez Script. Une zone de texte s'affiche.
Dans la zone de texte, saisissez le script que vous souhaitez exécuter pour chaque tâche de cette tâche.
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.
Cliquez sur OK.
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
.Dans le champ Parallélisme, saisissez le nombre de tâches à exécuter simultanément. Ce nombre ne peut pas être supérieur au nombre total de tâches. Il doit s'agir d'un nombre entier compris entre
1
et la limite de tâches parallèles par tâche.Par exemple, saisissez
2
.
Configurez la page Spécifications des ressources:
Dans le volet de gauche, cliquez sur Spécifications de ressources. La page Spécifications des ressources s'ouvre.
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 à tarif réduit, sélectionnez Spot.
Sinon, sélectionnez Standard.
Par exemple, sélectionnez Standard (par défaut).
Sélectionnez le lieu de cette mission:
Dans le champ Région, sélectionnez une région.
Par exemple, sélectionnez
us-central1 (Iowa)
(par défaut).Dans le champ Zone, effectuez l'une des opérations suivantes:
Si vous souhaitez limiter l'exécution de cette tâche à une zone spécifique, sélectionnez une zone.
Sinon, sélectionnez n'importe quelle option.
Par exemple, sélectionnez toutes (par défaut).
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 (option par défaut).
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).
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 comme série de machines, sélectionnez e2-medium (2 vCPU, 4 Go de mémoire) (par défaut).
Configurez la quantité de ressources de VM requises pour chaque tâche:
Dans le champ Cœurs, saisissez le nombre de vCPUs par tâche.
Par exemple, saisissez
1
(valeur par défaut).Dans le champ Mémoire, saisissez la quantité de RAM (en Go) par tâche.
Par exemple, saisissez
0.5
(valeur par défaut).
Facultatif: Pour vérifier la configuration de la tâche, cliquez sur Aperçu dans le volet de gauche.
Cliquez sur Créer.
La page Informations sur la tâche affiche la tâche que vous avez créée.
gcloud
Pour créer une tâche de script de base à l'aide de gcloud CLI, procédez comme suit:
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 de vCPUs, qui représentent généralement un demi-cœur physique) à allouer à chaque tâche, en milliprocesseurs d'unités de processeur. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(2 processeurs virtuels).MEMORY
: facultatif. Quantité de mémoire à allouer à chaque tâche, en Mo. Si le champmemoryMib
n'est pas spécifié, la valeur est définie sur2000
(2 Go).MAX_RETRY_COUNT
: facultatif. Nombre maximal de tentatives pour une tâche. La valeur doit être un nombre entier compris entre0
et10
. Si le champmaxRetryCount
n'est pas spécifié, la valeur est définie sur0
, ce qui signifie que vous ne devez pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez la section Automatiser les nouvelles tentatives d'exécution des tâches.MAX_RUN_DURATION
: facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, sous la forme d'une valeur en secondes suivie des
(par exemple,3600s
pendant une heure). Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée maximale d'exécution d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez la section Limiter les durées d'exécution des tâches et des exécutables à l'aide de délais avant expiration.TASK_COUNT
: facultatif. Le nombre de tâches pour la tâche. Cette valeur doit être un nombre entier compris entre1
et la limite de tâches par groupe de tâches. Si le champtaskCount
n'est pas spécifié, la valeur est définie sur1
.PARALLELISM
: facultatif. Nombre de tâches que le job exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches et doit être un nombre entier compris entre1
et la limite de tâches parallèles par tâche. Si le champparallelism
n'est pas spécifié, la valeur est définie sur1
.
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
: emplacement 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:
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" } }
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
: emplacement 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 de vCPUs, qui représentent généralement un demi-cœur physique) à allouer à chaque tâche, en milliprocesseurs d'unités de processeur. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(2 processeurs virtuels).MEMORY
: facultatif. Quantité de mémoire à allouer à chaque tâche, en Mo. Si le champmemoryMib
n'est pas spécifié, la valeur est définie sur2000
(2 Go).MAX_RETRY_COUNT
: facultatif. Nombre maximal de tentatives pour une tâche. La valeur doit être un nombre entier compris entre0
et10
. Si le champmaxRetryCount
n'est pas spécifié, la valeur est définie sur0
, ce qui signifie que vous ne devez pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez la section Automatiser les nouvelles tentatives d'exécution des tâches.MAX_RUN_DURATION
: facultatif. Durée maximale d'exécution d'une tâche avant une nouvelle tentative ou un échec, sous la forme d'une valeur en secondes suivie des
(par exemple,3600s
pendant une heure). Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée maximale d'exécution d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez la section Limiter les durées d'exécution des tâches et des exécutables à l'aide de délais avant expiration.TASK_COUNT
: facultatif. Nombre de tâches associées à la tâche. Cette valeur doit être un nombre entier compris entre1
et la limite de tâches par groupe de tâches. Si le champtaskCount
n'est pas spécifié, la valeur est définie sur1
.PARALLELISM
: facultatif. Nombre de tâches que le job exécute simultanément. Ce nombre ne peut pas être supérieur au nombre de tâches et doit être un nombre entier compris entre1
et la limite de tâches parallèles par tâche. Si le champparallelism
n'est pas spécifié, la valeur est définie sur1
.
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.
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.
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.
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.
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.
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 toutes les tâches par lot, ainsi que 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 est0
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 champrequireHostsFile
doit être défini surtrue
.BATCH_TASK_RETRY_ATTEMPT
: nombre de tentatives déjà effectuées pour cette tâche. La valeur est0
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 champmaxRetryCount
, qui est0
s'il n'est pas défini. Pour en savoir plus sur les nouvelles tentatives, consultez la page Automatiser les 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 un job.
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
detaskSpec
).Sinon, si la variable a une valeur distincte pour tous les exécutables, utilisez un ou plusieurs environnements d'exécutables spécifiques (sous-champ
environment
derunnables[]
).
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 de 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 Variables de secret (
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 de 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 tâche 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 d'environnement à un exécutable que chaque tâche exécute, consultez l'exemple expliquant comment définir et utiliser une variable d'environnement 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 suivant : 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 la 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:
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 sont en majuscules.VARIABLE_VALUE
: facultatif. Valeur de la variable d'environnement transmise à chaque tâche.
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 son index à l'aide de la gcloud CLI, exécutez 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 qui transmet les variables d'environnement aux scripts des tâches dont les index correspondent aux index des variables d'environnement dans le tableau:
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 avec des index correspondants. Par convention, les noms des variable d'environnement sont en majuscules.TASK_VARIABLE_VALUE_0
: valeur de la variable d'environnement transmise à la première tâche, pour laquelleBATCH_TASK_INDEX
est égal à0
.TASK_VARIABLE_VALUE_1
: valeur de la variable d'environnement transmise à la deuxième tâche, pour laquelleBATCH_TASK_INDEX
est égal à1
.TASK_VARIABLE_VALUE_2
: valeur de la variable d'environnement transmise à la troisième tâche, pour laquelleBATCH_TASK_INDEX
est égal à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 d'environnement à un exécutable que chaque tâche exécute, consultez l'exemple expliquant comment définir et utiliser une variable d'environnement 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 suivant : 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 son index à 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 comprend un tableau de trois variables d'environnement avec des noms correspondants et des valeurs différentes, et qui transmet 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 avec des index correspondants. Par convention, les noms des variable d'environnement sont en majuscules.TASK_VARIABLE_VALUE_0
: valeur de la variable d'environnement transmise à la première tâche, pour laquelleBATCH_TASK_INDEX
est égal à0
.TASK_VARIABLE_VALUE_1
: valeur de la variable d'environnement transmise à la deuxième tâche, pour laquelleBATCH_TASK_INDEX
est égal à1
.TASK_VARIABLE_VALUE_2
: valeur de la variable d'environnement transmise à la troisième tâche, pour laquelleBATCH_TASK_INDEX
est égal à2
.
Étapes suivantes
- Si vous rencontrez des problèmes lors de la création ou de l'exécution d'un job, consultez la section Dépannage.
- Afficher les missions et les tâches
- En savoir plus sur les options de création de tâches