Utilisation de la plateforme Elastic Beanstalk Tomcat

Important

AWS Elastic Beanstalk installe Log4j à partir des référentiels de paquets par défaut Amazon Linux sur ses plateformes Tomcat pour Amazon Linux 1 et Amazon Linux 2. Les versions de Log4j disponibles dans les référentiels Amazon Linux 1 et Amazon Linux 2 ne sont pas affectées par CVE-2021-44228 ou CVE-2021-45046 dans leur configuration par défaut.

Si vous avez apporté des modifications à la configuration de l'utilisation de log4j par votre application, ou si vous avez installé des versions plus récentes de log4j, nous vous recommandons de prendre des mesures pour mettre à jour le code de votre application afin d'atténuer ce problème.

Par prudence, Elastic Beanstalk a publié de nouvelles versions des plateformes qui utilisent les derniers référentiels de paquets par défaut d'Amazon Linux, qui incluent le Log4j hotpatched JDK, dans notre version de la plateforme Amazon Linux du 21 décembre 2021. Si vous avez personnalisé l'installation de log4j comme dépendance de votre application, nous vous recommandons de passer à la dernière version de la plateforme Elastic Beanstalk afin d'atténuer les effets de CVE-2021-44228 ou CVE-2021-45046. Vous pouvez également activer les mises à jour gérées automatisées dans le cadre des pratiques de mise à jour normales.

Pour plus d'informations sur les mises à jour logicielles liées à la sécurité pour Amazon Linux, consultez Centre de sécurité Amazon Linux.

La plateforme Tomcat AWS Elastic Beanstalk est un ensemble de versions de plate-forme pour les applications web Java qui peuvent s'exécuter dans un conteneur web Tomcat. Tomcat s'exécute derrière un serveur proxy nginx. Chaque configuration correspond à une version majeure de Tomcat, telle que Java 8 avec Tomcat 8.

Des options de configuration sont disponibles dans la console Elastic Beanstalk pour modifier la configuration d'un environnement en cours d'exécution. Pour éviter de perdre la configuration de votre environnement en le résiliant, vous pouvez utiliser des configurations enregistrées pour enregistrer vos paramètres et les appliquer par la suite à un autre environnement.

Pour enregistrer les paramètres dans votre code source, vous pouvez inclure des fichiers de configuration. Les paramètres des fichiers de configuration sont appliquées chaque fois que vous créez un environnement ou que vous déployez votre application. Vous pouvez également utiliser des fichiers de configuration pour installer des packages, exécuter des scripts ou effectuer d'autres opérations de personnalisation d'instance lors des déploiements.

La plateforme Tomcat Elastic Beanstalk inclut un proxy inverse qui transmet les demandes à votre application. Vous pouvez utiliser les options de configuration pour configurer le serveur proxy de manière à traiter les ressources statiques à partir d'un dossier de votre code source afin de réduire la charge sur votre application. Pour les scénarios avancés, vous pouvez inclure vos propres .conffichiers dans votre bundle de fichiers source afin d'étendre la configuration proxy Elastic Beanstalk ou de la remplacer complètement.

Note

Elastic Beanstalk prend en charge nginx (valeur par défaut) et Apache HTTP Server en tant que serveurs proxy sur la plateforme Tomcat. Si votre environnement Elastic Beanstalk Tomcat utilise une branche de plateforme AMI Amazon Linux (antérieure à Amazon Linux 2), vous avez également la possibilité d'utiliser Apache HTTP Server Version 2.2. Apache (dernière version) est la valeur par défaut sur ces anciennes branches de plateforme.

Le 18 juillet 2022, Elastic Beanstalk définira les statuts de toutes les branches de plateforme basées sur une AMI Amazon Linux (AL1) sur mise hors service. Pour plus d'informations sur la migration vers une branche de plateforme Amazon Linux 2023 actuelle et entièrement prise en charge, consultez Migration de votre application Elastic Beanstalk Linux vers Amazon Linux 2023 ou Amazon Linux 2.

