Tutoriel Terraform (2e génération)

---

Remarque : Ce contenu ne s'applique qu'à Cloud Functions (2e génération). Pour en savoir plus, consultez la page Comparer les versions de Cloud Functions.

Ce tutoriel explique comment déployer une fonction HTTP en important un fichier ZIP de code source de fonction dans un bucket Cloud Storage, à l'aide de Terraform pour provisionner les ressources. Terraform est un outil Open Source qui vous permet de provisionner des ressources Google Cloud à l'aide de fichiers de configuration déclaratifs.

Ce tutoriel utilise une fonction HTTP Node.js comme exemple, mais il fonctionne également avec les fonctions HTTP Python, Go et Java. Les instructions sont identiques, quel que soit l'environnement d'exécution que vous utilisez.

Objectifs

• Découvrez comment utiliser Terraform pour déployer une fonction HTTP.

Coûts

Dans ce document, vous utilisez les composants facturables suivants de Google Cloud :

• Cloud Functions
• Cloud Build
• Cloud Storage
• Artifact Registry

Pour en savoir plus, consultez la page Tarifs de Cloud Functions.

Obtenez une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût. Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai gratuit.

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.

   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.

   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 Run, Cloud Build, Artifact Registry, and Cloud Storage.

   Activer les API

5. Installez Google Cloud CLI.

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

   gcloud init

7. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   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.

   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 Run, Cloud Build, Artifact Registry, and Cloud Storage.

   Activer les API

10. Installez Google Cloud CLI.

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

    gcloud init

Si la gcloud CLI est déjà installée, mettez-le à jour en exécutant la commande suivante :

gcloud components update

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

    Accéder au guide de configuration de Node.js

Configurer votre environnement

Dans ce tutoriel, vous exécutez des commandes dans Cloud Shell. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé avec des valeurs prédéfinies pour votre projet actuel. L'initialisation de Cloud Shell peut prendre quelques minutes.

Ouvrir Cloud Shell

Préparer l'application

Dans Cloud Shell, procédez comme suit :

1. Clonez le dépôt de l'exemple d'application sur votre instance Cloud Shell:

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

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

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

   L'exemple Node.js utilisé dans ce tutoriel est une fonction HTTP de base "Hello World".

3. Créez un fichier ZIP contenant le code source de la fonction que Terraform importera dans un bucket Cloud Storage:

   zip -r function-source.zip .
   

   Notez que la racine du fichier ZIP doit être le répertoire racine du code source de votre fonction. Par conséquent, la commande ci-dessus inclut les fichiers dans le répertoire helloworldHttp, mais n'inclut pas le répertoire lui-même.

   Remarque: Pour la production, il est recommandé de n'inclure que les fichiers source de fonction nécessaires.

Créer le fichier main.tf

1. Dans le répertoire nodejs-docs-samples/functions/, créez un fichier main.tf pour la configuration Terraform:

   touch main.tf
   

2. Copiez cette configuration Terraform dans votre fichier main.tf:

   terraform {
     required_providers {
       google = {
         source  = "hashicorp/google"
         version = ">= 4.34.0"
       }
     }
   }
   
   resource "random_id" "default" {
     byte_length = 8
   }
   
   resource "google_storage_bucket" "default" {
     name                        = "${random_id.default.hex}-gcf-source" # Every bucket name must be globally unique
     location                    = "US"
     uniform_bucket_level_access = true
   }
   
   data "archive_file" "default" {
     type        = "zip"
     output_path = "/tmp/function-source.zip"
     source_dir  = "functions/hello-world/"
   }
   resource "google_storage_bucket_object" "object" {
     name   = "function-source.zip"
     bucket = google_storage_bucket.default.name
     source = data.archive_file.default.output_path # Add path to the zipped function source code
   }
   
   resource "google_cloudfunctions2_function" "default" {
     name        = "function-v2"
     location    = "us-central1"
     description = "a new function"
   
     build_config {
       runtime     = "nodejs16"
       entry_point = "helloHttp" # Set the entry point
       source {
         storage_source {
           bucket = google_storage_bucket.default.name
           object = google_storage_bucket_object.object.name
         }
       }
     }
   
     service_config {
       max_instance_count = 1
       available_memory   = "256M"
       timeout_seconds    = 60
     }
   }
   
   resource "google_cloud_run_service_iam_member" "member" {
     location = google_cloudfunctions2_function.default.location
     service  = google_cloudfunctions2_function.default.name
     role     = "roles/run.invoker"
     member   = "allUsers"
   }
   
   output "function_uri" {
     value = google_cloudfunctions2_function.default.service_config[0].uri
   }

3. Modifiez le fichier main.tf pour vous assurer qu'il contient les valeurs adéquates pour les éléments suivants. Vous devez modifier ce fichier chaque fois que votre configuration change (par exemple, pour utiliser un environnement d'exécution différent ou déployer une fonction différente):

   • Environnement d'exécution : dans cet exemple, l'environnement d'exécution est nodejs16.
   • Point d'entrée de la fonction : dans cet exemple, le point d'entrée de la fonction est helloHttp.
   • Chemin d'accès au fichier ZIP : dans cet exemple, si vous avez placé votre fichier main.tf dans le répertoire nodejs-docs-samples/functions/ comme décrit ci-dessus, le chemin d'accès est ./helloworld/helloworldHttp/function-source.zip.

Remarque : Le fichier main.tf doit générer de manière fiable un nom de bucket unique chaque fois que vous appliquez la configuration. Toutefois, si le message d'erreur "La ressource existe déjà", vous devez modifier main.tf pour fournir un nom de bucket différent qui sera unique.

Initialiser Terraform

Dans le répertoire nodejs-docs-samples/functions/ contenant votre fichier main.tf, exécutez la commande suivante pour ajouter les plug-ins nécessaires et créer le répertoire .terraform:

terraform init

Appliquer la configuration Terraform

Dans le répertoire nodejs-docs-samples/functions/ contenant votre fichier main.tf, déployez la fonction en appliquant la configuration. Lorsque vous y êtes invité, saisissez yes :

terraform apply

Tester 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 :

   gcloud functions describe function-v2 --gen2 --region=us-central1 --format="value(serviceConfig.uri)"
   

2. Envoyez une requête à cette URL pour afficher le message "Hello World" de votre fonction. Notez que la fonction est déployée en nécessitant une authentification. Par conséquent, vous devez fournir des identifiants dans votre requête:

   curl -H "Authorization: Bearer $(gcloud auth print-identity-token)" YOUR_FUNCTION_URL
   

Remarque : Pour des raisons de sécurité, il est recommandé de demander une authentification pour l'appel de fonctions HTTP. Si vous le souhaitez, vous pouvez activer les appels non authentifiés après le déploiement de la fonction.

Effectuer un nettoyage

Une fois le tutoriel terminé, vous pouvez supprimer tous les éléments que vous avez créés afin d'éviter tous frais supplémentaires.

Terraform vous permet de supprimer toutes les ressources définies dans le fichier de configuration en exécutant la commande terraform destroy dans le répertoire nodejs-docs-samples/functions/ contenant votre fichier main.tf:

terraform destroy

Saisissez yes pour autoriser Terraform à supprimer vos ressources.