Ce document explique les principes de base de la création de tâches Batch : comment créer et exécuter une tâche basée sur un script ou une image de conteneur, et utiliser des variables prédéfinies et personnalisées. Pour en savoir plus sur la création et l'exécution de tâches, consultez la section Présentation de la création et de l'exécution de tâches.
Avant de commencer
- Si vous n'avez jamais utilisé Batch, consultez Premiers pas avec Batch et activez Batch en remplissant les conditions préalables pour les projets et les utilisateurs.
-
Pour obtenir les autorisations nécessaires pour créer un job, demandez à votre administrateur de vous accorder 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 page Gérer l'accès aux projets, aux dossiers et aux organisations.
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 une tâche, assurez-vous qu'elle dispose d'une configuration réseau valide.
- Si vous n'avez pas d'exigences réseau spécifiques pour votre charge de travail ou et que vous n'avez pas modifié le réseau par défaut de votre projet, aucune action n'est requise.
- Sinon, vous devez configurer la mise en réseau lorsque vous créez un job. Découvrez comment configurer la mise en réseau pour un job avant de créer un job de base, afin que vous puissiez modifiez les exemples ci-dessous pour répondre à vos exigences de mise en réseau.
-
Assurez-vous que chaque job dispose d'une VM valide
de votre système d'exploitation.
- 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 projet, aucune action n'est requise.
- Sinon, vous devez préparer une option d'environnement d'OS de VM valide. Avant de créer un job de base, autorisez la configuration par défaut pour l'environnement d'OS de VM ou apprenez à le personnaliser afin que vous puissiez modifier les exemples ci-dessous en fonction de vos besoins.
Créer un job de base
Pour plus d'informations sur tous les champs que vous pouvez spécifier pour une tâche, consultez les
documentation de référence
Ressource REST projects.locations.jobs
.
Pour résumer, un job consiste en un tableau d'une ou de plusieurs tâches qui exécutent toutes un ou plusieurs exécutables, qui sont les scripts exécutables et/ou les conteneurs de votre job.
Pour vous familiariser avec les bases, 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 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 : créer une tâche de script ; est recommandé.
L'exemple de job pour les deux types de jobs contient un groupe de tâches avec un tableau de quatre tâches. Chaque tâche imprime un message et son index à la requête de sortie et Cloud Logging. La définition de cette tâche spécifie parallélisme de 2, ce qui indique que le job doit s'exécuter sur 2 VM pour permettre 2 tâches à exécuter à 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 pour que votre job s'exécute depuis n'importe quel environnement de calcul. Pour en savoir plus, consultez Utiliser des images de conteneurs Exécuter des conteneurs sur des instances de VM
Vous pouvez créer un job de conteneur de base à l'aide de la console Google Cloud, gcloud CLI, API Batch, Go, Java, Node.js, Python ou C++.
Console
Pour créer un job de conteneur de base à l'aide de la console Google Cloud, procédez comme suit : suivantes:
Dans la console Google Cloud, accédez à la page Liste des tâches.
Cliquez sur
Créer. La La page Créer un job par lot s'ouvre. Dans le volet de gauche, La page Job details (Informations sur le job) 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 pour l'exécution de ce job.
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 de conteneur à exécuter pour chaque tâche tâche.
Par exemple, pour utiliser l'image de conteneur Docker
busybox
, saisissez l'URL suivante :gcr.io/google-containers/busybox
Facultatif: Pour remplacer l'ID de l'image de conteneur,
ENTRYPOINT
, saisissez une commande dans 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 : effectuer les opérations suivantes:Sélectionnez Remplacer la commande CMD de l'image de conteneur. . Une zone de texte s'affiche.
Dans la zone de texte, saisissez une ou plusieurs commandes, en les séparant chaque commande par une nouvelle 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 correspondant à 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. Le 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 job.Par exemple, saisissez
2
.
Configurez la page Spécifications de la ressource :
Dans le volet de gauche, cliquez sur Spécifications des ressources. La page Spécifications des ressources s'ouvre.
Dans la section Modèle de provisionnement de VM, sélectionnez l'une des les options suivantes modèle de provisionnement VM de ce job:
Si votre tâche peut résister à la préemption et que vous souhaitez obtenir des VM à prix 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-la.
Sinon, sélectionnez n'importe quel.
Par exemple, sélectionnez toutes (par défaut).
Sélectionnez l'une des options suivantes : familles de machines:
Pour les charges de travail courantes, cliquez sur Usage général.
Pour les charges de travail exigeantes en performances, cliquez sur Optimisé pour le calcul.
Pour les charges de travail exigeantes en mémoire, cliquez sur À mémoire optimisée.
Par exemple, cliquez sur Usage général (par défaut).
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 VM d'un job.
Par exemple, si vous avez sélectionné E2 pour la série de machines, sélectionnez e2-medium (2 vCPU, 4 Go de mémoire) (par défaut).
Configurez la quantité de ressources de VM requise pour chaque tâche :
Dans le champ Cœurs, saisissez la quantité 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 examiner la configuration de la tâche, dans le volet de gauche, cliquez sur Aperçu.
Cliquez sur Créer.
La page Informations sur la tâche affiche la tâche que vous avez créée.
gcloud
Pour créer un job de conteneur de base à l'aide de la gcloud CLI, procédez comme suit : suivantes:
Créez un fichier JSON qui spécifie les détails de configuration de votre tâche. 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 pour une tâche, consultez la documentation de référence 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 Au minimum, un conteneur doit spécifier une image dansimageUri
mais des sous-champs supplémentaires peuvent aussi être requis. Pour en savoir plus, consultez les sous-champscontainer
et l'exemple de tâche de conteneur dans cette section.CORES
: facultatif. Nombre de cœurs (en particulier de CPU virtuels, qui représentent généralement la moitié d'un cœur physique) à allouer pour chaque tâche en unités milliCPU. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(deux processeurs virtuels).MEMORY
: facultatif. Quantité de mémoire à allouer pour chaque tâche, en Mo. Si le champmemoryMib
n'est pas définie, la valeur est définie sur2000
(2 Go).MAX_RETRY_COUNT
: facultatif. Le nombre maximal de nouvelles 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 qu'il ne faut pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez Automatisez les nouvelles tentatives d'exécution de tâches.MAX_RUN_DURATION
: facultatif. Durée maximale pendant laquelle une tâche est autorisée à s'exécuter avant d'être réessayée ou d'échouer, au format valeur en secondes suivie des
(par exemple,3600s
pour une heure). Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez Limitez la durée 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. La 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 exécutées simultanément par le job. Ce nombre ne doit pas être supérieur au nombre de tâches et doit être un entier compris entre1
et la limite de tâches parallèles par tâche. Si le 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 du travail.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
:
Créez un fichier JSON dans le répertoire actuel 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 suivante :
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 de 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 projet de votre projet.LOCATION
: emplacement du travail.JOB_NAME
: nom de la tâche.CONTAINER
: conteneur exécuté par chaque tâche Un conteneur doit au minimum spécifier une image dans le sous-champimageUri
, mais d'autres sous-champs peuvent également être requis. Pour en savoir plus, consultez les sous-champscontainer
et l'exemple de tâche de conteneur dans cette section.CORES
: facultatif. Nombre de cœurs (en particulier de CPU virtuels, qui représentent généralement la moitié d'un cœur physique) à allouer pour chaque tâche en unités de milliCPU. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(deux processeurs virtuels).MEMORY
: facultatif. Quantité de mémoire à allouer pour 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. Le nombre maximal de nouvelles 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éfini sur0
, ce qui signifie qu'il faut ne pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez Automatisez les nouvelles tentatives d'exécution de tâches.MAX_RUN_DURATION
: facultatif. Durée maximale pendant laquelle une tâche est autorisée à s'exécuter avant d'être réessayée ou d'échouer, au format valeur en secondes suivie des
(par exemple,3600s
pour une heure). Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez Limitez la durée 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 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 exécutées simultanément par le job. Ce nombre ne doit pas être supérieur au nombre de tâches et doit être un entier compris entre1
et la limite de tâches parallèles par tâche. Si le Le champparallelism
n'est pas spécifié, la valeur est définie sur1
.
Par exemple, pour créer un job qui exécute des tâches à l'aide du
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
correspond à l'ID de projet de votre projet.
Go
Go
Pour en savoir plus, consultez les API Go par lot documentation de référence.
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 Java par lot.
Pour vous authentifier auprès de Batch, configurez le service 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 Node.js par lot.
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 Python par lot.
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 les API C++ par lot documentation de référence.
Pour vous authentifier auprès de Batch, configurez le service 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 un job de script de base à l'aide de la console Google Cloud, gcloud CLI, API Batch, Go, Java, Node.js, Python ou 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 La page Créer un job par lot s'ouvre. Dans le volet de gauche, La page Job details (Informations sur le job) 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 Nouveau script exécutable, ajoutez au moins un script ou un conteneur pour que cette tâche s'exécute.
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 ce job.
Par exemple, saisissez le script suivant:
echo Hello world! This is task ${BATCH_TASK_INDEX}. This job has a total of ${BATCH_TASK_COUNT} tasks.
Cliquez sur OK.
Dans le champ Nombre de tâches, saisissez le nombre de tâches pour 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 doit pas dépasser le nombre total de tâches et doit être un entier compris entre
1
et la limite de tâches parallèles par tâche.Par exemple, saisissez
2
.
Configurez la page Spécifications de la ressource :
Dans le volet de gauche, cliquez sur Spécifications des ressources. La page Spécifications des ressources s'ouvre.
Dans la section Modèle de provisionnement de VM, sélectionnez l'une des les options suivantes modèle de provisionnement VM de ce job:
Si votre tâche peut résister à la préemption et que vous souhaitez des VM à prix réduit, sélectionnez Spot.
Sinon, sélectionnez Standard.
Par exemple, sélectionnez Standard (par défaut).
Sélectionnez l'emplacement de cet emploi :
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 ce job ne s'exécute pas dans un une zone spécifique uniquement, sélectionnez une zone.
Sinon, sélectionnez n'importe quel.
Par exemple, sélectionnez any (n'importe quel) (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 VM d'un job.
Par exemple, si vous avez sélectionné E2 pour la série de machines, sélectionnez e2-medium (2 vCPU, 4 Go de mémoire) (par défaut).
Configurez la quantité de ressources de VM requise pour chaque tâche :
Dans le champ Cœurs, saisissez la quantité 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 examiner la configuration de la tâche, dans le volet de gauche, cliquez sur Aperçu.
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 la CLI gcloud, procédez comme suit :
Créez un fichier JSON qui spécifie les détails de configuration de votre job. Pour exemple, pour créer un job de script de base, créez un fichier JSON avec les contenus suivants. 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
.{ "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. Un script doit être défini en tant que texte à l'aide du sous-champtext
ou en tant que chemin d'accès à un fichier accessible à l'aide du sous-champfile
. Pour plus consultez lesscript
sous-champs et l'exemple de job de script de cette section.CORES
: facultatif. Nombre de cœurs (en particulier de CPU virtuels, qui représentent généralement la moitié d'un cœur physique) à allouer pour chaque tâche en unités milliCPU. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(2 vCPU).MEMORY
: facultatif. Quantité de mémoire à allouer pour chaque tâche, en Mo. Si le champmemoryMib
n'est pas définie, la valeur est définie sur2000
(2 Go).MAX_RETRY_COUNT
: facultatif. Nombre maximal de nouvelles 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 qu'il ne faut pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez la section Automatiser les nouvelles tentatives de tâches.MAX_RUN_DURATION
: facultatif. La durée maximale Une tâche est autorisée à s'exécuter avant d'être relancée ou d'échouer, au format suivant : une valeur en secondes suivie des
(par exemple,3600s
pour 1 heure. Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez Limitez la durée 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. Le nombre de tâches le job s'exécute simultanément. Le nombre ne peut pas être supérieur au nombre de tâches. Il doit s'agir d'un nombre entier compris entre1
et la limite de tâches parallèles par job. Si le 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 suivante :
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 de 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
: le ID du projet de votre projet.LOCATION
: emplacement du travail.JOB_NAME
: nom de la tâche.SCRIPT
: script exécuté par chaque tâche. Un script doit être défini en tant que texte à l'aide du sous-champtext
ou en tant que chemin d'accès à un fichier accessible à l'aide du sous-champfile
. Pour en savoir plus, consultez les sous-champsscript
et l'exemple de tâche de script dans cette section.CORES
: facultatif. Nombre de cœurs (en particulier de CPU virtuels, qui représentent généralement la moitié d'un cœur physique) à allouer pour chaque tâche en unités de milliCPU. Si le champcpuMilli
n'est pas spécifié, la valeur est définie sur2000
(2 vCPU).MEMORY
: facultatif. Quantité de mémoire à allouer pour 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 nouvelles 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 qu'il ne faut pas relancer la tâche. Pour en savoir plus sur le champmaxRetryCount
, consultez Automatisez les nouvelles tentatives d'exécution de tâches.MAX_RUN_DURATION
: facultatif. Durée maximale pendant laquelle une tâche est autorisée à s'exécuter avant d'être réessayée ou d'échouer, au format valeur en secondes suivie des
(par exemple,3600s
pour une heure). Si le champmaxRunDuration
n'est pas spécifié, la valeur est définie sur la durée d'exécution maximale d'une tâche. Pour en savoir plus sur le champmaxRunDuration
, consultez Limitez la durée d'exécution des tâches et des exécutables à l'aide de délais avant expiration.TASK_COUNT
: facultatif. Nombre de tâches de 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 exécutées simultanément par le job. Le nombre ne peut pas être supérieur au nombre de tâches. Il doit s'agir d'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 un job 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
correspond à l'ID de projet de votre projet.
Go
Go
Pour en savoir plus, consultez les API Go par lot documentation de référence.
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 Java par lot.
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 Node.js par lot.
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 les API Python par lot documentation de référence.
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 C++ par lot.
Pour vous authentifier auprès de Batch, configurez le service 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 dans une tâche. Vous pouvez utiliser n'importe quelle variable d'environnement Les jobs par lot et les variables d'environnement personnalisées que vous définissez lors de la création du job.
Utiliser des variables d'environnement prédéfinies
Par défaut, les exécutables de votre job peuvent utiliser les éléments suivants : variables d'environnement prédéfinies:
BATCH_TASK_COUNT
: nombre total de tâches de 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 VM en cours d'exécution instances de ce groupe de tâches. Pour utiliser cette variable d'environnement, ChamprequireHostsFile
doit être défini surtrue
.BATCH_TASK_RETRY_ATTEMPT
: nombre de tentatives d'exécution de cette tâche. La valeur est0
lors de la première tentative d'une tâche et est incrémentée pour chaque nouvelle tentative. Le nombre total de nouvelles tentatives autorisées pour une tâche est déterminé par la valeur du champmaxRetryCount
, qui est0
si elle n'est pas définie. Pour en savoir plus sur les tentatives, consultez Automatiser les nouvelles tentatives d'exécution de tâches.
Pour obtenir un exemple d'utilisation des variables d'environnement prédéfinies, consultez la Exemples d'exécutables précédents dans Créer un job de base dans 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 qui a 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 la méthode l'environnement de tous les exécutables (
environment
sous-champ detaskSpec
).Sinon, si la variable a une valeur distincte pour tous les exécutables, utilisez un ou plusieurs environnements d'exécuteurs spécifiques (sous-champ
environment
derunnables[]
).
Sinon, pour une variable tableau qui possède une valeur distincte pour chaque tâche, utilisez l'environnement de toutes les tâches (
taskEnvironment
).
Dans l'environnement sélectionné, vous devez définir le nom et la ou les valeurs de chaque à l'aide de l'un des sous-champs d'environnement suivants:
Pour définir la variable directement dans le fichier JSON de configuration du job, utilisez la méthode Sous-champ "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'une Secret Manager, utilisez le Sous-champ des variables de secret (
secretVariables
). Pour en savoir plus sur l'utilisation des secrets dans un job, consultez Protégez 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 "variables chiffrées" (
encryptedVariables
). Pour en savoir plus sur les clés Cloud KMS, consultez la documentation pour Cloud Key Management Service.
Vous pouvez définir et utiliser des variables d'environnement personnalisées à 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 job comporte une variable de tableau qui a une valeur différente pour chaque tâche.
gcloud
Si vous souhaitez définir un job qui transmet une variable d'environnement à un exécutable exécuté par chaque tâche, consultez l'exemple expliquant comment définir et utiliser une variable d'environnement pour un exécutable. Sinon, si vous souhaitez définir une tâche qui transmet une liste de variables d'environnement à différentes tâches en fonction de l'indice de la tâche, consultez l'exemple expliquant comment 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 du
gcloud CLI, utilisez la
Commande gcloud batch jobs submit
et spécifiez les variables d'environnement dans le fichier de configuration du job.
Par exemple, pour créer une tâche de script qui définit une variable d'environnement et le transmet aux scripts de 3 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 variable d'environnement en majuscules.VARIABLE_VALUE
: facultatif. La valeur du paramètre variable d'environnement transmise à chaque tâche.
Exécutez la commande suivante :
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
Créer une tâche qui transmet des variables d'environnement à une tâche en fonction de la tâche
à l'aide de la gcloud CLI, utilisez la
Commande gcloud batch jobs submit
et spécifiez le champ de tableau taskEnvironments
dans la configuration du job
.
Par exemple, pour créer un job incluant un tableau de 3 environnements variables avec des noms correspondants et des valeurs différentes, et transmet le variables d'environnement aux scripts des tâches dont les index correspondent aux "Variables d'environnement" index du tableau:
Dans le répertoire actuel, créez un fichier JSON nommé
hello-world-task-environment-variables.json
avec les éléments suivants contenus:{ "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 du variables d'environnement de tâche transmis aux tâches avec des index correspondants. Par les noms des variable d'environnement 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
: la valeur de la transmise à la deuxième tâche, pour laquelleBATCH_TASK_INDEX
est égal à1
.TASK_VARIABLE_VALUE_2
: la valeur de la transmise à la troisième tâche, pour laquelleBATCH_TASK_INDEX
est égal à2
.
Exécutez la commande suivante :
gcloud batch jobs submit example-task-environment-variables-job \ --location us-central1 \ --config hello-world-task-environment-variables.json
API
Pour définir une tâche qui transmet une variable d'environnement à un exécutable que chaque tâche s'exécute, consultez l'exemple pour savoir comment Définissez et utilisez une variable d'environnement pour un exécutable. Sinon, si vous souhaitez définir un job qui passe par une liste d'environnements variables à différentes tâches en fonction de l'index des tâches, consultez l'exemple Définir et utiliser une variable d'environnement pour chaque tâche
Définir et utiliser une variable d'environnement pour un exécutable
Pour créer une tâche qui transmet des variables d'environnement à un exécutable à l'aide de l'API Batch, utilisez la commande gcloud batch jobs submit
et spécifiez les variables d'environnement dans le champ environment
.
Par exemple, pour créer une tâche qui inclut une variable d'environnement et le transmet aux scripts de 3 tâches, envoyez 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
: le ID du projet de votre projet.VARIABLE_NAME
: nom du environnement transmise à chaque tâche. Par convention, les noms des variable d'environnement sont en majuscules ;VARIABLE_VALUE
: valeur de l'environnement transmise à chaque tâche.
Définir et utiliser une variable d'environnement pour chaque tâche
Créer une tâche qui transmet des variables d'environnement à une tâche en fonction de la tâche
à l'aide de l'API Batch, utilisez la méthode jobs.create
et spécifiez les variables d'environnement dans le champ de tableau taskEnvironments
.
Par exemple, pour créer une tâche qui inclut un tableau de trois variables d'environnement avec des noms correspondants et des valeurs différentes, et qui transmet les variables d'environnement aux scripts de trois tâches en fonction de leurs indices, effectuez 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
: le ID du projet de votre projet.TASK_VARIABLE_NAME
: nom de l'environnement transmises aux tâches avec des index correspondants. Par convention, les noms des variable d'environnement en majuscules.TASK_VARIABLE_VALUE_0
: la valeur de la transmise à la première tâche, pour laquelleBATCH_TASK_INDEX
est égal à0
.TASK_VARIABLE_VALUE_1
: la valeur de la transmise à la deuxième tâche, pour laquelleBATCH_TASK_INDEX
est égal à1
.TASK_VARIABLE_VALUE_2
: la valeur de la transmise à la troisième tâche, pour laquelleBATCH_TASK_INDEX
est égal à2
.
Étape suivante
- 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 jobs et les tâches
- En savoir plus sur les options de création de tâches