Créer et déployer une fonction avec Cloud Code pour VS Code

Cette page explique comment créer, télécharger, déployer et appeler une fonction HTTP de 2e génération à l'aide de Cloud Functions avec Cloud Code.

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.

    Go to project selector

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

  4. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, Logging, and Pub/Sub APIs.

    Enable the APIs

    5.

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

    Go to project selector

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

  7. Enable the Cloud Functions, Cloud Build, Artifact Registry, Cloud Run, Logging, and Pub/Sub APIs.

    Enable the APIs

    8.
  8. Installez Git. Git est nécessaire pour copier des exemples sur votre ordinateur.
  9. Installez le plug-in Cloud Code si ce n'est pas déjà fait.

Créer une fonction

Si vous avez déjà créé une fonction, vous pouvez télécharger une fonction existante dans un nouvel espace de travail et la modifier localement.

Pour créer une fonction à l'aide d'un exemple, procédez comme suit :

  1. Cliquez sur Cloud Code, puis développez la section Cloud Functions.

  2. Cliquez sur Ajouter Créer une fonction, puis sélectionnez un modèle.

  3. Accédez au chemin d'accès dans lequel vous souhaitez créer votre fonction, saisissez un nom pour la fonction, puis sélectionnez Créer une application.

    Si le dossier de votre application n'apparaît pas automatiquement dans l'explorateur, cliquez sur Actualiser.

    Le fichier launch.json contient les configurations requises pour votre fonction:

    {
  "configurations": [
    {
      "name": "Deploy Cloud Function",
      "type": "cloudcode.cloudfunctions",
      "request": "launch",
      "functionName": "function-hello-world",
      "gen": "GEN_2",
      "entryPoint": "helloHttp",
    }
  ]
}

Pour en savoir plus sur la création de plusieurs fonctions dans un même espace de travail, consultez la section Gérer les fonctions dans un espace de travail VS Code.

Télécharger une fonction existante dans un nouvel espace de travail

Pour télécharger une fonction dans un nouvel espace de travail, procédez comme suit:

  1. Cliquez sur Cloud Code, puis développez la section Cloud Functions.

  2. Développez l'extrait de votre Google Cloud projet, effectuez un clic droit sur la fonction que vous souhaitez télécharger, puis sélectionnez Télécharger dans un nouvel espace de travail.

  3. Lorsque vous y êtes invité, saisissez un nom pour la nouvelle application, puis cliquez sur Créer une application.

    Cette opération télécharge votre fonction sur votre ordinateur local et l'ouvre dans un nouvel espace de travail dans votre IDE.

Déployer une fonction

Pour déployer une fonction, procédez comme suit :

  1. Effectuez un clic droit sur une fonction, puis sélectionnez Déployer la fonction.

  2. Dans le menu proposé, sélectionnez un Google Cloud projet sur lequel déployer votre fonction.

  3. Sélectionnez la région dans laquelle la fonction sera déployée.

  4. Sélectionnez un environnement d'exécution.

    Le déploiement de la fonction peut prendre quelques minutes. Pendant l'exécution, un indicateur de progression progress_activity s'affiche. Une fois l'opération terminée, une coche check_circle s'affiche. Si l'opération échoue, un point d'exclamation s'affiche.

    Si le déploiement échoue, consultez l'onglet Sortie pour afficher le message d'erreur. Cliquez sur le lien pour accéder aux journaux de compilation dans la console Google Cloud et obtenir plus de détails sur l'erreur.

    Message d'erreur affiché

  5. Facultatif: Une fois la fonction déployée, vous pouvez effectuer les actions suivantes:

    • Pour afficher les fichiers en lecture seule de votre fonction déployée, développez la fonction, puis le dossier Code source. Vous pouvez alors afficher launch.json sous .vscode, le code déployé et package.json.

    • Pour afficher la fonction dans la console Google Cloud, effectuez un clic droit sur la fonction et sélectionnez Ouvrir dans la console Cloud. Si vous y êtes invité, sélectionnez Ouvrir.

    • Pour modifier les métadonnées de votre fonction, effectuez un clic droit sur la fonction et sélectionnez Modifier les métadonnées dans la console Cloud.

    • Pour afficher les journaux de la fonction déployée, effectuez un clic droit sur la fonction et sélectionnez Afficher les journaux.

Appeler une fonction

L'appel d'une fonction vous permet d'exécuter la fonction déployée dans la console Google Cloud à partir du terminal intégré de l'IDE. Pour appeler une fonction, procédez comme suit:

  1. Effectuez un clic droit sur la fonction et sélectionnez Appeler la fonction via HTTP.

  2. Dans le menu Quickpick Déclencher la fonction via HTTP qui s'affiche, sélectionnez l'une des deux options suivantes:

    • Par défaut: un terminal s'ouvre dans l'IDE et exécute une commande pour exécuter la fonction dans Google Cloud.

    • Importer des arguments à partir d'un fichier JSON: cette option prend le contenu du fichier JSON sélectionné, le convertit en chaîne et le transmet avec -d '{. Cette option est utile lorsque vous avez une entrée pour vos fonctions et que vous souhaitez l'enregistrer, ce qui vous permet de l'exécuter sans avoir à la retaper plusieurs fois.

Étape suivante

Obtenir de l'aide

Pour envoyer vos commentaires, signalez tout problème sur GitHub ou posez une question sur Stack Overflow.