Guide de démarrage rapide de 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. L'ajout de REGION_ID.r dans les URL App Engine est facultatif pour les applications existantes. Il sera bientôt obligatoire pour toutes les applications nouvelles.

Pour assurer une transition en douceur, nous mettons lentement à jour App Engine afin d'utiliser les ID de région. Si nous n'avons pas encore mis à jour votre projet Google Cloud, vous ne verrez pas d'ID de région pour votre application. Étant donné que l'ID est facultatif pour les applications existantes, vous n'avez pas besoin de mettre à jour les URL ni d'effectuer d'autres modifications une fois l'ID de région disponible pour vos applications existantes.

En savoir plus sur les ID de région.

Dans ce guide de démarrage rapide, vous allez apprendre à créer une petite application App Engine permettant d'afficher un court message.

Avant de commencer

Avant d'exécuter et de déployer ce guide de démarrage rapide, installez le SDK Cloud, puis configurez un projet Cloud pour App Engine :

  1. Téléchargez et installez le SDK Cloud :

    Télécharger le SDK

    Remarque : Si le SDK Cloud est déjà installé, mettez-le à jour en exécutant la commande suivante :

    gcloud components update
    
  2. Créez un projet :

    gcloud projects create [YOUR_PROJECT_ID] --set-as-default
    

    Remplacez [YOUR_PROJECT_ID] par une chaîne de caractères qui identifie votre projet de manière unique. Par exemple, my-project-24.

    Vérifiez que le projet a été créé :

    gcloud projects describe [YOUR_PROJECT_ID]
    

    Vous voyez alors les informations relatives au projet qui peuvent se présenter sous la forme suivante :

    createTime: year-month-hour
    lifecycleState: ACTIVE
    name: project-name
    parent:
    id: '433637338589'
    type: organization
    projectId: project-name-id
    projectNumber: 499227785679
    
  3. 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 déployer votre application App Engine.

  4. Assurez-vous que la facturation est activée pour votre projet. Un compte de facturation doit être associé à votre projet pour que l'application puisse être déployée dans App Engine.

    Activer la facturation

    Tant qu'il est actif, le déploiement de votre environnement flexible engendre des coûts. Nettoyez votre projet lorsque vous avez terminé pour éviter des coûts permanents.

  5. Installez les composants requis suivants :

Emplacements 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 dans plusieurs emplacements peut avoir des répercussions sur la latence de votre application, ainsi que sur les tarifs.

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

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

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

Télécharger l'application Hello World

Nous avons créé une application Hello World simple pour Node.js afin que vous puissiez 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 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.

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

    gcloud app browse
    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 Node.js dans l'environnement flexible d'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.

Nettoyer

Afin d'éviter que des frais ne vous soient facturés, vous pouvez supprimer votre projet Cloud pour interrompre la facturation de toutes les ressources utilisées dans le projet.

  1. Dans Cloud Console, accédez à la page Gérer les ressources.

    Accéder à la page Gérer les ressources

  2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer .
  3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

É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. Le SDK Cloud est déjà installé et vous permet d'interagir avec des produits tels que Cloud SQL, Cloud Storage, Firestore, etc.

Pour apprendre pas à pas à créer une application qui utilise l'ensemble de la plate-forme et pas seulement App Engine, accédez à notre guide de démarrage rapide pour créer l'application Bookshelf.

En savoir plus sur l'environnement flexible App Engine

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

Examiner le 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 = 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 de déploiement d'une application :

runtime: nodejs
env: flex

# 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

Ici, le fichier app.yaml spécifie l'environnement d'exécution utilisé par l'application et définit env: flex, qui indique que l'application utilise l'environnement flexible.

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.1",
  "private": true,
  "license": "Apache-2.0",
  "author": "Google Inc.",
  "repository": {
    "type": "git",
    "url": "https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git"
  },
  "engines": {
    "node": ">=8.0.0"
  },
  "scripts": {
    "start": "node app.js",
    "test": "mocha --exit test/*.test.js"
  },
  "dependencies": {
    "express": "^4.16.3"
  },
  "devDependencies": {
    "mocha": "^8.0.0",
    "supertest": "^4.0.2"
  }
}

Ce fichier package.json spécifie que l'application utilise Node.js v8.0.0 ou une version ultérieure, qu'elle dépend de express et que le fichier node app.js permet de démarrer l'application. 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.