Exécuter Rails 7 dans l'environnement flexible App Engine

Commencez à développer des applications Ruby on Rails qui s'exécutent dans l'environnement flexible App Engine. Les applications créées sont exécutées sur l'infrastructure sur laquelle sont basés tous les produits Google, vous avez la garantie d'un dimensionnement efficace, à même de desservir l'ensemble de vos utilisateurs, qu'ils soient une poignée ou plusieurs millions.

Dans ce tutoriel, nous partons du principe que vous connaissez bien le développement Web avec Rails. L'objectif est ici de vous guider lors du déploiement d'une nouvelle application Rails.

Ce tutoriel est compatible avec Ruby 3.0 ou une version ultérieure, et il est nécessaire de l'utiliser.

Avant de commencer

Connectez-vous à votre Google Cloud compte. 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 sans frais pour exécuter, tester et déployer des charges de travail.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

1. Installez la Google Cloud CLI.

2. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

3. Pour initialiser la gcloud CLI, exécutez la commande suivante :

   gcloud init

Configurer votre environnement local pour Rails

Pour configurer votre environnement local pour le développement Rails, procédez comme suit :

1. Installez Ruby version 3.0 ou ultérieure.

2. Installez le gem Rails 7.

3. Installez le Bundler gem.

Vous pouvez également utiliser Cloud Shell, qui est déjà installé avec Ruby, Rails et la Google Cloud CLI.

Pour obtenir plus d'informations sur l'installation de Rails et de ses dépendances, reportez-vous au guide officiel Getting started with Rails.

Une fois les conditions préalables remplies, vous pouvez créer et déployer une application Rails. Les sections suivantes vous guident dans la configuration, l'exécution et le déploiement d'une application.

Créer une application

1. Créez un exemple d'application Rails.

   rails new appengine_example
   

2. Accédez au répertoire qui contient l'exemple de code.

   cd appengine_example
   

Exécuter l'application en local

Pour exécuter la nouvelle application Rails sur votre ordinateur local :

1. Démarrez un serveur Web local :

    bundle exec rails server
   

2. Dans votre navigateur, accédez à http://localhost:3000/.

   L'exemple d'application affiche le logo Rails avec les versions de Rails et de Ruby.

Remarque : Dans la fenêtre de votre terminal, appuyez sur Ctrl+C pour quitter le serveur Web.

Ajouter une page simple

Ajoutez maintenant une page de bienvenue à l'application Rails générée.

1. Pour générer le scaffold d'une nouvelle page, créez un contrôleur Rails nommé WelcomeController avec une action index.

   bundle exec rails generate controller Welcome index
   

2. Ouvrez le fichier app/views/welcome/index.html.erb pour afficher le code HTML réutilisable suivant.

   <h1>Welcome#index</h1>
   <p>Find me in app/views/welcome/index.html.erb</p>

3. Modifiez le fichier comme vous le souhaitez. Par exemple, vous pouvez utiliser le contenu suivant :

   <h1>Welcome</h1>
   <p>This is a home page for a new Rails App on Google Cloud Platform!</p>

4. Définissez l'action de contrôleur index comme action racine pour Rails. Dès lors, chaque fois qu'un utilisateur visite l'application Rails, il voit votre page de bienvenue.

5. Ouvrez le fichier config/routes.rb pour voir le contenu généré, reproduit ci-dessous.

   Rails.application.routes.draw do
     get 'welcome/index'
   
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
   end

6. Pour modifier ce fichier, ajoutez root 'welcome#index'.

   Rails.application.routes.draw do
     get 'welcome/index'
   
     # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
     root 'welcome#index'
   end

7. Enregistrez le fichier, puis fermez-le. Testez l'application Rails comme vous l'avez fait précédemment.

Déployer l'application dans l'environnement flexible App Engine

L'environnement flexible App Engine utilise un fichier appelé app.yaml. pour décrire la configuration de déploiement d'une application. Si ce fichier est absent, la gcloud CLI tente de déterminer la configuration du déploiement. Nous vous recommandons toutefois de fournir ce fichier, car Rails nécessite une clé secrète dans un environnement de production.

Pour configurer l'exemple d'application en vue du déploiement sur App Engine, créez un fichier nommé app.yaml à la racine du répertoire de votre exemple d'application et ajoutez-y les lignes suivantes :

entrypoint: bundle exec rackup --port $PORT
env: flex
runtime: ruby

Configurer la clé secrète Rails

Lorsque vous déployez une application Rails dans l'environnement de production, définissez la variable d'environnement SECRET_KEY_BASE en indiquant une clé secrète utilisée pour protéger les données de session de l'utilisateur. Cette variable d'environnement est lue dans le fichier config/secrets.yml.

1. Générez une nouvelle clé secrète.

   bundle exec rails secret
   

