Exécuter des jobs

Cette page explique comment exécuter des tâches Cloud Run. L'exécution d'un job crée une exécution de job dans laquelle toutes les tâches doivent s'exécuter pour que l'exécution du job aboutisse. Les exécutions de tâches écrivent des journaux dans Cloud Logging et envoient des données de surveillance à Cloud Monitoring.

En plus de ces fonctionnalités de journalisation, vous pouvez également consulter les détails des 1 000 exécutions les plus récentes d'un job à l'aide du volet des détails d'exécution, ainsi que toutes les exécutions ayant eu lieu au cours des sept derniers jours. Les détails des exécutions plus anciennes sont supprimés et ne sont plus visibles dans le volet des détails d'exécution. Toutefois, les journaux et les données de surveillance des exécutions plus anciennes restent disponibles dans Cloud Logging et Cloud Monitoring, où ils sont soumis aux règles de conservation applicables pour ces produits.

Rôles requis

Pour obtenir les autorisations nécessaires pour effectuer les opérations décrites sur cette page, demandez à votre administrateur de vous accorder l'un des rôles IAM suivants sur votre job Cloud Run :

• Pour exécuter des jobs à l'aide de Google Cloud CLI : Demandeur Cloud Run (roles/run.invoker) sur le job Cloud Run
• Pour exécuter des jobs à l'aide de la console Google Cloud , remplacer des configurations de jobs ou annuler des exécutions de jobs : Développeur Cloud Run (roles/run.developer) sur le job Cloud Run

Pour obtenir la liste des rôles et des autorisations IAM associés à Cloud Run, consultez les sections Rôles IAM Cloud Run et Autorisations IAM Cloud Run. Si votre job Cloud Run communique avec des APIGoogle Cloud , telles que des bibliothèques clientes Cloud, consultez le guide de configuration de l'identité du service. Pour en savoir plus sur l'attribution de rôles, consultez les pages Autorisations de déploiement et Gérer les accès.

Exécuter des jobs

Vous pouvez exécuter des jobs à l'aide de la console Google Cloud , de Google Cloud CLI, des bibliothèques clientes ou de l'API REST.

Console

Pour exécuter une tâche, procédez comme suit :

1. Dans la console Google Cloud , accédez à la page Jobs de Cloud Run :

   Accéder aux jobs Cloud Run

2. Recherchez le job qui vous intéresse.

3. Cliquez sur la tâche pour afficher la page Informations sur la tâche.

4. Cliquez sur Exécuter.

gcloud

Pour exécuter une tâche existante, procédez comme suit :

gcloud run jobs execute JOB_NAME

Si vous souhaitez que la commande attend la fin de l'exécution, utilisez

gcloud run jobs execute JOB_NAME --wait --region=REGION

Remplacez les éléments suivants :

• JOB_NAME : nom du job.
• REGION : région dans laquelle se trouve la ressource. Exemple : europe-west1. Vous pouvez également définir la propriété run/region.

Bibliothèques clientes

Pour exécuter un job existant à partir du code, procédez comme suit :

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

API REST

Pour exécuter un job existant, envoyez une requête HTTP POST à la méthode API jobs.run.

Exemple, à l'aide de curl :

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X POST \
  -d '' \
  https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB_NAME:run

Remplacez les éléments suivants :

• ACCESS_TOKEN : jeton d'accès valide pour un compte disposant des autorisations IAM pour exécuter un job. Par exemple, si vous êtes connecté à gcloud, vous pouvez récupérer un jeton d'accès à l'aide de gcloud auth print-access-token. À partir d'une instance de conteneur Cloud Run, vous pouvez récupérer un jeton d'accès via le serveur de métadonnées d'instance de conteneur.
• JOB_NAME : nom du job.
• REGION : Google Cloud région du job.
• PROJECT_ID : ID du projet Google Cloud .

Exécuter les jobs immédiatement

Console

Pour exécuter un job immédiatement :

