Premiers pas avec Ruby

Ce tutoriel s'adresse à ceux qui débutent dans la création d'applications sur le cloud, tels que les ingénieurs et les développeurs Web, et qui souhaitent connaître les concepts clés du développement d'applications sur Google Cloud.

Objectifs

• Découvrir les outils Google Cloud de base, tels que Google Cloud Console et gcloud
• Déployer votre application dans l'environnement standard App Engine
• Faire persister vos données avec Cloud Firestore
• Stocker des fichiers importés dans Cloud Storage
• Surveiller votre application à l'aide de la suite Google Cloud Operations

Coûts

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

• App Engine
• Cloud Storage
• Firestore
• Suite Google Cloud Operations

Les instructions de ce document sont conçues pour que votre utilisation des ressources respecte les limites du niveau Toujours gratuit de Google Cloud. 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.

Une fois que vous avez terminé les tâches décrites dans ce document, vous pouvez éviter de continuer à payer des frais en supprimant les ressources que vous avez créées. Pour en savoir plus, consultez la section Effectuer un nettoyage.

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

5. Vérifiez que la facturation est activée pour votre projet Google Cloud.

6. Pour créer une base de données Firestore en mode natif, effectuez la procédure suivante :
   1. Dans Google Cloud Console, accédez à la page Lecteur Firestore.
      Accéder au lecteur Firestore
   2. Sur l'écran Sélectionner un mode Cloud Firestore, cliquez sur Sélectionner le mode natif.
   3. Sélectionnez un emplacement pour votre base de données Firestore. Ce paramètre d'emplacement correspond à l'emplacement par défaut des ressources Google Cloud de votre projet Cloud. Cet emplacement est utilisé pour les services Google Cloud exploités dans votre projet Cloud qui requièrent un paramètre d'emplacement, plus précisément le bucket Cloud Storage par défaut et l'application App Engine.
      Avertissement : Une fois que vous avez défini l'emplacement par défaut des ressources pour votre projet Cloud, vous ne pouvez plus le modifier.
   4. Cliquez sur Create Database (Créer une base de données).

7. Activer les API App Engine Admin, Cloud Storage, Cloud Logging, and Error Reporting.

   Activer les API

8. Clonez l'exemple de dépôt et ouvrez l'exemple d'application dans Cloud Shell :
   Accéder à Cloud Shell

   Cloud Shell vous permet d'accéder en ligne de commande à vos ressources Google Cloud, directement depuis votre navigateur.

9. Pour télécharger l'exemple de code et accéder au répertoire de l'application, cliquez sur Continuer.

10. Dans Cloud Shell, configurez l'outil gcloud pour qu'il utilise votre nouveau projet Google Cloud :

    # Configure gcloud for your project
    gcloud config set project PROJECT_ID
    

    Remplacez PROJECT_ID par l'ID du projet Google Cloud que vous avez créé à l'aide de Google Cloud Console.

    Google Cloud CLI est le principal moyen d'interagir avec vos ressources Google Cloud depuis la ligne de commande. Dans ce tutoriel, vous utilisez l'outil gcloud pour déployer et surveiller votre application.

Exécuter l'application

1. Installez les dépendances de l'application à l'aide de bundler :

   bundle install
   

2. Exécutez le serveur rails :

   GOOGLE_CLOUD_PROJECT=PROJECT_ID bundle exec rails server -p 8080
   

   Remplacez PROJECT_ID par l'ID du projet Google Cloud que vous avez créé.
3. Dans Cloud Shell, cliquez sur Aperçu sur le Web, puis sélectionnez Prévisualiser sur le port 8080. Une nouvelle fenêtre s'affiche avec votre application en cours d'exécution.

Déployer votre application sur App Engine

Google Cloud permet d'exécuter du code de plusieurs façons. Dans cet exemple, vous utilisez App Engine pour déployer une application évolutive sur Google Cloud. Grâce à des déploiements ne nécessitant aucune configuration ni aucune gestion de serveur, App Engine vous permet de vous concentrer sur l'écriture du code. De plus, App Engine évolue automatiquement pour gérer les pics de trafic soudains.

Le fichier app.yaml est le fichier de configuration principal pour le déploiement sur App Engine :

getting-started/bookshelf/app.yaml

Afficher dans GitHub

runtime: ruby25
entrypoint: bundle exec rackup -p $PORT
instance_class: F2

1. Dans la fenêtre de votre terminal, déployez l'application sur App Engine à l'aide de gcloud CLI:

   # on the command-line
   gcloud app deploy
   

