Utiliser l'authentification avec des cibles HTTP

Cloud Scheduler peut appeler des cibles HTTP nécessitant une authentification si vous vous devez avoir configuré un compte de service associé dispose des identifiants appropriés.

Configurer le compte de service

  1. Si vous ne disposez pas déjà d'un compte de service que vous souhaitez utiliser pour les tâches Cloud Scheduler avec des cibles HTTP, créez-en un. Veuillez noter les points suivants :

    • Le compte de service doit appartenir au projet dans lequel le job Cloud Scheduler est créé.

    • Ne pas utiliser l'agent de service Cloud Scheduler (service-YOUR_PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com). Elle ne peut pas être utilisée à cette fin.

    • Ne pas révoquer le rôle d'agent de service Cloud Scheduler (roles/cloudscheduler.serviceAgent) depuis Cloud Scheduler sur l'agent de service de votre projet. Cela aura pour effet de 403. aux points de terminaison nécessitant une authentification, même si le service dispose du rôle approprié.

  2. Si votre cible se trouve dans Google Cloud, attribuez les rôles IAM nécessaires à votre compte de service. Chaque service de Google Cloud requiert un rôle spécifique, et le service destinataire vérifie automatiquement le jeton généré. Pour (exemple : pour Cloud Run et la deuxième génération fonctions Cloud Run, vous devez ajouter le rôle Cloud Run Invoker.

    Notez que pour déployer une ressource avec un compte de service géré par l'utilisateur, le déployeur doit disposer de l'autorisation iam.serviceAccounts.actAs pour ce compte de service. Si vous avez créé le compte de service, accordera automatiquement cette autorisation. Sinon, quelqu'un qui a la bonne doit vous accorder cette autorisation sur le compte de service.

    Bonne pratique : à l'étape précédente, si vous avez créé un compte de service spécifiquement pour appeler le service ciblé par votre tâche Cloud Scheduler, envisagez de suivre le principe du moindre privilège (bonne pratique de sécurité) en associant le compte et son autorisation d'appelant à votre service cible. Pour ce faire, utilisez la console Google Cloud ou gcloud CLI :

    Console

    1. Ouvrez la console Google Cloud.

    Accéder à la console

    2. Sélectionnez votre projet.

    3. Accédez à la page correspondant au type de ressource que vous appelez. Pour Par exemple, si vous appelez un service Cloud Run, accédez à la page répertorie les services Cloud Run.

    4. Cochez la case située à gauche du service que vous souhaitez appeler. (Ne cliquez pas sur le service lui-même.)

    5. Cliquez sur l'onglet Autorisations. Si le volet d'informations n'est pas visible, vous devrez peut-être cliquer sur Afficher le panneau d'informations, puis sur Autorisations.

    6. Cliquez sur Ajouter un compte principal.

    7. Sous Ajouter des comptes principaux, saisissez l'adresse e-mail du compte de service que vous avez créé.

    8. Sous Attribuer des rôles, sélectionnez un rôle dans la liste déroulante. Suivez le principe du moindre privilège en choisissant le rôle qui inclut dont le compte principal a besoin.

    9. Cliquez sur Enregistrer.

    gcloud

    Exécutez la commande add-iam-policy-binding :

    gcloud RESOURCE_TYPE add-iam-policy-binding RESOURCE_ID \
--member=PRINCIPAL --role=ROLE

    Remplacez :

    • RESOURCE_TYPE: type de ressource de votre cible. Par exemple, run pour une cible Cloud Run.
    • RESOURCE_ID : identifiant de votre cible. Par exemple, le nom du service pour une cible Cloud Run.
    • PRINCIPAL : identifiant de votre compte de service. Il se présente sous la forme suivante : serviceAccount:SERVICE_ACCOUNT_EMAIL_ADDRESS. Par exemple, serviceAccount:my-service-account@my-project.iam.gserviceaccount.com.
    • ROLE : nom du rôle requis par votre service cible pour l'appel. Par exemple, roles/run.invoker pour une cible de fonctions Cloud Run ou Cloud Run de deuxième génération.

    Exemples :

    • Cible Cloud Run : la commande suivante attribue le rôle Demandeur Cloud Run au compte de service my-service-account@my-project.iam.gserviceaccount.com pour le service Cloud Run my-service :

      gcloud run add-iam-policy-binding my-service \
 --member=serviceAccount:my-service-account@my-project.iam.gserviceaccount.com \
 --role=roles/run.invoker

    • Cible des fonctions Cloud Run:la commande suivante accorde au Rôle Demandeur Cloud Run requis par la deuxième génération Cloud Run fonctionne sur le compte de service my-service-account@my-project.iam.gserviceaccount.com pour la seconde la fonction my-gen2-function de la fonction Cloud Run de génération:

      gcloud functions add-iam-policy-binding my-gen2-function \
 --member=serviceAccount:my-service-account@my-project.iam.gserviceaccount.com \
 --role=roles/run.invoker --gen2

  3. Si votre cible se situe en dehors de Google Cloud, le service destinataire doit valider manuellement le jeton.

  4. Le compte de service Cloud Scheduler par défaut est automatiquement défini lorsque vous activez l'API Cloud Scheduler, sauf si vous l'avez activée avant 19 mars 2019, auquel cas vous devez ajoutez le rôle Cloud Scheduler Service Agent manuellement. Cela lui permet de générer des jetons d'en-tête au nom de votre compte de service client en vue de l'authentification auprès de la cible.

    Vous pouvez vérifier que le compte de service Cloud Scheduler par défaut est configuré dans votre projet et qu'il dispose du rôle Cloud Scheduler Service Agent qui lui est attribué par afficher l'accès actuel de votre projet. Notez que si vous utilisez la console Google Cloud pour afficher l'accès à votre projet, veillez à cocher la case Inclure les attributions de rôles fournies par Google.

Créer un job de planification avec authentification

Pour créer une tâche qui utilise l'authentification, vous devez ajouter le type de jeton. et l'adresse e-mail qui identifie le compte de service client Requête create-job:

Console

  1. Spécifiez la fréquence "Toujours".
  2. Spécifiez HTTP comme type de cible.
  3. Ajoutez l'URL et la méthode HTTP comme d'habitude.
  4. Dans la liste Auth header (En-tête d'authentification), sélectionnez le type de jeton. Notez que l'OIDC (jeton d'identité) est généralement utilisé sauf pour les API Google hébergées sur *.googleapis.com, car ces API attendent un jeton d'accès OAuth.
  5. Dans le champ Compte de service, spécifiez l'adresse e-mail du compte de service client.
  6. L'option Audience est facultative et limite le nombre de destinataires pour le jeton OIDC. généralement l'URL cible de l'offre d'emploi (sans paramètres d'URL). Si cette option n'est pas spécifiée, l'URL complète est utilisée par défaut en tant qu'audience (y compris les paramètres de requête).

gcloud

gcloud scheduler jobs create http JOB_ID \
  --schedule="FREQUENCY" --uri=URI \
  --oidc-service-account-email=CLIENT_SERVICE_ACCOUNT_EMAIL

Remplacez les éléments suivants :

  • JOB_ID: nom de la tâche. Ce nom doit être unique dans le projet. Notez que vous ne pouvez pas réutiliser un nom de tâche dans un projet, même si vous supprimez la tâche associée.
  • FREQUENCY: l'intervalle de la tâche correspond à la fréquence à laquelle doit s'exécuter, par exemple, every 3 hours ou every 10 mins. La chaîne que vous fournissez ici peut être n'importe quelle chaîne compatible avec Crontab. (Bien que nous ne recommandions plus son utilisation, l'ancienne version Syntaxe Cron d'App Engine est toujours compatible avec les jobs existants.)
  • URI: URL complète du point de terminaison.
  • --oidc-service-account-email ou --oauth-service-account-email : définit le type de jeton. Notez que l'OIDC est généralement utilisé sauf pour les API Google hébergées sur *.googleapis.com, car ces API attendent un jeton OAuth.
  • CLIENT_SERVICE_ACCOUNT_EMAIL : adresse e-mail du compte du service client.
  • D'autres paramètres facultatifs sont disponibles et décrits dans la Documentation de référence sur l'outil de ligne de commande gcloud

Choisir des types de jetons

Pour vous authentifier entre Cloud Scheduler et une cible HTTP, Cloud Scheduler crée un jeton d'en-tête basé sur votre compte de service client, identifié par son adresse e-mail, et l'envoie via HTTPS à la cible. Vous pouvez utiliser un jeton d'ID (OIDC) ou un jeton OAuth (d'accès). OIDC est généralement utilisé, sauf pour les API Google hébergé sur *.googleapis.com, car ces API attendent un jeton OAuth.

Ajoutez manuellement le rôle d'agent de service Cloud Scheduler à votre compte de service Cloud Scheduler

Cette opération n'est nécessaire que si l'une des conditions suivantes est remplie :

  • Vous avez activé l'API Cloud Scheduler avant le 19 mars 2019
  • Vous avez supprimé le rôle d'agent de service Cloud Scheduler de votre service compte

Le compte de service Cloud Scheduler requiert Rôle d'agent de service Cloud Scheduler. Sans ce rôle, les tâches Cloud Scheduler échouent. Vous pouvez ajouter Rôle d'agent de service Cloud Scheduler pour votre programme Cloud Scheduler compte de service depuis la console Google Cloud ou à l'aide du gcloud CLI:

Console

  1. Dans la console Google Cloud, accédez à API Cloud Scheduler.

    Accéder à l'API Cloud Scheduler

    Si un champ Status (État) s'affiche et que l'état indique Enabled (Activé), continuer. Si ce n'est pas le cas, cliquez sur Activer.

  2. Dans la console Google Cloud, accédez à la page Paramètres. .

    Accéder aux paramètres

  3. Recherchez et copiez votre numéro de projet.

  4. Dans la console Google Cloud, accédez à IAM .

    Accéder à IAM

  5. Cliquez sur Accorder l'accès. Le volet Accorder l'accès s'affiche.

  6. Dans le champ Nouveaux comptes principaux, ajoutez une adresse e-mail au format suivant:

    service-PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com

    Remplacez PROJECT_NUMBER par votre Numéro de projet Google Cloud.

  7. Dans la liste Sélectionner un rôle, recherchez et sélectionnez Cloud Scheduler Agent de service.

  8. Cliquez sur Enregistrer.

gcloud

  1. Vérifiez que l'API Cloud Scheduler est activée pour votre projet:

    gcloud services list --enabled \
 --filter=cloudscheduler.googleapis.com

    • Si le résultat suivant s'affiche, l'API est activée:

      NAME: cloudscheduler.googleapis.com
TITLE: Cloud Scheduler API

    • Si ce n'est pas le cas (par exemple, si vous voyez Listed 0 items.), activez l'API:

      gcloud services enable cloudscheduler.googleapis.com

  2. Recherchez le numéro de votre projet :

    gcloud projects describe PROJECT_ID --format='table(projectNumber)'

    Remplacez PROJECT_ID par l'ID du projet.

  3. Copiez le numéro.

  4. Attribuez le rôle Cloud Scheduler Service Agent au compte de service Cloud Scheduler :

    gcloud projects add-iam-policy-binding PROJECT_ID \
   --member serviceAccount:service-PROJECT_NUMBER@gcp-sa-cloudscheduler.iam.gserviceaccount.com \
   --role roles/cloudscheduler.serviceAgent

    Remplacez les éléments suivants :

    • PROJECT_ID : ID de votre projet.
    • PROJECT_NUMBER: numéro du projet précédemment copié