Planifier une fonction Cloud Run HTTP

Ce tutoriel explique comment planifier une fonction Cloud Run HTTP en ciblant un point de terminaison HTTP dans Cloud Scheduler. Utilisez une fonction HTTP lorsque vous avez besoin que votre fonction dispose d'un point de terminaison d'URL et réponde aux requêtes HTTP, par exemple pour les webhooks.

Vous pouvez également créer une fonction basée sur des événements à l'aide de CloudEvents et utiliser des déclencheurs Eventarc pour planifier la réponse de votre fonction aux événements de votre projet. Eventarc peut déclencher des messages sur un sujet Pub/Sub, des modifications dans un bucket Cloud Storage, etc. Pour en savoir plus, consultez Écrire des fonctions Cloud Run.

Il est courant d'utiliser Cloud Scheduler afin de planifier l'exécution d'une fonction Cloud Run. Au cours de ce tutoriel, vous allez :

1. Créer une fonction Cloud Run HTTP.
2. Créer un job Cloud Scheduler.
3. Exécuter votre job Cloud Scheduler.
4. Vérifier les résultats dans les fonctions Cloud Run.

Coûts

Dans ce document, vous utilisez les composants facturables de suivants Google Cloud:

• Cloud Run
• Cloud Scheduler

Obtenez une estimation des coûts en fonction de votre utilisation prévue, utilisez le simulateur de coût.

Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai sans frais.

Avant de commencer

Connectez-vous à votre Google Cloud compte. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $de crédits sans frais pour exécuter, tester et déployer des charges de travail.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build, Cloud Run Admin, Cloud Scheduler APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the following roles to the service account: Cloud Run > Cloud Run Invoker, Cloud Run > Cloud Run Builder.

   To grant a role, find the Select a role list, then select the role.

   To grant additional roles, click Add another role and add each additional role.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
7. Click Continue.

8. Click Done to finish creating the service account.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

If you're using an existing project for this guide, verify that you have the permissions required to complete this guide. If you created a new project, then you already have the required permissions.

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build, Cloud Run Admin, Cloud Scheduler APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Create a service account:

1. Ensure that you have the Create Service Accounts IAM role (roles/iam.serviceAccountCreator) and the Project IAM Admin role (roles/resourcemanager.projectIamAdmin). Learn how to grant roles.

2. In the Google Cloud console, go to the Create service account page.

   Go to Create service account
3. Select your project.

4. In the Service account name field, enter a name. The Google Cloud console fills in the Service account ID field based on this name.

   In the Service account description field, enter a description. For example, Service account for quickstart.

5. Click Create and continue.

6. Grant the following roles to the service account: Cloud Run > Cloud Run Invoker, Cloud Run > Cloud Run Builder.

   To grant a role, find the Select a role list, then select the role.

   To grant additional roles, click Add another role and add each additional role.

   Note: The Role field affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later.
7. Click Continue.

8. Click Done to finish creating the service account.

Notez que vous devez attribuer le rôle Demandeur Cloud Run, car dans les fonctions Cloud Run, les autorisations d'appel sont disponibles en gérant le service Cloud Run sous-jacent.

Rôles requis

Pour obtenir les autorisations nécessaires pour suivre le tutoriel, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

• Développeur de source Cloud Run (roles/run.sourceDeveloper)
• Administrateur Cloud Scheduler (roles/cloudscheduler.admin)
• Accesseur de vues de journaux (roles/logging.viewAccessor)
• Administrateur de projet IAM (roles/resourcemanager.projectIamAdmin)
• Administrateur de compte de service (roles/iam.serviceAccountAdmin)
• Utilisateur du compte de service (roles/iam.serviceAccountUser)

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.

Remarque : Les rôles de base IAM peuvent également contenir des autorisations permettant de suivre le tutoriel. Les rôles de base ne doivent pas être attribués dans un environnement de production, mais ils peuvent être attribués dans un environnement de développement ou de test.

Attribuer les rôles

Console

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

   Accéder à IAM
2. Sélectionnez le projet.
3. Cliquez sur Accorder l'accès.

4. Dans le champ Nouveaux comptes principaux, saisissez votre identifiant utilisateur. Il s'agit généralement de l'adresse e-mail utilisée pour déployer le service Cloud Run.

5. Dans la liste Sélectionner un rôle, sélectionnez un rôle.
6. Pour attribuer des rôles supplémentaires, cliquez sur Ajouter un autre rôle et ajoutez tous les rôles supplémentaires.
7. Cliquez sur Enregistrer.

gcloud

Pour attribuer les rôles IAM requis à votre compte sur votre projet :

     gcloud projects add-iam-policy-binding PROJECT_ID \
         --member=PRINCIPAL \
         --role=ROLE
     

Remplacez :

• PROJECT_NUMBER par votre Google Cloud numéro de projet.
• PROJECT_ID par l'ID de votre Google Cloud projet.
• PRINCIPAL par le compte pour lequel vous ajoutez la liaison. Il s'agit généralement de l'adresse e-mail qui est utilisée pour déployer le service Cloud Run.
• ROLE par le rôle que vous ajoutez au compte du déployeur.

Créer une fonction Cloud Run HTTP

