Migrer de l'application Java Google App Engine vers Cloud Run avec des Buildpacks

1. Présentation

Cette série d'ateliers de programmation (tutoriels pratiques à suivre à votre rythme) est destinée à aider les développeurs Java Google App Engine (standard) à moderniser leurs applications en les guidant tout au long d'une série de migrations. En suivant ces étapes, vous pouvez rendre votre application plus portable et décider de la conteneuriser pour Cloud Run, le service d'hébergement de conteneurs de Google Cloud étroitement lié à App Engine, ainsi que pour d'autres services d'hébergement de conteneurs.

Ce tutoriel vous explique comment conteneuriser une application App Engine pour la déployer sur le service entièrement géré Cloud Run à l'aide de Buildpacks. Les buildpacks sont un projet CNCF qui vous permet de convertir directement le code source de votre application en images hautement portables pouvant s'exécuter sur n'importe quel cloud.

En plus de vous expliquer les étapes requises pour passer d'App Engine à Cloud Run, vous découvrirez comment mettre à niveau une application App Engine Java 8 vers Java 17.

Si l'application que vous souhaitez migrer utilise de manière intensive les anciens services groupés App Engine ou d'autres fonctionnalités spécifiques à App Engine, le guide Accéder aux services groupés App Engine pour Java 11/17 peut mieux convenir que cet atelier de programmation.

Vous apprendrez à

  • Utiliser Cloud Shell
  • Activez les API Cloud Run, Artifact Registry et Cloud Build.
  • Conteneuriser votre application à l'aide de Buildpacks sur Cloud Build
  • Déployer vos images de conteneurs dans Cloud Run

Prérequis

Enquête

Comment allez-vous utiliser ce tutoriel ?

Je vais le lire uniquement Je vais le lire et effectuer les exercices

Comment évalueriez-vous votre niveau d'expérience avec Java ?

Débutant Intermédiaire Expert

Quel est votre niveau d'expérience avec les services Google Cloud ?

Débutant Intermédiaire Expert

2. Contexte

Les systèmes PaaS tels qu'App Engine et Cloud Functions offrent de nombreux avantages pour vos équipes et vos applications, par exemple en permettant aux administrateurs système et aux développeurs DevOps de se concentrer sur la création de solutions. Avec les plates-formes sans serveur, votre application peut évoluer automatiquement à la hausse si nécessaire, effectuer un scaling à la baisse jusqu'à zéro avec la facturation à l'utilisation pour vous aider à maîtriser les coûts, et utiliser divers langages de développement courants.

La flexibilité des conteneurs est un autre atout majeur. Grâce à la possibilité de choisir n'importe quel langage, bibliothèque et binaire, les conteneurs vous offrent le meilleur des deux mondes: la commodité de l'informatique sans serveur et la flexibilité des conteneurs. C'est l'objectif de Google Cloud Run.

