Créer une application Node.js dans l'environnement flexible App Engine

Créer une application Node.js dans l'environnement flexible App Engine

ID de la région

Le REGION_ID est un code abrégé que Google attribue en fonction de la région que vous sélectionnez lors de la création de votre application. Le code ne correspond pas à un pays ou une province, même si certains ID de région peuvent ressembler aux codes de pays et de province couramment utilisés. Pour les applications créées après février 2020, REGION_ID.r est inclus dans les URL App Engine. Pour les applications existantes créées avant cette date, l'ID de région est facultatif dans l'URL.

En savoir plus sur les ID de région

OK

Dans ce guide de démarrage rapide, vous allez apprendre à créer et à déployer une application permettant d'afficher un court message. L'exemple d'application utilise la dernière version de Node.js. Vous pouvez utiliser ce même exemple de code indifféremment pour Node.js 18 et ses versions ultérieures, en spécifiant le numéro de version dans votre fichier app.yaml.

L'exemple de code pour Node.js 16 et versions antérieures est disponible sur GitHub.

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

   Enable the API

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

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

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

9. Enable the Cloud Build API.

   Enable the API

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

Conditions préalables supplémentaires

1. Initialisez votre application App Engine avec votre projet, puis choisissez sa région :

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   Lorsque vous y êtes invité, sélectionnez la région dans laquelle vous souhaitez localiser votre application App Engine.

   Attention : Une fois la région d'une application définie, vous ne pouvez plus la modifier.

2. Installez les composants requis suivants :

   • Téléchargez et installez Git.
   • Préparez votre environnement pour un développement en Node.js.

Zones App Engine

App Engine est régional, ce qui signifie que l'infrastructure qui exécute vos applications est située dans une région spécifique, et que Google la gère de sorte qu'elle soit disponible de manière redondante dans toutes les zones de cette région.

Lors de la sélection d'une région dans laquelle exécuter vos applications, vous devez tout d'abord considérer vos exigences en matière de latence, de disponibilité et de durabilité. Vous pouvez généralement sélectionner la région la plus proche des utilisateurs de votre application, mais pensez aussi aux emplacements où App Engine est disponible ainsi qu'aux emplacements des autres produits et services Google Cloud que votre application utilise. L'utilisation de services situés dans des emplacements différents peut avoir des répercussions sur la latence de votre application, ainsi que sur les tarifs.

Une fois que vous avez défini la région d'une application, vous ne pouvez plus la modifier.

Remarque : Deux emplacements, appelés europe-west et us-central dans les commandes App Engine et dans Google Cloud Console, sont respectivement appelés europe-west1 et us-central1 dans les autres documentations de Google.

Si vous avez déjà créé une application App Engine, vous pouvez afficher sa région en effectuant l'une des opérations suivantes :

• Exécutez la commande gcloud app describe.

• Ouvrez le tableau de bord App Engine dans la console Google Cloud. La région apparaît en haut de la page.

OK

Ce guide de démarrage rapide présente une application Node.js simple, écrite à l'aide du framework Express.js.

Important : Pour une expérience optimale sous Windows, effectuez une mise à niveau vers la dernière version du gestionnaire de packages Node.js (npm) en exécutant npm install -g npm. La dernière version de npm installe des dépendances dans une structure de répertoire horizontale. Il est donc peu probable que les installations entrent en conflit avec la longueur maximale du chemin Windows de 255 caractères. Si vous préférez continuer à utiliser une version plus ancienne de npm, vous pouvez réduire la longueur des chemins en déplaçant votre projet dans le répertoire racine de votre disque, par exemple, C:\.

Télécharger l'application Hello World

Nous avons créé une application Hello World simple pour App Engine afin de vous aider à comprendre rapidement comment déployer une application sur Google Cloud.

1. Clonez le dépôt de l'exemple d'application Hello World sur votre ordinateur.

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

   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.

      cd nodejs-docs-samples/appengine/hello-world/flexible/
   

Exécuter Hello World sur votre ordinateur local

1. Installez les dépendances pour ce projet.

   npm install
   

   Ou si vous utilisez Yarn.

   yarn install
   

2. Exécutez le script de démarrage.

   npm start
   

   Ou si vous utilisez Yarn.

   yarn start
   

3. Affichez l'application dans votre navigateur Web.

   • Si vous utilisez Cloud Shell, cliquez sur Aperçu sur le Web dans la barre d'outils et sélectionnez Prévisualiser sur le port 8080.

   • Si vous n'utilisez pas Cloud Shell, saisissez l'adresse suivante :

   http://localhost:8080

Le message Hello World de l'exemple d'application s'affiche sur la page. Dans votre fenêtre de terminal, appuyez sur Ctrl+C pour quitter le serveur Web.

Déployer et exécuter Hello World sur App Engine

Pour déployer votre application dans l'environnement flexible App Engine, procédez comme suit :

1. Déployez l'application Hello World en exécutant la commande suivante à partir du répertoire hello-world/flexible/ :

   gcloud app deploy

   Obtenez plus d'informations sur les options facultatives.

   Options de commande gcloud courantes

   • Incluez l'option --version pour spécifier un ID qui identifie de manière unique cette version de votre application, sans quoi un ID est généré automatiquement. Exemple : --version [YOUR_VERSION_ID]
   • Incluez l'option --project pour spécifier un ID de projet Google Cloud différent de celui que vous avez initialisé par défaut dans l'outil gcloud. Exemple :--project [YOUR_PROJECT_ID]

   Exemple :

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   Pour en savoir plus sur le déploiement de votre application à partir de la ligne de commande, consultez la section Tester et déployer votre application. Pour obtenir la liste de toutes les options de commande, consultez la documentation de référence gcloud app deploy.

   OK
   Remarque : Pendant le déploiement, la commande npm install est utilisée par défaut pour installer des dépendances, sauf si un fichier yarn.lock existe et qu'il ne figure pas dans la section skip_files du fichier app.yaml, auquel cas la commande yarn install --production est utilisée. Pour que le build retombe sur la commande npm install, supprimez le fichier yarn.lock ou ajoutez yarn.lock à la section skip_files de votre fichier app.yaml.