1. Dans la console Google Cloud , accédez à la page Jobs de Cloud Run :

   Accéder aux jobs Cloud Run

2. Si vous avez déjà un job, cliquez dessus pour afficher la page "Informations sur le job", puis sélectionnez Afficher et modifier la configuration du job. Si vous créez un job, sélectionnez Déployer un conteneur.

3. En bas de la page, cochez la case Exécuter le job immédiatement avant de créer ou de modifier le job.

gcloud

Vous pouvez spécifier l'indicateur --execute-now lorsque vous créez ou mettez à jour un job :

• Créer un job :

  gcloud run jobs create JOB_NAME \
    --image IMAGE_URL \
    --execute-now \
    --region=REGION

• Mettre à jour une tâche :

  gcloud run jobs update JOB_NAME --execute-now --region=REGION

Remplacez les éléments suivants :

• JOB_NAME : nom du job.
• IMAGE_URL : référence à l'image de conteneur (par exemple, us-docker.pkg.dev/cloudrun/container/job:latest).
• REGION : région dans laquelle se trouve la ressource. Exemple : europe-west1.

YAML

Vous pouvez stocker votre spécification de tâche dans un fichier YAML, puis la déployer à l'aide de gcloud CLI.

1. Si vous créez un job, ignorez cette étape. Si vous mettez à jour un job existant, téléchargez sa configuration YAML :

   gcloud run jobs describe JOB_NAME --format export > job.yaml

2. Configurez l'attribut startExecutionToken comme indiqué ci-dessous :

   apiVersion: run.googleapis.com/v2
   kind: Job
   metadata:
     name: JOB_NAME
   spec:
     template:
       spec:
         template:
           spec:
             containers:
             - image: IMAGE_URL
     startExecutionToken: START_EXECUTION_SUFFIX

   Remplacez les éléments suivants :

   • JOB_NAME par le nom de votre job Cloud Run Les noms de job doivent comporter un maximum de 49 caractères et être uniques par région et par projet.
   • IMAGE_URL : référence à l'image de conteneur (par exemple, us-docker.pkg.dev/cloudrun/container/job:latest).
   • START_EXECUTION_SUFFIX : chaîne unique utilisée comme suffixe pour créer une exécution. La tâche sera prête une fois l'exécution démarrée. La somme de la longueur du nom du job et du jeton doit être inférieure à 63 caractères.

   Vous pouvez également spécifier d'autres éléments de configuration, tels que des variables d'environnement ou des limites de mémoire.

3. Créez ou mettez à jour le job à l'aide de la commande suivante :

   gcloud run jobs replace job.yaml

Terraform

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.

Ajoutez les éléments suivants à une ressource google_cloud_run_v2_job dans votre configuration Terraform :

resource "google_cloud_run_v2_job" "default" {
   name     = "cloudrun-job"
   location = "REGION"
   deletion_protection = false
   start_execution_token = "START_EXECUTION_SUFFIX"
   template {
      template {
         containers {
         image = "us-docker.pkg.dev/cloudrun/container/job"
         }
      }
   }
}

Remplacez les éléments suivants :

• REGION : la région Google Cloud . Par exemple, europe-west1.
• START_EXECUTION_SUFFIX : chaîne unique utilisée comme suffixe pour créer une exécution. La tâche sera prête une fois l'exécution démarrée. La somme de la longueur du nom du job et du jeton doit être inférieure à 63 caractères.

Bibliothèques clientes

Pour exécuter immédiatement un job à partir du code à l'aide des bibliothèques clientes Cloud :

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

API REST

Pour exécuter des jobs immédiatement après leur création, envoyez une requête HTTP POST au point de terminaison jobs de l'API Cloud Run Admin.

Exemple, à l'aide de curl :

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X POST \
  -d '{
     "template": {
        "template": {
           "containers":
              {
                 "image": "IMAGE_URL"
              }
        }
     },
     "startExecutionToken": "START_EXECUTION_SUFFIX"
  }' \
  "https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs?jobId=JOB_NAME"

