Votre première fonction : Ruby

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

  • 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 Cloud Pub/Sub ou les modifications apportées à un bucket Cloud Storage.

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

Structure du guide

  1. Créer un projet GCP avec le SDK Cloud
  2. Créer une fonction
  3. Spécifier des dépendances
  4. Créer et tester en local
  5. Déployer la fonction
  6. Tester la fonction déployée

Créer un projet GCP avec le SDK Cloud

  1. 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 gratuits pour exécuter, tester et déployer des charges de travail.
  2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activer les API Cloud Functions and Cloud Build.

    Activer les API

  5. Installez et initialisez le SDK Cloud.
  6. Mettez à jour et installez les composants gcloud :
    gcloud components update
  7. 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"] ||
             (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!".

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 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 Functions, 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

Créer 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 d'alimenter 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!

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 --runtime ruby26 --trigger-http --allow-unauthenticated

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

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
    

    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

Utiliser l'outil de ligne de commande

Les journaux des fonctions Cloud sont visibles dans l'UI de Cloud Logging et via l'outil de ligne de commande gcloud.

Pour afficher les journaux de votre fonction à l'aide de l'outil gcloud, 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      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

Utiliser le tableau de bord Logging

Vous pouvez également consulter les journaux des fonctions Cloud Functions depuis Cloud Console.