Créez une fonction HTTP déclenchée par Cloud Scheduler.

1. Dans la Google Cloud console, accédez à la page Cloud Run > Services.

   Accéder aux services

2. Cliquez sur Écrire une fonction.

3. Dans la section Configurer, procédez comme suit :

   1. Dans le champ Nom du service, saisissez un nom pour votre fonction.
   2. Dans la liste Région, sélectionnez une région.
   3. Ne modifiez pas la langue d'exécution par défaut.

   4. Pour l'authentification, sélectionnez Exiger l'authentification.

      Si vous êtes soumis à une règle d'administration de restriction de domaine limitant les appels non authentifiés pour votre projet, vous devez accéder au service déployé comme décrit dans la section Tester les services privés.

      Pour en savoir plus, consultez la section Aperçu de l'authentification.

4. Acceptez les autres paramètres par défaut et cliquez sur Créer.

5. Copiez l'URL HTTP de la fonction.

Pour en savoir plus, y compris sur le déploiement d'une fonction Cloud Run à l'aide de Terraform, consultez Déployer une fonction Cloud Run.

Créer un job Cloud Scheduler

Créez un job Cloud Scheduler qui déclenche une action à l'aide de HTTP.

1. Dans la Google Cloud console, accédez à la page Cloud Scheduler > Jobs.

   Accéder aux tâches

2. Cliquez sur Créer une tâche.

3. Saisissez un nom pour votre tâche.

4. Dans la liste Région, sélectionnez une région.

5. Dans le champ Fréquence, spécifiez la fréquence de votre tâche en utilisant le format unix-cron :

   30 16 * * 7
   

   Pour en savoir plus, consultez Format des tâches Cron et fuseau horaire.

6. Dans la liste Fuseau horaire, sélectionnez un fuseau horaire.

7. Cliquez sur Continuer.

8. Dans la liste Type de cible, sélectionnez HTTP.

9. Dans le champ URL, saisissez l'URL HTTP de la fonction que vous avez copiée précédemment.

10. Dans la liste En-tête Auth, sélectionnez Ajouter un jeton OIDC.

11. Dans la liste Compte de service, sélectionnez le compte de service que vous avez créé précédemment.

12. Dans le champ Audience, saisissez l'URL HTTP de la fonction que vous avez copiée précédemment.

13. Cliquez sur Créer.

Vous avez créé une job Cron qui exécute votre fonction Cloud Run à 16h30 le dimanche.

Exécuter votre job Cloud Scheduler

Vous pouvez maintenant exécuter la tâche que vous avez créée.

1. Dans la Google Cloud console, accédez à la page Cloud Scheduler > Jobs.

   Accéder aux tâches

2. Cochez la case correspondant à la tâche que vous avez créée.

3. Cliquez sur Forcer l'exécution.

   Lors de son appel initial, la première tâche créée dans un projet peut prendre quelques minutes à configurer et à exécuter.

   Une fois la tâche exécutée, l'état de la dernière exécution doit indiquer Success.

Vérifier les résultats dans les fonctions Cloud Run

Vous pouvez vérifier que votre fonction Cloud Run est correctement déclenchée et exécutée par votre job Cron.

1. Dans la console Google Cloud , accédez à la page Cloud Run > Services.

   Accéder aux services

2. Pour filtrer la liste des services pour les fonctions, sélectionnez filter_list Filtrer > Type de déploiement > Fonction.

3. Cliquez sur le nom de la fonction.

   La page Détails du service s'ouvre et affiche les métriques du service.

4. Cliquez sur l'onglet Journaux.

   Une entrée de journal semblable à POST 200 146 B 5 ms Google-Cloud-Scheduler https://FUNCTION_NAME doit s'afficher.

Effectuer un nettoyage

Pour éviter que les ressources utilisées lors de ce tutoriel soient facturées sur votre compte Google Cloud, supprimez le projet contenant les ressources, ou conservez le projet et supprimez les ressources individuelles.

Supprimer le projet

Attention : La suppression d'un projet a les effets suivants :

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches décrites dans ce document et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

1. Dans la Google Cloud console, accédez à la page Gérer les ressources.

   Accéder à la page "Gérer les ressources"

2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez Arrêter pour supprimer le projet.

Supprimer les ressources du tutoriel

1. Dans la Google Cloud console, accédez à la page Cloud Scheduler > Jobs.

   Accéder aux tâches

2. Cochez la case située en regard de votre tâche.

3. Cliquez sur Supprimer , puis confirmez votre suppression.

4. Dans la console Google Cloud , accédez à la page Cloud Run > Services.

   Accéder aux services

5. Cochez la case située à côté de votre service.

6. Cliquez sur Supprimer , puis confirmez votre suppression.

7. Dans la Google Cloud console, accédez à la page Comptes de service.

   Accéder à la page "Comptes de service"

8. Cochez la case située à côté du compte de service que vous avez créé.

9. Cliquez sur Supprimer , puis confirmez votre suppression.

Étape suivante

• Utiliser Cloud Scheduler pour déclencher Cloud Run de manière planifiée
• Écrire des fonctions CloudEvents pour planifier la réponse de votre fonction aux événements de votre projet