2. Copiez la clé secrète générée. Vous l'utiliserez à l'étape suivante.

3. Ouvrez le fichier app.yaml que vous avez créé précédemment et ajoutez une section env_variables. env_variables définit les variables d'environnement dans l'environnement de production de l'environnement flexible App Engine. Votre fichier app.yaml devrait ressembler à l'exemple ci-dessous, avec la clé secrète à la place de l'espace réservé [SECRET_KEY].

   entrypoint: bundle exec rackup --port $PORT
   env: flex
   runtime: ruby
   
   env_variables:
     SECRET_KEY_BASE: [SECRET_KEY]

Configurer une application d'environnement flexible App Engine

Si vous déployez une application pour la première fois, vous devez créer une application d'environnement flexible App Engine qui vous aidera à sélectionner la région dans laquelle exécuter l'application Rails. Pour en savoir plus, consultez la documentation sur les régions et les zones.

1. Créez une application App Engine. Par défaut, la commande suivante crée deux instances :

   gcloud app create
   

2. Sélectionnez une région prenant en charge l'environnement flexible App Engine pour les applications Ruby.

Effectuer un déploiement dans l'environnement flexible App Engine

Déployez l'exemple d'application en exécutant la commande suivante :

gcloud app deploy

Attendez le message vous informant que la mise à jour est terminée. Cette opération peut prendre plusieurs minutes.

Accéder à l'application Rails déployée

1. Pour récupérer votre ID de projet, exécutez la commande gcloud info.

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

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

   Remplacez les éléments suivants :

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

Le contenu suivant s'affiche.

Cette fois, votre requête est traitée par l'application Rails s'exécutant dans l'environnement flexible App Engine.

Cette commande déploie l'application conformément aux instructions du fichier app.yaml, et définit la version nouvellement déployée comme version par défaut, de sorte que celle-ci diffuse tout le nouveau trafic. Lors du déploiement de l'application, certains messages risquent de s'afficher plusieurs fois pendant que la plate-forme vérifie si l'application est en service. Ceci est normal. Attendez le message indiquant que la mise à jour de l'application est terminée.

Pour mettre à jour l'application, vous pouvez déployer la version à jour en saisissant la même commande que celle utilisée pour le premier déploiement. Le nouveau déploiement génère une nouvelle version de votre application, qui est alors définie comme version par défaut. Les anciennes versions de votre application sont conservées, tout comme les instances de VM associées. Sachez que toutes ces versions d'application et instances de VM sont des ressources facturables.

Lire les journaux App Engine

Maintenant que vous avez déployé votre application Rails, vous voudrez peut-être en consulter les journaux. Vous pouvez lire les journaux d'application à l'aide de l' explorateur de journaux disponible dans la Google Cloud console ou en utilisant gcloud app logs read. Pour en savoir plus sur la lecture des journaux à l'aide de la gcloud CLI, consultez cette page.

Effectuer un nettoyage des ressources

Une fois le tutoriel terminé, vous pouvez procéder au nettoyage des ressources que vous avez créées afin qu'elles ne soient plus comptabilisées dans votre quota et qu'elles ne vous soient plus facturées. Dans les sections suivantes, nous allons voir comment supprimer ou désactiver ces ressources.

Supprimer le projet

Le moyen le plus simple d'empêcher la facturation est de supprimer le projet que vous avez créé pour ce tutoriel.

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

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 Google 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 Arrêter pour supprimer le projet.

Supprimer une version App Engine

Pour supprimer une version d'application :

1. Dans la Google Cloud console, accédez à la page Versions pour App Engine.

   Accéder à la page "Versions"

2. Cochez la case correspondant à la version de l'application autre que celle par défaut que vous souhaitez supprimer.
   Remarque : Le seul moyen de supprimer la version par défaut de votre application App Engine consiste à supprimer votre projet. Vous pouvez toutefois arrêter la version par défaut dans la Google Cloud console. Cette opération a pour effet d'arrêter toutes les instances associées à la version. Vous pourrez redémarrer ces instances ultérieurement si nécessaire.

   Dans l'environnement standard App Engine, vous ne pouvez arrêter la version par défaut que si vous avez spécifié le scaling manuel ou de base pour votre application.

3. Pour supprimer la version de l'application, cliquez sur Supprimer.

Étape suivante

• Découvrez comment utiliser Cloud SQL pour MySQL avec Rails.

• Découvrez comment utiliser Cloud SQL pour PostgreSQL avec Rails.

• Découvrez comment exécuter l'exemple d'application Ruby Bookshelf dans l'environnement flexible App Engine.

• Découvrez comment exécuter l'exemple d'application Ruby Bookshelf sur Compute Engine.

• Découvrez comment exécuter l'exemple d'application Ruby Bookshelf sur GKE.