L'apprentissage de l'utilisation de Cloud Run n'entre pas dans le cadre de cet atelier de programmation. Tout cela est décrit dans la documentation Cloud Run. L'objectif ici est de vous familiariser avec la façon de conteneuriser votre application App Engine pour Cloud Run (ou d'autres services hébergés dans des conteneurs). Avant de continuer, vous devez prendre connaissance de quelques informations : votre expérience utilisateur sera légèrement différente.

Dans cet atelier de programmation, vous allez apprendre à créer et à déployer des conteneurs. Vous apprendrez à conteneuriser votre application avec Buildpacks, à migrer vers une configuration autre qu'App Engine et à définir des étapes de compilation pour Cloud Build. Vous devrez donc abandonner certaines fonctionnalités spécifiques à App Engine. Si vous préférez ne pas suivre cette voie, vous pouvez toujours passer à un environnement d'exécution Java 11/17 tout en conservant vos applications sur App Engine.

3. Configuration/Préparation

1. Configurer le projet

Pour ce tutoriel, vous allez utiliser un exemple d'application du dépôt appengine-java-migration-samples dans un tout nouveau projet. Assurez-vous que le projet dispose d'un compte de facturation actif.

Si vous prévoyez de migrer une application App Engine existante vers Cloud Run, vous pouvez utiliser cette application pour suivre ce tutoriel.

Exécutez la commande suivante pour activer les API nécessaires à votre projet:

gcloud services enable artifactregistry.googleapis.com cloudbuild.googleapis.com run.googleapis.com

2. Obtenir un exemple d'application de référence

Clonez l'exemple d'application sur votre propre machine ou dans Cloud Shell, puis accédez au dossier baseline.

Cet exemple est une application de datastore Java 8 basée sur des servlets et conçue pour être déployée sur App Engine. Suivez les instructions du fichier README pour préparer cette application pour le déploiement d'App Engine.

3. (Facultatif) Déployer l'application de référence

Les étapes suivantes ne sont nécessaires que si vous souhaitez vérifier que l'application fonctionne sur App Engine avant la migration vers Cloud Run.

Reportez-vous aux étapes décrites dans le fichier README.md:

  1. Installer/vous familiariser à nouveau avec la CLI gcloud
  2. Initialiser la gcloud CLI pour votre projet avec gcloud init
  3. Créer le projet App Engine avec gcloud app create
  4. Déployer l'exemple d'application sur App Engine
./mvnw package appengine:deploy -Dapp.projectId=$PROJECT_ID
  1. Vérifier que l'application s'exécute sans problème sur App Engine

4. Créer un dépôt Artifact Registry

Après avoir conteneurisé votre application, vous aurez besoin d'un emplacement pour transférer et stocker vos images. La méthode recommandée sur Google Cloud est d'utiliser Artifact Registry.

Créez le dépôt nommé migration avec gcloud comme suit:

gcloud artifacts repositories create migration --repository-format=docker \
--description="Docker repository for the migrated app" \
--location="northamerica-northeast1"

Notez que ce dépôt utilise le type de format docker, mais il existe plusieurs types de dépôts disponibles.

À ce stade, vous disposez de votre application App Engine de référence et votre projet Google Cloud est prêt à la migrer vers Cloud Run.

4. Modifier les fichiers d'application

Si votre application fait une utilisation intensive des anciens services groupés, de la configuration ou d'autres fonctionnalités spécifiques à App Engine d'App Engine, nous vous recommandons de continuer à accéder à ces services pendant la mise à niveau vers le nouvel environnement d'exécution. Cet atelier de programmation présente un chemin de migration pour les applications qui utilisent déjà des services autonomes ou qui peuvent être refactorisées pour le faire.

1. Mettre à niveau vers Java 17

Si votre application est basée sur Java 8, envisagez de passer à une version candidate LTS ultérieure, comme Java 11 ou Java 17, pour suivre les mises à jour de sécurité et accéder aux nouvelles fonctionnalités de langage.

Commencez par mettre à jour les propriétés de votre pom.xml pour inclure les éléments suivants:

<properties>
    <java.version>17</java.version>
    <maven.compiler.source>17</maven.compiler.source>
    <maven.compiler.target>17</maven.compiler.target>
</properties>

La version du projet sera alors définie sur 17, le plug-in du compilateur sera informé que vous souhaitez accéder aux fonctionnalités du langage Java 17 et que vous souhaitez que les classes compilées soient compatibles avec la JVM Java 17.

2. y compris un serveur Web ;

Il existe un certain nombre de différences entre App Engine et Cloud Run qui méritent d'être prises en compte lorsque vous passez de l'un à l'autre. Une différence est que, contrairement à Cloud Run, l'environnement d'exécution Java 8 d'App Engine fournissait et gérait un serveur Jetty pour les applications qu'il hébergeait. Nous utiliserons Spring Boot pour nous fournir un serveur Web et un conteneur de servlet.

Ajoutez les dépendances suivantes :

<dependencies>
<!-- ... -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
       <version>2.6.6</version>
       <exclusions>
           <!-- Exclude the Tomcat dependency -->
           <exclusion>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-tomcat</artifactId>
           </exclusion>
       </exclusions>
   </dependency>
   <!-- Use Jetty instead -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-jetty</artifactId>
       <version>2.6.6</version>
   </dependency>
<!-- ... -->
</dependencies>

Spring Boot intègre un serveur Tomcat par défaut, mais cet exemple exclura cet artefact et utilisera Jetty pour minimiser les différences de comportement par défaut après la migration.

3. Configuration de Spring Boot

Bien que Spring Boot puisse réutiliser vos servlets sans les modifier, une configuration est nécessaire pour vous assurer qu'ils sont visibles.

Créez la classe MigratedServletApplication.java suivante dans le package com.example.appengine:

package com.example.appengine;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@ServletComponentScan
@SpringBootApplication
@EnableAutoConfiguration
public class MigratedServletApplication {
    public static void main(String[] args) {
        SpringApplication.run(MigratedServletApplication.class, args);
    }
}

Notez que cela inclut l'annotation @ServletComponentScan, qui recherche (dans le package actuel par défaut) tous les @WebServlets et les rend disponibles comme prévu.

4. Configuration de la compilation

Ensuite, supprimez la configuration pour empaqueter notre application en tant que fichier WAR. Cela ne nécessitera pas beaucoup de configuration, en particulier pour les projets utilisant Maven comme outil de compilation, car le conditionnement en fichier JAR est le comportement par défaut.

Supprimez la balise packaging dans le fichier pom.xml:

<packaging>war</packaging>

Ensuite, ajoutez spring-boot-maven-plugin:

<plugins>
<!-- ... -->
  <plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <version>2.6.6</version>
  </plugin>
<!-- ... -->
</plugins>

5. Migrer loin de la configuration, des services et des dépendances App Engine

Comme indiqué au début de l'atelier de programmation, Cloud Run et App Engine sont conçus pour offrir des expériences utilisateur différentes. Certaines fonctionnalités proposées par App Engine prêtes à l'emploi, comme les services Cron et Task Queue, doivent être recréées manuellement. Elles seront abordées plus en détail dans les modules suivants.

L'application exemple n'utilise pas les anciens services groupés, mais les utilisateurs dont les applications le font peuvent consulter les guides suivants:

Étant donné que vous allez désormais déployer sur Cloud Run, vous pouvez supprimer appengine-maven-plugin:

<plugin>
 <groupId>com.google.cloud.tools</groupId>
 <artifactId>appengine-maven-plugin</artifactId>
 <version>2.4.1</version>
 <configuration>
   <!-- can be set w/ -DprojectId=myProjectId on command line -->
   <projectId>${app.projectId}</projectId>
   <!-- set the GAE version or use "GCLOUD_CONFIG" for an autogenerated GAE version -->
   <version>GCLOUD_CONFIG</version>
 </configuration>
</plugin>

5. Conteneuriser et déployer une application

À ce stade, vous êtes prêt à déployer votre application dans Cloud Run directement à partir de votre code source. Il s'agit d'une excellente option qui utilise Cloud Build en arrière-plan pour offrir une expérience de déploiement sans effort. Pour utiliser cette fonctionnalité, vous devez disposer d'un compte disposant d'au moins l'une des autorisations suivantes et avoir suivi la procédure de configuration de l'environnement, ou utiliser Cloud Shell:

Une fois ces conditions préalables remplies, exécutez simplement la commande suivante à partir du répertoire source:

gcloud run deploy SERVICE --source .

Lors de la commande "run deploy", vous serez invité à effectuer certaines opérations, telles que:

  • Indiquer l'emplacement du code source
  • Indiquer le nom du service
  • Activer l'API Cloud Run
  • Sélectionner votre région

Une fois que vous avez répondu à ces requêtes, le processus de compilation et de déploiement commence, au cours duquel Cloud Build effectue les opérations suivantes:

  • compresse et enregistre votre source dans un bucket Cloud Storage ;
  • utilise les buildpacks de la Cloud Native Computing Foundation en arrière-plan pour créer votre image ;
  • crée un registre pour stocker l'image de conteneur obtenue (s'il n'est pas déjà présent) ;
  • et crée un service Cloud Run pour héberger votre application (s'il n'existe pas déjà).

Une fois la compilation et le déploiement terminés, vous devriez recevoir un message indiquant qu'une nouvelle révision est en ligne et diffuse 100% du trafic.

6. Résumé/Nettoyage

Félicitations ! Vous avez mis à niveau, conteneurisé, migré et déployé votre application. Ce tutoriel est maintenant terminé.

L'étape suivante consiste à en savoir plus sur les fonctionnalités de CI/CD et de sécurité de la chaîne d'approvisionnement logicielle que vous pouvez désormais déployer avec Cloud Build:

Facultatif: Nettoyer et/ou désactiver le service

Si vous avez déployé l'application exemple sur App Engine au cours de ce tutoriel, n'oubliez pas de la désactiver pour éviter que des frais ne vous soient facturés. Lorsque vous serez prêt à passer au prochain atelier de programmation, vous pourrez le réactiver. Les applications App Engine étant désactivées, elles ne reçoivent aucun trafic et ne génèrent aucuns frais. Toutefois, l'utilisation de Datastore peut être facturable si elle dépasse le quota sans frais. Supprimez donc suffisamment d'éléments pour rester dans la limite.

En revanche, si vous ne souhaitez pas poursuivre les migrations et que vous souhaitez tout supprimer complètement, vous pouvez supprimer votre service ou arrêter complètement votre projet.

7. Ressources supplémentaires

Problèmes/commentaires concernant le module de migration App Engine en atelier de programmation

Si vous rencontrez des problèmes avec cet atelier de programmation, commencez par faire une recherche avant de les signaler. Liens vers la recherche et la création d'un signalement :

Ressources de migration

Ressources en ligne

Vous trouverez ci-dessous des ressources en ligne qui peuvent vous être utiles pour ce tutoriel:

App Engine

Autres informations sur le cloud

Vidéos

Licence

Ce document est publié sous une licence Creative Commons Attribution 2.0 Generic.