Remplacez les éléments suivants :

• ACCESS_TOKEN : jeton d'accès valide pour un compte disposant des autorisations IAM pour créer des jobs. Par exemple, si vous êtes connecté à gcloud, vous pouvez récupérer un jeton d'accès à l'aide de gcloud auth print-access-token. À partir d'une instance de conteneur Cloud Run, vous pouvez récupérer un jeton d'accès via le serveur de métadonnées d'instance de conteneur.
• IMAGE_URL : référence à l'image de conteneur (par exemple, us-docker.pkg.dev/cloudrun/container/job:latest).
• START_EXECUTION_SUFFIX : chaîne unique utilisée comme suffixe pour créer une exécution. La tâche sera prête une fois l'exécution démarrée. La somme de la longueur du nom du job et du jeton doit être inférieure à 63 caractères.
• PROJECT_ID : ID du projet Google Cloud .
• REGION : Google Cloud région du job.
• JOB_NAME : nom du job que vous souhaitez créer.

Remplacer la configuration de tâche pour une exécution spécifique

Vous pouvez remplacer les arguments, les variables d'environnement, le nombre de tâches et le délai avant expiration de la tâche configurés pour un job lorsque vous exécutez un job en définissant ces paramètres lorsque vous démarrez une nouvelle exécution du job. Les paramètres que vous spécifiez n'affectent que cette exécution, et non les suivants, car la définition de la tâche sous-jacente reste inchangée.

Voici quelques cas d'utilisation courants :

• Vous exécutez la tâche de manière automatisée à partir de votre code et vous souhaitez remplacer des arguments et/ou des variables d'environnement, par exemple pour indiquer à la tâche où se trouvent les données d'entrée pour cette exécution.
• Vous avez une tâche dans laquelle chaque tâche est destinée à traiter une seule donnée de données d'entrée. Vous souhaitez ignorer le nombre de tâches en fonction du nombre d'entrées à traiter.
• La durée d'exécution de votre job varie selon les exécutions. Vous souhaitez ignorer le délai avant expiration de la tâche en fonction de sa durée d'exécution.

Pour remplacer la configuration d'une tâche pour une exécution, procédez comme suit:

Console

1. Accéder à la page Cloud Run

2. Recherchez le job qui vous intéresse.

3. Cliquez sur la tâche pour afficher la page Informations sur la tâche.

4. Cliquez sur la flèche de développement devant le bouton Modifier, puis sur Exécuter avec des remplacements pour afficher le formulaire Exécuter une tâche avec remplacements.

   

5. Modifiez les arguments, les variables d'environnement, le nombre de tâches et/ou la configuration du délai d'expiration de la tâche pour cette exécution selon vos besoins, puis cliquez sur Exécuter.

gcloud

Utilisez la commande :

gcloud run jobs execute JOB_NAME \
     --args ARGS \
     --update-env-vars KEY=VALUE>,KEY_N=VALUE_N \
     --tasks TASKS \
     --task-timeout TIMEOUT

Remplacez les éléments suivants :

• JOB_NAME : nom du job.
• ARGS : arguments de job.
• Paires KEY et VALUE : les variables d'environnement.
• TASKS : nombre de tâches.
• TIMEOUT : délai avant expiration du job.

Bibliothèques clientes

Pour exécuter un job existant à partir du code, remplacez la configuration du job :

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

API REST

Pour remplacer la configuration d'un job existant, envoyez une requête HTTP POST au point de terminaison jobs de l'API Cloud Run Admin.

Exemple, à l'aide de curl :

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X POST \
  -d '{"overrides": {"containerOverrides": [{"args": ["ARGS"], "env": [{"name": "KEY", "value": "VALUE"}]}], "taskCount": TASKS, "timeout": "TIMEOUT" }}' \
  https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB_NAME:run

Remplacez les éléments suivants :