2. Lancez votre navigateur pour afficher l'application sur https://PROJECT_ID.REGION_ID.r.appspot.com

   gcloud app browse

   où PROJECT_ID représente l'ID de votre projet Google Cloud.

Cette fois, la page qui affiche le message Hello World est diffusée par un serveur Web exécuté sur une instance App Engine.

Félicitations ! Vous avez déployé votre première application App Engine dans l'environnement flexible App Engine !

Si vous rencontrez des erreurs lors du déploiement de votre application, consultez les conseils de dépannage.

Consultez les sections suivantes pour en savoir plus sur le nettoyage et découvrir les prochaines étapes que vous pourriez effectuer.

Effectuer un nettoyage

Vous pouvez supprimer votre projet Google Cloud. Cette démarche interrompra la facturation de toutes les ressources utilisées dans le projet.

Attention : La suppression d'un projet entraîne les effets décrits ci-dessous :
• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches décrites dans ce document et que vous le supprimez, vous supprimerez également tout autre travail effectué dans le projet.
• Les ID de projets personnalisés sont perdus. Lorsque vous avez créé ce projet, vous avez peut-être créé un ID de projet personnalisé que vous souhaitez utiliser à l'avenir. Pour conserver les URL qui utilisent l'ID de projet, telle qu'une URL appspot.com, supprimez les ressources sélectionnées dans le projet au lieu de supprimer l'ensemble du projet.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Étapes suivantes

Découvrez la plate-forme dans son ensemble

Maintenant que vous savez comment développer et déployer des applications App Engine, vous pouvez explorer le reste de Google Cloud. Google Cloud CLI est déjà installé et vous permet d'interagir avec des produits tels que Cloud SQL, Cloud Storage, Firestore, etc.

Découvrez l'environnement flexible App Engine

Voici quelques articles qui vous aideront à mieux connaître App Engine :

• Présentation d'App Engine
• Routage des requêtes
• Gérer les requêtes
• Gérer les instances

Examen du code Hello World

Hello World est l'application App Engine la plus simple qui soit : elle ne contient qu'un seul service, ne possède qu'une seule version, et tout le code se trouve dans le répertoire racine de l'application. Cette section décrit chacun des fichiers de l'application en détail.

app.js

Le fichier app.js contient le code JavaScript permettant de démarrer un serveur et de répondre aux requêtes.

Le code suivant répond aux requêtes des clients Web en affichant le message "Hello World", via un serveur s'exécutant sur le port 8080.

const express = require('express');

const app = express();

app.get('/', (req, res) => {
  res.status(200).send('Hello, world!').end();
});

// Start the server
const PORT = parseInt(process.env.PORT) || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

app.yaml

Le fichier app.yaml décrit la configuration suivante pour votre application :

• Définit env: flex, qui indique que votre application utilise l'environnement flexible App Engine.

• Spécifie l'environnement d'exécution utilisé par l'application.

  runtime: nodejs
  env: flex
  runtime_config:
    operating_system: ubuntu22
  # This sample incurs costs to run on the App Engine flexible environment.
  # The settings below are to reduce costs during testing and are not appropriate
  # for production use. For more information, see:
  # https://cloud.google.com/appengine/docs/flexible/nodejs/configuring-your-app-with-app-yaml
  manual_scaling:
    instances: 1
  resources:
    cpu: 1
    memory_gb: 0.5
    disk_size_gb: 10
  

  • Pour en savoir plus sur le fonctionnement de l'environnement d'exécution Node.js, consultez la section Environnement d'exécution Node.js.

  • Pour apprendre à concevoir votre application afin de tirer parti des versions et des services, consultez la page Présentation d'App Engine.

  • Pour en savoir plus sur les paramètres de configuration d'App Engine, consultez la page Configurer une application avec app.yaml.

  package.json

  package.json permet de spécifier les dépendances de l'application, la version du nœud et le démarrage de l'application.

  {
    "name": "appengine-hello-world",
    "description": "Simple Hello World Node.js sample for Google App Engine Flexible Environment.",
    "version": "0.0.2",
    "private": true,
    "license": "Apache-2.0",
    "author": "Google Inc.",
    "repository": {
      "type": "git",
      "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
    },
    "engines": {
      "node": ">=16.0.0"
    },
    "scripts": {
      "start": "node app.js",
      "test": "c8 mocha -p -j 2 --exit test/*.test.js"
    },
    "dependencies": {
      "express": "^4.17.1"
    },
    "devDependencies": {
      "c8": "^8.0.0",
      "mocha": "^10.0.0",
      "supertest": "^6.0.0"
    }
  }
  

  Dans l'exemple précédent, le fichier package.json spécifie que l'application utilise Node.js version 18 ou ultérieure et dépend du framework Express. Pour plus d'informations sur l'installation et l'exécution de votre application, consultez la documentation de l'environnement d'exécution Node.js.