DEV Community: Alexandre Chambu

Déployer une application NodeJs sur App Engine

Alexandre Chambu — Tue, 04 Jul 2023 14:37:05 +0000

App Engine est l'un des produits que proposent Google dans la Google Cloud Platform. Il est placé dans la catégorie des services Serverless, du fait qu'il permet de déployer son application sans se soucier de tonne de configurations que l'on fait généralement pour déployer une application.

Je vous recommande de lire cet article avant de continuer, c'est une brève explication de Google Cloud Platform.

Il est important d’ajouter un compte de facturation pour pouvoir utiliser ce produit. Pour le faire, accédez au service Facturation, et suivez les instructions.

Activer l’API App Engine et Créer une application

Ouvrez Google Cloud Platform Console, dans le panneau latéral entrez dans App Engine. Cliquez ensuite sur Activer l’API

Vous pourrez ensuite créer une nouvelle application App Engine dans la GCP Console.

Choisissez le langage à utiliser (Node.js pour JavaScript). L’environnement Standard est moins coûteux, votre application sera mise en veille (0 instance démarrée) en cas de non utilisation. L’environnement Flexible permet de booster les ressources pour les adapter au mieux à l’application, l’application n’est jamais mise en veille (au moins 1 instance en cours, même après plusieurs mois d’inactivité).

Notez qu'à ce niveau il n'y a pas de bouton Enregistrer. L'enregistrement se fera automatiquement lors du déploiement.
Par contre l'on nous propose d'installer le SDK gcloud, c'est la prochaine étape.

Installer SDK gcloud

Le SDK gcloud est une application en ligne de commande qui nous permet d'interagir avec Google Cloud Platform sans passer par la GCP Console (Interface Web). Elle est nécessaire pour déployer votre application Node.js avec App Engine.

Selon votre système, suivez la procédure indiquée ici (Install gcloud CLI).

Sur Ubuntu (version LTS) exécutez ces commandes:

sudo apt-get update

sudo apt-get install apt-transport-https ca-certificates gnupg curl sudo

echo "deb https://packages.cloud.google.com/apt cloud-sdk main" | sudo tee -a /etc/apt/sources.list.d/google-cloud-sdk.list

curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add -

sudo apt-get update && sudo apt-get install google-cloud-cli

Ces commandes installent gcloud et les outils nécessaires à son fonctionnement.

Configurer son déploiement

Pour déployer son application il faut indiquer à gcloud certains détails, notamment le compte Google à utiliser, le projet GCP relié à notre application, ….

Pour notre cas commençons par connecter le compte à gcloud

Connecter son compte à gcloud se fait aussi simplement qu'en une ligne de commande. Dans votre ligne de commande, executez

gcloud auth login

Cette commande ouvre votre navigateur web, il suffit alors de choisir le compte que vous souhaitez connecter et d'accepter les autorisations demandées.

Ensuite connecter un projet GCP à gcloud.

L'étape suivante est d'indiquer à gcloud le projet Google Cloud que l'on va utiliser. Pour cela, executer la commande

gcloud config set projet PROJECT_ID

Remplacer PROJECT_ID par l’identifiant de votre projet. Il peut être trouver dans la GCP Console. Sur l'image le projet Learning Cloud a comme PROJECT_ID learning-cloud-386212

Écrire le fichier app.yaml

Si vous n’avez pas encore d'application, vous pouvez cloner celle-ci sur github: https://github.com/lexnotor/gcloud-dev.git

App engine fournit le port sur lequel votre application peut être démarré, on y accède à partir de process.env.PORT.

App Engine aura besoin de quelques informations (le langage utilisé, …) pour démarrer votre application en ligne. Ces informations sont spécifiées dans un fichier app.yaml et ce fichier est placé à la racine du projet. Ajoutez-le à la racine de votre application.

Voici un exemple du contenue de ce fichier

runtime: nodejs18

# le nom du service, par defaut le nom est default
service: test-deploy

# nombre d'instance maximum
automatic_scaling:
    max_instances: 1

# indique à app engine de diriger tous les paths (URL) vers l'application
handlers:
    - url: /.*
      secure: always
      redirect_http_response_code: 301
      script: auto

# commande pour demarrer son application
entrypoint: "npm run start:prod"

Dans cet exemple:

runtime: indique que l’on utilise la version 18 de Nodejs.
service: indique le nom que l’on souhaite donner à notre service
automatic_scaling: un objet qui indique les paramètres de scalabilité
- max_instances: cette clé indique le nombre maximum d’instance qui seront créées, pour notre petite application une instance suffit.
handlers: un tableau d’objets qui indiquent comment app engine gère les requêtes
- url: les paths d’url que la configuration gère. /.* = tous les paths
- secure: configure l’utilisation de https et http. always = redirige toutes les requêtes vers https
- redirect_http_response_code: le code de statut de la redirection
- script: si auto alors les requêtes sont adressées à l’application
entrypoint: la commande que App engine exécutera pour lancer l’application. Notez que app engine exécute lui même npm build avant cette commande. Pour notre cas, c’est une application NestJs que nous allons déployer.

