Créer et déployer une fonction Cloud Run HTTP à l'aide de Ruby (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 Ruby.

Ce guide vous accompagne tout au long du processus d'écriture d'une fonction Cloud Run à l'aide de l'environnement d'exécution Ruby. 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 Compute Engine.
10. Préparez votre environnement de développement.

    Accéder au guide de configuration Ruby

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 app.rb dans le répertoire helloworld avec le contenu suivant :

   require "functions_framework"
   require "cgi"
   require "json"
   
   FunctionsFramework.http "hello_http" do |request|
     # The request parameter is a Rack::Request object.
     # See https://www.rubydoc.info/gems/rack/Rack/Request
     name = request.params["name"] ||
            (request.body.rewind && JSON.parse(request.body.read)["name"] rescue nil) ||
            "World"
     # Return the response body as a string.
     # You can also return a Rack::Response object, a Rack response array, or
     # a hash which will be JSON-encoded into a response.
     "Hello #{CGI.escape_html name}!"
   end

   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 app.rb. Utilisez l'option --source lorsque vous déployez votre fonction via gcloud pour spécifier un autre répertoire contenant un fichier app.rb.

Spécifier des dépendances

Dans Ruby, les dépendances sont gérées avec bundler et exprimées dans un fichier appelé Gemfile.

Lorsque vous déployez votre fonction, Cloud Run Functions télécharge et installe les dépendances déclarées dans Gemfile et Gemfile.lock à l'aide de bundler.

Le fichier Gemfile répertorie les packages requis par votre fonction, ainsi que les contraintes de version facultatives. Pour une fonction Cloud Run, l'un de ces packages doit être le gem functions_framework.

Pour cet exercice, créez un fichier nommé Gemfile dans le même répertoire que le fichier app.rb contenant le code de votre fonction, avec le contenu suivant :

source "https://rubygems.org"

gem "functions_framework", "~> 0.7"

Exécutez la commande suivante pour installer le gem functions_framework et d'autres dépendances :

bundle install

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

Compiler et tester en local

Avant de déployer la fonction, vous pouvez la créer et la tester localement : Exécutez la commande suivante pour utiliser le fichier exécutable functions-framework-ruby afin de démarrer un serveur Web local exécutant votre fonction hello_http :

bundle exec functions-framework-ruby --target hello_http
# ...starts the web server in the foreground

Si la compilation de la fonction réussit, elle affiche l'URL que vous pouvez consulter dans votre navigateur Web pour voir la fonction en action : http://localhost:8080/. 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!

Consultez également Tester les fonctions dans la documentation sur le framework des fonctions Ruby.

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 ruby33 --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 hello_http
   

   La fonction devrait ressembler à 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

Vous pouvez afficher les journaux Cloud Run Functions dans l'UI de Cloud Logging ou via Google Cloud CLI.

Afficher les journaux à l'aide de l'outil de ligne de commande

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

gcloud functions logs read hello_http

Le résultat 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.

Afficher les journaux dans 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.