Vous devez compresser les applications Java dans un fichier WAR (Web application ARchive) avec une structure spécifique. Pour plus d'informations sur la structure à respecter et sur sa liaison à la structure de votre répertoire de projet, consultez Structuration de votre dossier de projet.

Pour exécuter plusieurs applications sur le même serveur web, vous pouvez regrouper plusieurs fichiers WAR dans un bundle source unique. Chaque application d'un bundle source multiple s'exécute soit sur le chemin d'accès racine (ROOT.war s'exécute dans myapp.elasticbeanstalk.com/), soit sur un chemin d'accès situé juste en dessous (app2.war.war s'exécute dans myapp.elasticbeanstalk.com/app2/), selon le nom du fichier WAR. Dans un bundle source WAR unique, l'application s'exécute toujours sur le chemin d'accès racine.

Les paramètres appliqués dans la console Elastic Beanstalk remplacent les mêmes paramètres des fichiers de configuration, s'ils existent. Cela vous permet d'utiliser les paramètres par défaut dans les fichiers de configuration et de les remplacer par des paramètres spécifiques à l'environnement dans la console. Pour plus d'informations sur la priorité et les autres méthodes de modification des paramètres, consultez Options de configuration.

Pour plus d'informations sur les différentes manières d'étendre une plateforme Elastic Beanstalk basée sur Linux, consultez Extension des plateformes Linux Elastic Beanstalk.

Rubriques

• Configuration de votre environnement Tomcat
• Espaces de noms de la configuration Tomcat
• Création d'une offre groupée de plusieurs fichiers WAR pour les environnements Tomcat
• Structuration de votre dossier de projet
• Configuration du serveur proxy de votre environnement Tomcat

Configuration de votre environnement Tomcat

La plateforme Tomcat Elastic Beanstalk fournit quelques options propres à la plateforme en plus des options standard présentes sur toutes les plateformes. Ces options vous permettent de configurer la machine virtuelle Java (JVM) qui s'exécute sur les serveurs web de votre environnement et de définir les propriétés système qui fournissent les chaînes de configuration d'information à votre application.

Vous pouvez utiliser la console Elastic Beanstalk pour activer la rotation de journal sur Amazon S3 et configurer les variables que votre application peut lire depuis l'environnement.

Pour configurer votre environnement Tomcat dans la console Elastic Beanstalk

1. Ouvrez la console Elastic Beanstalk et, dans la liste Regions (Régions), sélectionnez votre Région AWS.

2. Dans le panneau de navigation, choisissez Environments (Environnements), puis choisissez le nom de votre environnement dans la liste.

   Note

   Si vous avez plusieurs environnements, utilisez la barre de recherche pour filtrer la liste des environnements.

3. Dans le panneau de navigation, choisissez Configuration.

4. Dans la catégorie de configuration Mises à jour, surveillance et journalisation, sélectionnez Modifier.

Options du conteneur

Vous pouvez spécifier ces options spécifiques à la plateforme :

• Proxy server (Serveur proxy) – Serveur proxy à utiliser sur vos instances d'environnement. Le serveur nginx est utilisé par défaut.

Options du conteneur JVM

La taille du tas sur la machine virtuelle Java (JVM) détermine combien d'objets peuvent être créés en mémoire par votre application avant un nettoyage de la mémoire. Vous pouvez modifier les options Initial JVM Heap Size (-Xms option) et Maximum JVM Heap Size (argument -Xmx). Plus la taille initiale du tas est importante, plus le nombre d'objets pouvant être créés avant le nettoyage de la mémoire sera élevé. Toutefois, cela signifie également que le récupérateur de mémoire mettra plus de temps pour compacter le tas. La taille de tas maximale indique la quantité maximale de mémoire que la machine virtuelle Java peut allouer lorsqu'elle augmente le tas dans le cadre d'une activité intensive.

Note

La mémoire disponible dépend du type d'instance Amazon EC2. Pour plus d'informations sur les types d'instances EC2 disponibles pour votre environnement Elastic Beanstalk, consultez Types d'instances dans le Guide de l'utilisateur Amazon Elastic Compute Cloud pour les instances Linux.

