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

Remarque : Ce contenu ne s'applique qu'aux fonctions Cloud Run (1re génération) (anciennement Cloud Functions (1re génération).)

Pour obtenir la version de ce document correspondant à Cloud Run Functions, consultez Créer et déployer une fonction Cloud Run HTTP à l'aide de PHP.

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

• Les fonctions HTTP, que vous appelez à partir des requêtes HTTP standards.
• Les fonctions déclenchées par 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 les événements.

Avant de commencer

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Functions and Cloud Build APIs.

   Enable the APIs

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

   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

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Cloud Functions and Cloud Build APIs.

   Enable the APIs

8. Installez et initialisez la gcloud CLI.
9. Mettez à jour et installez les composants gcloud :

   gcloud components update

Note: Need a command prompt? Vous pouvez utiliser Cloud Shell. Cloud Shell est un environnement de ligne de commande qui inclut Google Cloud CLI. Vous n'avez donc pas besoin de l'installer. Google Cloud CLI est également préinstallé sur les machines virtuelles Google Compute Engine.
10. Préparez votre environnement de développement.

    Premiers pas avec PHP

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_http
   cd ~/helloworld_http
   

   Windows

   mkdir %HOMEPATH%\helloworld_http
   cd %HOMEPATH%\helloworld_http
   

2. Créez un fichier index.php dans le répertoire helloworld_http avec le contenu suivant :

   <?php
   
   use Google\CloudFunctions\FunctionsFramework;
   use Psr\Http\Message\ServerRequestInterface;
   
   // Register the function with Functions Framework.
   // This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=http` environment
   // variable when deploying. The `FUNCTION_TARGET` environment variable should
   // match the first parameter.
   FunctionsFramework::http('helloHttp', 'helloHttp');
   
   function helloHttp(ServerRequestInterface $request): string
   {
       $name = 'World';
       $body = $request->getBody()->getContents();
       if (!empty($body)) {
           $json = json_decode($body, true);
           if (json_last_error() != JSON_ERROR_NONE) {
               throw new RuntimeException(sprintf(
                   'Could not parse body: %s',
                   json_last_error_msg()
               ));
           }
           $name = $json['name'] ?? $name;
       }
       $queryString = $request->getQueryParams();
       $name = $queryString['name'] ?? $name;
   
       return sprintf('Hello, %s!', htmlspecialchars($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 index.php. Utilisez l'option --source lorsque vous déployez votre fonction via gcloud pour spécifier un autre répertoire contenant un fichier index.php.

Spécifier des dépendances

Vous utilisez Composer pour gérer les dépendances en PHP. Si vous n'avez pas encore installé Composer, vous pouvez le faire en procédant comme suit :

1. Téléchargez Composer à l'emplacement de votre choix.

2. Une fois le téléchargement terminé, déplacez le fichier composer.phar dans un répertoire situé dans le chemin d'accès au système, par exemple :

   mv composer.phar /usr/local/bin/composer
   

Ensuite, spécifiez les dépendances de votre fonction :

1. Ajoutez un fichier composer.json qui va contenir les dépendances au répertoire de votre code de fonction, où FUNCTION_TARGET=FUNCTION_NAME indique le nom de votre fonction. Dans cet exemple, FUNCTION_NAME correspond à helloHttp :

   {
       "require": {
           "php": ">= 8.1",
           "google/cloud-functions-framework": "^1.1"
       },
       "scripts": {
           "start": [
              "Composer\\Config::disableProcessTimeout",
              "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
           ]
       }
   }
   

2. Dans le répertoire contenant votre code de fonction (qui doit également contenir le fichier composer.json que vous venez de créer), exécutez la commande suivante :

   composer require google/cloud-functions-framework
   

   Cela ajoute le framework des fonctions à votre fichier composer.json. Cette commande crée également un répertoire vendor/ dans le répertoire de votre code de fonction, qui contient les dépendances.

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

Compiler et tester en local

Une fois que vous avez suivi les étapes de la section Spécifier des dépendances, vous pouvez créer et tester votre fonction en local.

La commande suivante crée un serveur Web local exécutant votre fonction helloHttp :

export FUNCTION_TARGET=helloHttp
php -S localhost:8080 vendor/bin/router.php

Cette fonction, si elle a été créée correctement, affiche une URL. Vous pouvez accéder à cette URL (http://localhost:8080/) avec votre navigateur Web. Le message suivant devrait s'afficher : Hello World!.

Vous pouvez également envoyer des requêtes à cette fonction à l'aide de curl à partir d'une autre fenêtre de terminal :

curl localhost:8080
# Output: Hello World!

Déployer la fonction

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

gcloud functions deploy helloHttp --no-gen2 --runtime php83 --trigger-http --allow-unauthenticated

L'option --allow-unauthenticated vous permet d'accéder à la fonction sans authentification. Pour exiger une authentification, omettez cette option.

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

Tester la fonction déployée

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 helloHttp
   

   La fonction devrait ressembler à ceci :

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

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, comme illustré dans cet exemple d'URL :

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

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

Afficher les journaux

Les journaux Cloud Run Functions sont visibles à l'aide de 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 gcloud CLI, exécutez la commande gcloud logs read suivie du nom de la fonction :

gcloud functions logs read helloHttp

La sortie doit ressembler à ceci :

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 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 console Google Cloud.

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