• ACCESS_TOKEN : jeton d'accès valide pour un compte disposant des autorisations IAM pour exécuter des remplacements de job. Par exemple, si vous êtes connecté à gcloud, vous pouvez récupérer un jeton d'accès à l'aide de gcloud auth print-access-token. À partir d'une instance de conteneur Cloud Run, vous pouvez récupérer un jeton d'accès via le serveur de métadonnées d'instance de conteneur.
• JOB_NAME : nom du job.
• ARGS : arguments du job.
• Paires KEY et VALUE : variables d'environnement.
• TASKS : nombre de tâches.
• TIMEOUT : délai avant expiration du job
• REGION : Google Cloud région du job.
• PROJECT_ID : ID du projet Google Cloud .

Annuler l'exécution du job

Important : Le 16 septembre 2024, l'autorisation requise pour annuler un job Cloud Run a été remplacée par run.executions.cancel. Les rôles prédéfinis Développeur Cloud Run et Développeur de source Cloud Run contiennent cette autorisation.

Pour arrêter une exécution de job Cloud Run en cours d'exécution, utilisez la fonctionnalité d'annulation. L'annulation d'une exécution de job arrête l'exécution du job en cours. L'état des exécutions annulées est cancelled. Vous pourrez toujours consulter l'exécution, y compris ses données de configuration, ses journaux et ses données de surveillance.

Remarque : En comparaison, si vous utilisez la méthode delete d'exécution de job pour arrêter l'exécution de job en cours, Cloud Run supprime l'exécution de la liste d'exécution de job et vous ne pouvez pas l'afficher.

L'annulation d'un job n'annule pas les frais liés à l'utilisation des jobs Cloud Run pendant la durée d'exécution du job.

Pour annuler une exécution, procédez comme suit :

Console

1. Accéder à la page Cloud Run

2. Cliquez sur le job pour ouvrir son volet Détails.

3. Sélectionnez l'exécution du job que vous souhaitez annuler.

4. Dans le menu Actions, cliquez sur l'icône à trois points, puis sur Annuler.

gcloud

Utilisez la commande :

gcloud run jobs executions cancel EXECUTION_NAME

Remplacez EXECUTION_NAME par le nom de l'exécution.

Cette commande demande une confirmation. Répondez à l'invite en saisissant y pour confirmer.

Bibliothèques clientes

Pour annuler l'exécution d'un job à partir du code, procédez comme suit:

• Go
• Java
• Node.js
• Python
• Ruby
• PHP
• .NET

API REST

Pour annuler l'exécution d'un job, envoyez une requête HTTP POST au point de terminaison jobs de l'API Cloud Run Admin.

Exemple, à l'aide de curl :

curl -H "Content-Type: application/json" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -X POST \
  -d '' \
  https://run.googleapis.com/v2/projects/PROJECT_ID/locations/REGION/jobs/JOB_NAME/executions/EXECUTION-NAME:cancel

Remplacez les éléments suivants :

• ACCESS_TOKEN : jeton d'accès valide pour un compte disposant des autorisations IAM pour annuler des exécutions de job. Par exemple, si vous êtes connecté à gcloud, vous pouvez récupérer un jeton d'accès à l'aide de gcloud auth print-access-token. À partir d'une instance de conteneur Cloud Run, vous pouvez récupérer un jeton d'accès via le serveur de métadonnées d'instance de conteneur.
• JOB_NAME : nom du job.
• EXECUTION-NAME : nom de l'exécution du job.
• REGION : Google Cloud région du job.
• PROJECT_ID : ID du projet Google Cloud .

Supprimer une exécution de job

Vous pouvez supprimer une exécution de job, même s'il est en cours d'exécution. Si vous supprimez une exécution, l'opération empêche la poursuite de l'exécution. Pour en savoir plus, consultez la section Supprimer une exécution de job.

Étapes suivantes

Après avoir exécuté une tâche, vous pouvez effectuer les opérations suivantes :

• Afficher les journaux de tâches
• Surveiller les performances des tâches
• Gérer l'exécution des tâches
• Gérer les jobs