Créer et déployer une fonction Cloud Run HTTP à l'aide de Python (1re génération)

Ce guide vous accompagne tout au long du processus d'écriture d'une fonction Cloud Run à l'aide de l'environnement d'exécution Python. Il existe deux types de fonctions Cloud Run :

• Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
• Les fonctions basées sur des événements, qui vous permettent de gérer les événements depuis votre infrastructure cloud tels que les messages sur un sujet Pub/Sub ou les modifications apportées à un bucket Cloud Storage.

L'exemple montre comment créer une fonction HTTP simple.

En savoir plus : Pour obtenir plus d'informations, consultez Fonctions HTTP et Fonctions basées sur des événements.

Avant de commencer

Connectez-vous à votre compte Google Cloud . 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.

Installez la Google Cloud CLI.

Remarque : Si vous avez déjà installé la gcloud CLI, assurez-vous que vous disposez de la dernière version en exécutant gcloud components update.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Créez ou sélectionnez un projet Google Cloud .

Rôles requis pour sélectionner ou créer un projet

• Sélectionnez un projet : la sélection d'un projet ne nécessite pas de rôle IAM spécifique. Vous pouvez sélectionner n'importe quel projet pour lequel un rôle vous a été attribué.
• Créer un projet : pour créer un projet, vous devez disposer du rôle Créateur de projet (roles/resourcemanager.projectCreator), qui contient l'autorisation resourcemanager.projects.create. Découvrez comment attribuer des rôles.

Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

• Créez un projet Google Cloud  :

  gcloud projects create PROJECT_ID

  Remplacez PROJECT_ID par le nom du projet Google Cloud que vous créez.

• Sélectionnez le projet Google Cloud que vous avez créé :

  gcloud config set project PROJECT_ID

  Remplacez PROJECT_ID par le nom de votre projet Google Cloud .

Vérifiez que la facturation est activée pour votre projet Google Cloud .

Activez les API Cloud Functions et Cloud Build :

Rôles requis pour activer les API

Pour activer les API, vous avez besoin du rôle IAM Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin), qui contient l'autorisation serviceusage.services.enable. Découvrez comment attribuer des rôles.

gcloud services enable cloudfunctions cloudbuild.googleapis.com

Installez la Google Cloud CLI.

Remarque : Si vous avez déjà installé la gcloud CLI, assurez-vous que vous disposez de la dernière version en exécutant gcloud components update.

Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

Pour initialiser la gcloud CLI, exécutez la commande suivante :

gcloud init

Créez ou sélectionnez un projet Google Cloud .

Rôles requis pour sélectionner ou créer un projet

• Sélectionnez un projet : la sélection d'un projet ne nécessite pas de rôle IAM spécifique. Vous pouvez sélectionner n'importe quel projet pour lequel un rôle vous a été attribué.
• Créer un projet : pour créer un projet, vous devez disposer du rôle Créateur de projet (roles/resourcemanager.projectCreator), qui contient l'autorisation resourcemanager.projects.create. Découvrez comment attribuer des rôles.

Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

• Créez un projet Google Cloud  :

  gcloud projects create PROJECT_ID

  Remplacez PROJECT_ID par le nom du projet Google Cloud que vous créez.

• Sélectionnez le projet Google Cloud que vous avez créé :

  gcloud config set project PROJECT_ID

  Remplacez PROJECT_ID par le nom de votre projet Google Cloud .

Vérifiez que la facturation est activée pour votre projet Google Cloud .

Activez les API Cloud Functions et Cloud Build :

Rôles requis pour activer les API

Pour activer les API, vous avez besoin du rôle IAM Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin), qui contient l'autorisation serviceusage.services.enable. Découvrez comment attribuer des rôles.

gcloud services enable cloudfunctions cloudbuild.googleapis.com

1. Préparez votre environnement de développement.

   Accéder au guide de configuration de Python

Créer une fonction

1. Créez un répertoire sur votre système local pour le code de fonction :

   Linux ou Mac OS X

   mkdir ~/helloworld
   cd ~/helloworld
   

   Windows

   mkdir %HOMEPATH%\helloworld
   cd %HOMEPATH%\helloworld
   