La génération permanente est une section du tas de la machine virtuelle Java qui stocke les définitions de classe et les métadonnées associées. Pour modifier la taille de la génération permanente, saisissez la nouvelle taille dans l'option Maximum JVM PermGen Size (-XX:MaxPermSize). Ce paramètre s'applique uniquement à Java 7 et versions antérieures. Cette option a été supprimée dans le kit JDK 8 et remplacée par l'option MaxMetaspace Size (-XX:MaxMetaspaceSize).

Important

JDK 17 a supprimé la prise en charge de l'option Java -XX:MaxPermSize. L'utilisation de cette option avec un environnement s'exécutant sur une branche de plateforme Elastic Beanstalk avec Corretto 17 provoquera une erreur. Elastic Beanstalk a publié sa première branche de plateforme exécutant Tomcat avec Corretto 17 le 13 juillet 2023.

Pour plus d'informations, veuillez consulter les ressources suivantes.

• Site Web de documentation Oracle Java : Options Java supprimées (français non garanti)

• Site Web de documentation Oracle Java : section Métadonnées de classe dans Autres considérations (français non garanti)

Pour plus d'informations sur les plateformes Elastic Beanstalk et leurs composants, consultez la section Plateformes prises en charge dans le guide Plateformes AWS Elastic Beanstalk.

Options du journal

La section Options du journal a deux paramètres :