2. Dans votre navigateur Web, saisissez l'URL suivante:

   https://PROJECT_ID.REGION_ID.r.appspot.com

   Remplacez les éléments suivants :

   • PROJECT_ID : ID de votre projet Google Cloud.
   • REGION_ID : code attribué par App Engine à votre application
   
   Remarque : Créé automatiquement, ce domaine protégé par SSL est utile pour le développement. Vous pouvez également configurer un domaine personnalisé avec App Engine.

Pour en savoir plus sur le déploiement sur App Engine, consultez la page Environnement d'exécution Ruby 2.5.

Conserver vos données avec Firestore

Vous ne pouvez pas stocker d'informations sur vos instances App Engine, car elles sont perdues si l'instance redémarre et n'existent pas lorsque des instances sont créées. À la place, vous devez utiliser une base de données, sur laquelle vos instances effectuent toutes leurs opérations de lecture et d'écriture.

Google Cloud permet de stocker des données de plusieurs façons. Dans cet exemple, vous utilisez Firestore pour stocker les données de chaque livre. Firestore est une base de données de documents NoSQL entièrement gérée et sans serveur qui permet de stocker et d'interroger des données. Firestore effectue un autoscaling en fonction des besoins de votre application et n'exploite aucune instance lorsque vous ne l'utilisez pas. Ajoutez votre premier livre dès aujourd'hui.

1. Dans votre navigateur Web, saisissez l'URL suivante:

   https://PROJECT_ID.REGION_ID.r.appspot.com

   Remplacez les éléments suivants :

   • PROJECT_ID : ID de votre projet Google Cloud.
   • REGION_ID : code attribué par App Engine à votre application

2. Pour créer un livre à partir de l'application déployée, cliquez sur Add book (Ajouter un livre).

   
3. Dans le champ Title (Titre), saisissez Moby Dick.
4. Dans le champ Author (Auteur), saisissez Herman Melville.

5. Cliquez sur Save (Enregistrer). L'application Bookshelf possède désormais une entrée.

   
6. Dans Google Cloud Console, pour actualiser la page Firestore, cliquez sur Actualiser . Les données s'affichent dans Firestore. L'application Bookshelf stocke chaque livre sous la forme d'un document Firestore ayant un ID unique, et tous ces documents sont stockés dans une collection Firestore. Dans ce tutoriel, la collection s'appelle "books" (livres).

Firestore stocke les livres à l'aide de la bibliothèque cliente Firestore. Voici un exemple de récupération d'un document Firestore :

getting-started/bookshelf/app/models/book.rb

Afficher dans GitHub

require "google/cloud/firestore"
firestore = Google::Cloud::Firestore.new project_id: project_id
@collection = firestore.col "books"

book_snapshot = collection.doc(id).get
Book.from_snapspot book_snapshot if book_snapshot.data

Pour en savoir plus sur l'utilisation de Firestore, consultez l'article Ajouter des données.

Stocker des fichiers importés dans Cloud Storage

Maintenant que vous avez ajouté un livre, vous pouvez ajouter l'image de sa couverture. Vous ne pouvez pas stocker de fichiers sur vos instances. Une base de données n'est pas adaptée aux fichiers image. Utilisez plutôt Cloud Storage.

Cloud Storage est le principal magasin de blobs pour Google Cloud. Vous pouvez utiliser Cloud Storage pour héberger des éléments d'applications que vous voulez partager sur Google Cloud. Pour utiliser Cloud Storage, vous devez créer un bucket Cloud Storage, c'est-à-dire un conteneur de base permettant de conserver vos données.

1. Dans la console Google Cloud, accédez à la page du Navigateur Cloud Storage.

   Accéder à la page du navigateur Cloud Storage

2. Cliquez sur Créer un bucket.
3. Dans la boîte de dialogue Créer un bucket, saisissez le nom du bucket en ajoutant l'ID du projet Google Cloud à la chaîne _bucket. Le nom de votre bucket doit ressembler à ceci : YOUR_PROJECT_ID_bucket. Ce nom doit respecter les exigences concernant les noms de buckets. Vous pouvez conserver les valeurs par défaut de tous les autres champs.
4. Cliquez sur Créer.
5. Une fois le bucket créé, vous devez rendre les objets accessibles publiquement pour que les utilisateurs puissent les afficher. Pour savoir comment procéder, consultez la page Rendre des données publiques.
6. Cliquez sur Edit book (Modifier le livre), puis sélectionnez une image à importer pour sa couverture. Vous pouvez, par exemple, utiliser cette image du domaine public :
   