Déployer

La dernière étape est d'envoyer notre projet sur Google Cloud, encore là gcloud nous facilite grandement la tâche en une commande.

gcloud app deploy

Cette commande envoi l'ensemble de vos code dans le cloud, et déploie l'application.

Pour voir le lien du déploiement, rendez-vous sur la GCP Console, dans le service App Engine.

Félicitations vous venez de déployer une application NodeJs sur Google Cloud Platform via App Engine. Notez qu'il ne s'agit pas de la seule façon de le faire.

Alexandre Chambu

Utiliser Google Cloud Platform

Alexandre Chambu — Mon, 03 Jul 2023 22:58:02 +0000

Le Cloud

Quid ?

Le cloud est compris comme un ensemble d’outils sur internet que l’on peut louer. Ces outils sont censés fournir des ressources adaptées au déploiement de n’importe quelle application. Nous pouvons l’imaginer comme des ordinateurs virtuels dont les capacités de la RAM, du Disque et du Processeur peuvent s’adapter en fonction de nos besoins.

Avantages

Les services cloud sont généralement utilisés pour les raisons:

La flexibilité: un service peut être loué pendant le temps dont nous avons besoin, plutôt que d’acheter des ordinateurs surpuissants pour les utiliser une seule fois.
la scalabilité: les ressources peuvent être étendues au fur et à mesure que l’on en a besoin.
la bande passante: les services cloud sont généralement interconnectés, avec des grands débit de transfert de données entre eux.
les services divers: la plupart des cloud providers vont offrir des services divers comme la reconnaissance d’image, …
…

Services Google Cloud

Le cloud de Google propose plus de 150 produits et services, que nous pouvons essentiellement classer en plusieurs types:

Type Compute: Nous retrouvons un ensemble des services qui vous louent une machine (virtuelle) avec différents niveaux de contrôle. Par exemple, le produit Compute Engine propose un ordinateur complet que vous utilisez comme bon vous semble, le produit Cloud Run vous permet d'exécuter des conteneurs Docker, avoir un contrôle dessus et laisser Google géré la configuration de l'ordinateur, le produit App Engine vous permet exécuter votre application sans se souciez de la configuration de l'environnement, Google se charge de la containérisation et autre configuration pour vous, le produit Cloud Function vous permet d’exécuter des petits bout de code, ...
Type Network:Pour géré la configuration de votre réseau, l’interconnexion de vos applications, ... Nous trouvons les produits comme Cloud Virtual Network, Cloud DNS, Cloud CDN, ...
Type Storage: Pour le stockage de données (Base de donnée, fichiers, ...). Comme exemple Cloud Storage, Cloud SQL, Cloud Datastore, Cloud BigTable, ...
Type Big Data: Pour la gestion de très grandes quantités de données, à l'ordre de Terabytes
Type Analytics:
Type AI: Produits fournissant des très grandes puissances Machine Learning, pour des opérations nécessitant des Tensor Process Unit adaptés. Comme exemple: Cloud Machine Learning, Vision API, Translate API, Natural Language API, ...

Google Cloud Platform

Google cloud permet de gérer l'espace cloud de deux façons; en utilisant, soit son interface web (Google Cloud Platform Console), soit son l'application en ligne de commande gcloud.
L'interface Web est plus adaptée pour démarrer avec Google Cloud.

Accéder à la console (GCP console)

Ouvrez la page Google Cloud Platform, et cliquer sur console en haut à droite de la page.

Créer un projet

Vous aurez besoin d'un projet, pour utiliser les services Cloud.
Sur la page qui s'ouvre, cliquer sur Nouveau projet. Vous pourrez ensuite saisir le nom du projet que vous souhaitez. Je suis très inspiré, appelons notre porjet Learning Cloud. Vous pouvez laissez le champ zone comme tel. Finalement cliquez sur CRÉER.

La page qui s’ouvre affiche les informations sur votre projet (Principalement les produits cloud que vous avez activé dans ce projet).

Utiliser les API

Les produits dans la GCP Console sont des API que vous pouvez activer. Pour activer un produit (une API) , ouvrez le menu latéral gauche, ensuite sélectionnez un produit que vous voulez utiliser.

Voici un exemple du produit Kubernetes Engine API

Dans des prochains articles, nous montrerons comment utiliser certains de ces produits.

Déployer une application Node.Js sur App Engine

Écrire un fichier README.md

Alexandre Chambu — Tue, 06 Jun 2023 09:55:40 +0000