• Instance profile (Profil d'instance) – Spécifie le profil d'instance qui est autorisé à accéder au compartiment Amazon S3 associé à votre application.

• Enable log file rotation to Amazon S3 (Permettre la rotation du fichier journal sur Amazon S3) – Indique si les fichiers journaux des instances Amazon EC2 de votre application doivent être copiés dans le compartiment Amazon S3 associé à votre application.

Fichiers statiques

Pour améliorer les performances, la section des Fichiers statiques vous permet de configurer le serveur proxy pour proposer des fichiers statiques (HTML ou images, par exemple) à partir d'un ensemble de répertoires dans votre application web. Pour chaque répertoire, vous définissez le chemin virtuel sur le mappage de répertoires. Lorsque le serveur proxy reçoit une demande pour un fichier dans le chemin spécifié, il fournit le fichier directement au lieu d'acheminer la demande vers votre application.

Pour en savoir plus sur la configuration des fichiers statiques à l'aide des fichiers de configuration ou de la console Elastic Beanstalk, consultez Service de fichiers statiques.

Propriétés de l'environnement

Dans la section Environment Properties (Propriétés de l'environnement), vous pouvez spécifier des paramètres de configuration de l'environnement sur les instances Amazon EC2 exécutant votre application. Les propriétés de l'environnement sont passées en tant que paires clé-valeur à l'application.

La plateforme Tomcat définit une propriété d'espace réservée nommée JDBC_CONNECTION_STRING pour les environnements Tomcat, permettant de transmettre une chaîne de connexion à une base de données externe.

Note

Si vous attachez une instance de base de données RDS à votre environnement, construisez la chaîne de connexion JDBC dynamiquement à partir des propriétés d'environnement Amazon Relational Database Service (Amazon RDS) fournies par Elastic Beanstalk. Utilisez JDBC_CONNECTION_STRING uniquement pour les instances de base de données qui ne sont pas mises en service via Elastic Beanstalk.

Pour plus d'informations sur l'utilisation d'Amazon RDS avec votre application Java, consultez Ajout d'une instance de base de données Amazon RDS à votre environnement d'application Java.

Dans l'environnement Tomcat en cours d'exécution dans Elastic Beanstalk, les variables d'environnement sont accessibles à l'aide de System.getProperty(). Par exemple, vous pouvez lire une propriété nommée API_ENDPOINT sur une variable avec le code suivant :

String endpoint = System.getProperty("API_ENDPOINT");

Pour plus d'informations, consultez Propriétés de l'environnement et autres paramètres de logiciel.

Espaces de noms de la configuration Tomcat

Vous pouvez utiliser un fichier de configuration pour définir des options de configuration et exécuter d'autres tâches de configuration d'instance pendant les déploiements. Les options de configuration peuvent être définies par le service Elastic Beanstalk ou la plateforme que vous utilisez et sont organisées en espaces de noms.

La plateforme Tomcat prend en charge les options des espaces de noms suivants en plus des options prises en charge pour tous les environnements Elastic Beanstalk :

• aws:elasticbeanstalk:container:tomcat:jvmoptions : modifier les paramètres de la JVM. Les options de cet espace de noms correspondent aux options de la console de gestion, comme suit :

  • Xms – JVM command line options (Options de ligne de commande de la JVM

  • JVM Options – JVM command line options (Options de ligne de commande de la JVM

• aws:elasticbeanstalk:environment:proxy : choisissez le serveur proxy de l'environnement.

L'exemple de fichier de configuration suivant illustre l'utilisation d'options de configuration spécifiques à Tomcat :

Exemple .ebextensions/tomcat-settings.config

option_settings:
  aws:elasticbeanstalk:container:tomcat:jvmoptions:
    Xms: 512m
    JVM Options: '-Xmn128m'
  aws:elasticbeanstalk:application:environment:
    API_ENDPOINT: mywebapi.zkpexsjtmd.us-west-2.elasticbeanstalk.com
  aws:elasticbeanstalk:environment:proxy:
    ProxyServer: apache

Elastic Beanstalk fournit de nombreuses options de configuration pour personnaliser votre environnement. En plus des fichiers de configuration, vous pouvez également définir des options de configuration à l'aide de la console, de configurations enregistrées, de la CLI EB ou d'AWS CLI. Pour plus d'informations, consultez Options de configuration.

Plateforme Tomcat d'AMI Amazon Linux (antérieure à Amazon Linux 2)

Si votre environnement Elastic Beanstalk Tomcat utilise une version de plateforme AMI Amazon Linux (antérieure à Amazon Linux 2), lisez les informations supplémentaires dans cette section.

Remarques

• Les informations de cette rubrique s'appliquent uniquement aux branches de plateforme basées sur l'AMI Amazon Linux (AL1). Les branches de plateforme AL2023/AL2 sont incompatibles avec les versions de plateforme précédentes de l'AMI Amazon Linux (AL1) et nécessitent des paramètres de configuration différents.

• Le 18 juillet 2022, Elastic Beanstalk définira les statuts de toutes les branches de plateforme basées sur une AMI Amazon Linux (AL1) sur mise hors service. Pour plus d'informations sur la migration vers une branche de plateforme Amazon Linux 2023 actuelle et entièrement prise en charge, consultez Migration de votre application Elastic Beanstalk Linux vers Amazon Linux 2023 ou Amazon Linux 2.

Espaces de noms de configuration Tomcat – AMI Amazon Linux (AL1)

La plateforme Tomcat d'AMI Amazon Linux prend en charge des options supplémentaires dans les espaces de noms suivants :

• aws:elasticbeanstalk:container:tomcat:jvmoptions : en plus des options mentionnées précédemment sur cette page pour cet espace de noms, les anciennes versions de la plateforme AMI Amazon Linux prennent également en charge les éléments suivants :

  • XX:MaxPermSize – Maximum JVM permanent generation size (Taille maximum de génération permanente de la JVM

• aws:elasticbeanstalk:environment:proxy : en plus de choisir le serveur proxy, configurez également la compression de réponse.

L'exemple de fichier de configuration suivant illustre l'utilisation d'options de configuration de l'espace de noms du proxy.

Exemple .ebextensions/tomcat-settings.config

option_settings:
  aws:elasticbeanstalk:environment:proxy:
    GzipCompression: 'true'
    ProxyServer: nginx

Inclusion des fichiers de configuration Elastic Beanstalk – AMI Amazon Linux (AL1)

Pour déployer les fichiers de configuration .ebextensions, incluez-les dans la source de votre application. S'il s'agit d'une seule application, ajoutez .ebextensions à un fichier WAR compressé en exécutant la commande suivante :

zip -ur your_application.war .ebextensions

Pour une application nécessitant plusieurs fichiers WAR, consultez Création d'une offre groupée de plusieurs fichiers WAR pour les environnements Tomcat pour plus d'informations.