7. Cliquez sur Enregistrer. Vous êtes redirigé vers la page d'accueil sur laquelle se trouve une entrée de votre application Bookshelf.
   

L'application Bookshelf envoie les fichiers importés vers Cloud Storage à l'aide de la bibliothèque cliente Cloud Storage.

getting-started/bookshelf/app/models/book.rb

Afficher dans GitHub

require "google/cloud/storage"
bucket_id = "#{project_id}_bucket"
storage = Google::Cloud::Storage.new project_id: config["project_id"],
                                     credentials: config["keyfile"]
bucket = storage.bucket bucket_id

Remarque : Vous pouvez modifier le nom du bucket en définissant la variable bucket_id du code précédent sur un autre nom et en redéployant l'application grâce à la commande gcloud app deploy.

Pour en savoir plus sur l'utilisation de Cloud Storage, consultez la liste des guides d'utilisation.

Surveiller votre application à l'aide de la suite Google Cloud Operations

Vous avez déployé votre application, et créé et modifié des livres. Utilisez les outils de gestion des performances des applications pour surveiller ces événements pour vos utilisateurs.

Surveiller les journaux à l'aide de Cloud Logging

console Google Cloud

1. Dans le navigateur, accédez à l'URL /logs dans l'application :

   https://PROJECT_ID.REGION_ID.r.appspot.com/logs

   Cette action entraîne l'envoi d'une entrée personnalisée à Cloud Logging. Cette entrée présente un niveau de gravité d'entrée de journal NOTICE et contient le message "Hey, you triggered a custom log entry. Good job!" (Vous avez déclenché une entrée de journal personnalisée. Félicitations !).

2. Accédez à la visionneuse de journaux pour surveiller votre application en temps réel. Lorsqu'un problème survient, ayez le réflexe de la consulter.
   
3. Dans la liste déroulante des ressources, sélectionnez GAE Application.
4. Dans la liste déroulante des journaux, sélectionnez Tous les journaux.

   Une ligne concerne votre entrée de journal personnalisée.

   

gcloud

1. Dans votre fenêtre de terminal, utilisez Google Cloud CLI pour surveiller les journaux de votre application en écoutant les nouvelles entrées de journal:

   gcloud app logs tail

2. Dans le navigateur, accédez à l'URL /logs dans l'application :

   https://PROJECT_ID.REGION_ID.r.appspot.com/logs

   Cette action entraîne l'envoi d'une entrée personnalisée à Cloud Logging. Cette entrée présente un niveau de gravité d'entrée de journal NOTICE et contient le message "Hey, you triggered a custom log entry. Good job!" (Vous avez déclenché une entrée de journal personnalisée. Félicitations !).

   Le résultat de la commande gcloud contient la nouvelle entrée de journal :

   Waiting for new log entries...
   2019-03-27 22:17:01 default[20190327t151430]  "Hey, you triggered a custom log entry. Good job!"
   

Surveiller les erreurs à l'aide d'Error Reporting

1. Dans Google Cloud Console, accédez à la page Error Reporting.
   Accéder à la page Error Reporting
   Error Reporting met en évidence les erreurs et les exceptions dans votre application, et vous permet de configurer des alertes à leur sujet.
2. Dans le navigateur, accédez à l'URL /errors dans l'application.
   

   https://PROJECT_ID.REGION_ID.r.appspot.com/errors

   Vous générez ainsi une nouvelle exception de test, qui est envoyée à la suite pour les opérations de Google Cloud.

3. Dans Google Cloud Console, revenez à la page Error Reporting. La nouvelle erreur s'affiche après quelques instants. Cliquez sur Actualisation automatique pour ne pas avoir à actualiser la page manuellement.

   

Remarque : La gestion des performances des applications contient de nombreux outils qui vous permettent de déboguer et de surveiller vos applications. Pour en savoir plus, consultez les tutoriels.

Effectuer un nettoyage

Pour éviter que les ressources utilisées lors de ce tutoriel soient facturées sur votre compte Google Cloud, supprimez le projet contenant les ressources, ou conservez le projet et supprimez les ressources individuelles.

Supprimer le projet

Attention : La suppression d'un projet aura les effets suivants :

• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches de ce document, lorsque vous le supprimez, vous supprimez é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.

Si vous envisagez d'explorer plusieurs architectures, tutoriels et guides de démarrage rapide, réutiliser des projets peut vous aider à ne pas dépasser les limites de quotas des projets.

1. Dans la console Google Cloud, 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éployer une application sur Google Kubernetes Engine
• Déployer une application sur Compute Engine
• Gérer les sessions avec Firestore