Créer une fonction Cloud à l'aide de la Google Cloud CLI

Cette page explique comment créer et déployer une fonction Cloud 2e génération à l'aide de la CLI Google Cloud.

Avant de commencer

  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. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  4. Activer les API Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Logging.

    Activer les API

  5. Installez Google Cloud CLI.

  6. Pour initialiser gcloudCLI, exécutez la commande suivante : 

    gcloud init
    7.

  7. 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

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

  9. Activer les API Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, and Logging.

    Activer les API

  10. Installez Google Cloud CLI.

  11. Pour initialiser gcloudCLI, exécutez la commande suivante : 

    gcloud init
    12.

    Vous avez besoin d'une invite de commande ? Vous pouvez utiliser Google Cloud Shell. Google 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.

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

Obtenir l'exemple de code

  1. Clonez l'exemple de dépôt sur votre ordinateur local :

    Node.js

    git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git

    Vous pouvez également télécharger l'exemple en tant que fichier ZIP et l'extraire.

    Python 

    git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git

    Vous pouvez également télécharger l'exemple en tant que fichier ZIP et l'extraire.

    Go 

    git clone https://github.com/GoogleCloudPlatform/golang-samples.git

    Vous pouvez également télécharger l'exemple en tant que fichier ZIP et l'extraire.

    Java

    git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git

    Vous pouvez également télécharger l'exemple en tant que fichier ZIP et l'extraire.

    C# 

    git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git

    Vous pouvez également télécharger l'exemple en tant que fichier ZIP et l'extraire.

    Ruby 

    git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git

    Vous pouvez également télécharger l'exemple en tant que fichier ZIP et l'extraire.

    PHP 

    git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git

    Vous pouvez également télécharger l'exemple en tant que fichier ZIP et l'extraire.

  2. Accédez au répertoire qui contient l'exemple de code de Cloud Functions :

    Node.js

    cd nodejs-docs-samples/functions/helloworld/helloworldGet/

    Python 

    cd python-docs-samples/functions/helloworld/

    Go 

    cd golang-samples/functions/functionsv2/helloworld/

    Java 

    cd java-docs-samples/functions/helloworld/helloworld/

    C# 

    cd dotnet-docs-samples/functions/helloworld/HelloWorld/

    Ruby 

    cd ruby-docs-samples/functions/helloworld/get/

    PHP 

    cd php-docs-samples/functions/helloworld_get/

  3. Consultez l'exemple de code :

    Node.js 

    const functions = require('@google-cloud/functions-framework');

// Register an HTTP function with the Functions Framework that will be executed
// when you make an HTTP request to the deployed function's endpoint.
functions.http('helloGET', (req, res) => {
  res.send('Hello World!');
});

    Python 

    import functions_framework