2. Créez un fichier main.py dans le répertoire helloworld avec le contenu suivant :

   
   import functions_framework
   
   
   from markupsafe import escape
   
   @functions_framework.http
   def hello_http(request):
       """HTTP Cloud Function.
       Args:
           request (flask.Request): The request object.
           <https://flask.palletsprojects.com/en/1.1.x/api/#incoming-request-data>
       Returns:
           The response text, or any set of values that can be turned into a
           Response object using `make_response`
           <https://flask.palletsprojects.com/en/1.1.x/api/#flask.make_response>.
       """
       request_json = request.get_json(silent=True)
       request_args = request.args
   
       if request_json and "name" in request_json:
           name = request_json["name"]
       elif request_args and "name" in request_args:
           name = request_args["name"]
       else:
           name = "World"
       return f"Hello {escape(name)}!"
   
   

   Cet exemple de fonction utilise un nom fourni dans la requête HTTP et renvoie un message d'accueil. Lorsqu'aucun nom n'est fourni, il renvoie le message "Hello World!".

   Remarque : Cloud Run Functions recherche par défaut les fonctions déployables dans main.py. Utilisez le flag --source lorsque vous déployez votre fonction via gcloud pour spécifier un autre répertoire contenant un fichier main.py.

Spécifier des dépendances

Dans Python, les dépendances sont gérées avec pip et exprimées dans un fichier de métadonnées appelé requirements.txt. Ce fichier doit se trouver dans le même répertoire que le fichier main.py qui contient le code de votre fonction.

Vous n'avez pas besoin de créer de fichier requirements.txt pour exécuter cet exemple, mais supposons que vous souhaitiez ajouter vos propres dépendances. Voici la procédure à suivre :

1. Créez un fichier requirements.txt dans le répertoire helloworld.

2. Ajoutez la dépendance de la fonction à votre fichier requirements.txt, par exemple :

   # An example requirements file, add your dependencies below
   sampleproject==2.0.0
   

En savoir plus : Pour obtenir plus d'informations, consultez la page Spécifier des dépendances.

Déployer la fonction

Pour déployer la fonction avec un déclencheur HTTP, exécutez la commande suivante dans le répertoire helloworld :

gcloud functions deploy hello_http --no-gen2 --runtime python314 --trigger-http --allow-unauthenticated

Le flag --allow-unauthenticated vous permet d'accéder à la fonction sans authentification. Pour exiger une authentification, omettez ce flag.

En savoir plus : Pour obtenir plus d'informations, consultez Déployer des fonctions Cloud Run.

Tester la fonction

1. Une fois le déploiement de la fonction terminé, notez la propriété httpsTrigger.url ou recherchez-la à l'aide de la commande suivante :

   gcloud functions describe hello_http
   

   Elle devrait se présenter comme ceci :

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http

2. Accédez à cette URL dans votre navigateur. Un message de type "Hello World!" doit s'afficher.

   Essayez de transmettre un nom dans la requête HTTP, par exemple à l'aide de l'URL suivante :

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/hello_http?name=NAME

   Le message "Hello NAME!" doit s'afficher.

Afficher les journaux

Les journaux Cloud Run Functions sont visibles à l'aide de la Google Cloud CLI et de l'interface utilisateur de Cloud Logging.

Utiliser l'outil de ligne de commande

Pour afficher les journaux de votre fonction à l'aide de la gcloud CLI, exécutez la commande logs read, suivie du nom de la fonction :

gcloud functions logs read hello_http

La sortie doit ressembler à ceci :

LEVEL  NAME        EXECUTION_ID  TIME_UTC                 LOG
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.791  Function execution started
D      hello_http  pdb5ys2t022n  2019-09-18 23:29:09.798  Function execution took 7 ms, finished with status code: 200

Remarque : En règle générale, il existe un léger décalage entre la création des entrées de journal et leur affichage dans Cloud Logging.

Utiliser le tableau de bord Logging

Vous pouvez également consulter les journaux Cloud Run Functions depuis la consoleGoogle Cloud .

En savoir plus : Pour obtenir plus d'informations, accédez à la page Écrire, afficher des journaux et y répondre.