Tout projet de programmation structuré en fichier est sensé avoir un fichier spécial qui documente la structure du projet. Ce fichier contient tout ce qu’il y a à connaître sur le projet, notamment comment l’installer ou l’exécuter, les ressources à consulter en cas de problèmes et tout un tas d’autres informations essentielles. Sur Github, un fichier readme peut aussi être utilisé pour personnaliser son profil.

Le fichier est écrit en markdown, qui est une syntaxe simplifiée du langage HTML. Le markdown respecte un certain nombre de règles pour formater le texte. On a ainsi la possibilité d’insérer une image, de spécifier un titre, d’inserer un bout de code,…

Nous allons écrire ensemble un fichier readme de l’application https://chatbux.vercel.app. Nous utiliserons pour cela l’éditeur de texte VS Code.

Décrivez brièvement votre projet

Au début de notre fichier, il est toujours intéressant d’avoir un bref aperçu de l’ensemble du projet. Pour notre cas nous ajoutons le nom du projet, un logo et un petit texte. Nous en profitons aussi pour montrer que certaines balises HTML sont aussi utilisables.

Ajoutons un blockquote, insérer avec le signe > en début de ligne. C’est sera une remarque sur la gestion des utilisateurs.

Indiquez comment utiliser votre projet

Dans le cas d’une application que l’on peut télécharger et installer, ajoutez une section montrant la procédure complète. Pour ajouter un titre on utilisera le signe # au début de la ligne. À noter qu’il existe 6 niveaux de titre, du plus important (avec un seul # au début de la ligne) au moins important (avec six ######au début de ligne).

Pour installer l’application sur son PC, on commence par télécharger son code source avec git dans un dossier. Il s’agit de plusieurs étape à suivre, nous optons pour l’utilisation d’une liste à puces (non ordonné). Pour ce faire, les éléments de la liste commencent par un signe étoile *, et sont séparés par une ligne vide.

Il est aussi possible d’utiliser une liste numérotée (ordonnée), il faudrait dans ce cas commencer chaque ligne par un numéro suivi d’un point (1. Bonjour, 2. Bonsoir, 3., ...).

Sur l’image précédente, remarquez l’insertion de bout de code (coloré). On les insère en utilisant trois backticks (` ` ` const nom = "Jean" ` ` `). Ils délimitent le code, c’est à dire qu’il en faut trois au début et trois autres à la fin du code. Au niveau des backticks ouvrant, il est conseillé de mettre le nom du langage (javascript, html, ruby, java, perl, ...) utilisé, ici nous avons indiqué le bash (pour le shell).

Indiquons ensuite comment configurer notre application enfin de terminer son installation, avant de l’executer. Pour cela il faudra écrire la configuration dans le fichier .env, se trouvant à la racine des répertoires backend et frontend.

Nous souhaitons que le nom du fichier soit en gras. En markdown, on entoure le texte voulu avec des astérisques doubles (**text en gras**).

Attention👌, si vous mettez un seul astérisque, le texte ne sera plus en gras, mais plutôt en italique (*texte en italique*).

Indiquez comment lancer votre application🤖

C’est certainement l’étape la plus importante. Il ne sert à rien d’avoir une application qui ne fonctionne pas. L’utilisateur qui voudra exécuter votre application doit savoir comment s’y prendre ! Malgré que les standards nous pousserons à faire un npm start à la racine du projet😉.

Ajoutons alors une section Exécution dans notre fichier. Pour notre cas il s’agit d’une application FullStack (Backend & Frontend), il faut dont 2 étapes pour lancer le projet. Nous utilisons encore une liste ici.

Ajouter des sections facultatives

Un readme n’est pas sensé avoir uniquement ces 2 sections, vous pouvez en mettre au tant que vous le souhaitiez, mais n’oubliez pas, seulement les plus importants et nécessaires✨ !

Voici quelques exemples des sections utiles:

Contributions
Ressources
Licence
Get in contact
…

Ajoutons pour notre exemple, une section Ressources. Elle contiendra des liens vers les documentations utiles à consulter pour en connaître plus sur les technologies utilisées.

Pour insérer un lien, on combine les crochets suivis des parenthèses. Les crochets contiendrons le texte à afficher et les parenthèses contiendrons les liens ([Cliquez ici](http://google.com)).

Conclusion

je suis content de partager avec vous, une autre connaissance que j’estime importante dans la communauté de développeurs. Tomber sur un code ou un projet impossible à comprendre n’est jamais une bonne expérience.

Ajoutez toujours un petit fichier readme dans votre répertoire peut aider à comprendre tout un projet en quelques minutes 👌.

Vous retrouvez le rendu final de l’exercice sur github.com/lexnotor.

Excellente suite dans votre travail.