@functions_framework.http
def hello_get(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>.
    Note:
        For more information on how Flask integrates with Cloud
        Functions, see the `Writing HTTP functions` page.
        <https://cloud.google.com/functions/docs/writing/http#http_frameworks>
    """
    return "Hello World!"

    Go 

    
// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"fmt"
	"net/http"

	"github.com/GoogleCloudPlatform/functions-framework-go/functions"
)

func init() {
	functions.HTTP("HelloGet", helloGet)
}

// helloGet is an HTTP Cloud Function.
func helloGet(w http.ResponseWriter, r *http.Request) {
	fmt.Fprint(w, "Hello, World!")
}

    Java 

    
package functions;

import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.BufferedWriter;
import java.io.IOException;

public class HelloWorld implements HttpFunction {
  // Simple function to return "Hello World"
  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    BufferedWriter writer = response.getWriter();
    writer.write("Hello World!");
  }
}

    C# 

    using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;

namespace HelloWorld;

public class Function : IHttpFunction
{
    public async Task HandleAsync(HttpContext context)
    {
        await context.Response.WriteAsync("Hello World!");
    }
}

    Ruby 

    require "functions_framework"

FunctionsFramework.http "hello_get" do |_request|
  # The request parameter is a Rack::Request object.
  # See https://www.rubydoc.info/gems/rack/Rack/Request

  # 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 World!"
end

    PHP 

    
use Psr\Http\Message\ServerRequestInterface;

function helloGet(ServerRequestInterface $request): string
{
    return 'Hello, World!' . PHP_EOL;
}

Déployer la fonction

Pour déployer la fonction avec un déclencheur HTTP, exécutez la commande suivante dans le répertoire contenant l'exemple de code (ou, dans le cas de Java, le fichier pom.xml) :

Node.js 

gcloud functions deploy nodejs-http-function \
--gen2 \
--runtime=nodejs20 \
--region=REGION \
--source=. \
--entry-point=helloGET \
--trigger-http

Utilisez l'option --runtime pour spécifier l'ID d'exécution d'une version Node.js compatible pour exécuter votre fonction.

Python 

gcloud functions deploy python-http-function \
--gen2 \
--runtime=python312 \
--region=REGION \
--source=. \
--entry-point=hello_get \
--trigger-http

Utilisez l'option --runtime pour spécifier l'ID d'exécution d'une version Python compatible pour exécuter votre fonction.

Go 

gcloud functions deploy go-http-function \
--gen2 \
--runtime=go121 \
--region=REGION \
--source=. \
--entry-point=HelloGet \
--trigger-http

Utilisez l'option --runtime pour spécifier l'ID d'exécution d'une version Go compatible pour exécuter votre fonction.

Java

gcloud functions deploy java-http-function \
--gen2 \
--runtime=java17 \
--region=REGION \
--source=. \
--entry-point=functions.HelloWorld \
--memory=512MB \
--trigger-http

Utilisez l'option --runtime pour spécifier l'ID d'exécution d'une version Java compatible pour exécuter votre fonction.

C# 

gcloud functions deploy csharp-http-function \
--gen2 \
--runtime=dotnet6 \
--region=REGION \
--source=. \
--entry-point=HelloWorld.Function \
--trigger-http

Utilisez l'option --runtime pour spécifier l'ID d'exécution d'une version .NET compatible pour exécuter votre fonction.

Ruby 

gcloud functions deploy ruby-http-function \
--gen2 \
--runtime=ruby32 \
--region=REGION \
--source=. \
--entry-point=hello_get \
--trigger-http

Utilisez l'option --runtime pour spécifier l'ID d'exécution d'une version Ruby compatible pour exécuter votre fonction.

PHP 

gcloud functions deploy php-http-function \
--gen2 \
--runtime=php82 \
--region=REGION \
--source=. \
--entry-point=helloGet \
--trigger-http

Utilisez l'option --runtime pour spécifier l'ID d'exécution d'une version PHP compatible pour exécuter votre fonction.

Vous pouvez éventuellement utiliser l'option --allow-unauthenticated pour accéder à la fonction sans authentification. Cela est utile pour les tests, mais nous vous déconseillons d'utiliser ce paramètre en production, sauf si vous créez une API ou un site Web public. En outre, il est possible que ce paramètre ne soit pas adapté aux paramètres de vos règles d'entreprise. Pour savoir comment appeler une fonction nécessitant une authentification, consultez la page Authentification pour l'appel.

Régions

Vous devez indiquer une région lorsque vous déployez une fonction de 2e génération. Pour obtenir la liste des régions disponibles, consultez la section Emplacements. Votre configuration gcloud CLI est associée à une région par défaut, mais vous pouvez utiliser n'importe quelle région compatible avec la commande deploy.

Pour afficher la région par défaut associée à votre configuration gcloud CLI, exécutez la commande suivante :

gcloud config list

Vous pouvez modifier votre région par défaut à l'aide de la commande suivante :

gcloud config set functions/region REGION

Notez que même si vous déployez votre fonction dans la région par défaut, vous devez tout de même inclure la région dans votre ligne de commande deploy.

Déclencher la fonction

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

    Node.js

    gcloud functions describe nodejs-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

    Python 

    gcloud functions describe python-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

    Go 

    gcloud functions describe go-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

    Java 

    gcloud functions describe java-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

    C# 

    gcloud functions describe csharp-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

    Ruby 

    gcloud functions describe ruby-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

    PHP 

    gcloud functions describe php-http-function --gen2 --region REGION --format="value(serviceConfig.uri)"

  2. Après avoir modifié la commande suivante pour utiliser votre propre URI, exécutez-la pour afficher un message Hello World! :

    curl -m 70 -X POST URI \
    -H "Authorization: Bearer $(gcloud auth print-identity-token)" \
    -H "Content-Type: application/json" \
    -d '{}'

Supprimer une fonction Cloud Functions

Pour supprimer la fonction Cloud Functions que vous avez créée dans ce tutoriel, exécutez la commande suivante :

Node.js

gcloud functions delete nodejs-http-function --gen2 --region REGION

Python 

gcloud functions delete python-http-function --gen2 --region REGION

Go 

gcloud functions delete go-http-function --gen2 --region REGION

Java 

gcloud functions delete java-http-function --gen2 --region REGION

C# 

gcloud functions delete csharp-http-function --gen2 --region REGION

Ruby 

gcloud functions delete ruby-http-function --gen2 --region REGION

PHP 

gcloud functions delete php-http-function --gen2 --region REGION

Vous pouvez également supprimer des fonctions Cloud Functions à partir de Google Cloud Console.

Étapes suivantes