Comment utiliser le répertoire .ebextensions pour personnaliser mon environnement Elastic Beanstalk ?

Résolution

Remarque : si des erreurs surviennent lorsque vous exécutez des commandes de l’interface de la ligne de commande AWS (AWS CLI), consultez Résolution des erreurs liées à l’AWS CLI. Vérifiez également que vous utilisez la version la plus récente de l’AWS CLI.

Configurer le répertoire .ebextensions

Procédez comme suit :

1. À la racine du paquet de votre application, créez un répertoire caché nommé .ebextensions.
2. Stockez vos fichiers de configuration dans ce répertoire. Le paquet source de votre application ressemble à l’exemple suivant :

   ~/workspace/my-application/
   |-- .ebextensions
   |   |-- 01-server-configuration.config
   |   `-- 02-asg-healthcheck.config
   |-- index.php
   `-- styles.css

   Remarque : Elastic Beanstalk traite les fichiers de configuration du répertoire .ebextensions par ordre alphabétique. Utilisez des préfixes numérotés dans les noms de vos fichiers pour contrôler l’ordre de vos configurations.

Personnaliser votre environnement Elastic Beanstalk

Pour modifier la configuration de votre environnement, utilisez la clé option_settings.

Si vous créez ou mettez à jour un environnement à l’aide de la console Elastic Beanstalk ou de l’interface de ligne de commande Elastic Beanstalk (EB CLI), ces clients appliquent des valeurs recommandées. Les valeurs recommandées sont définies au niveau de l’API et ont la priorité la plus élevée. Vous ne pouvez pas utiliser option_settings pour modifier le paramètre de configuration.

Les règles de priorité peuvent empêcher les modifications apportées à option_settings de s’appliquer à la configuration de l’environnement. Pour supprimer les paramètres qu’Elastic Beanstalk a appliqués directement à l’environnement lors de sa création, utilisez l’opération d’API Elastic Beanstalk UpdateEnvironment. Vous pouvez également utiliser la commande AWS CLI update-environment suivante :

aws elasticbeanstalk update-environment --application-name applicationname --environment-name environmentnamename --options-to-remove Namespace=aws:elasticbeanstalk:application:environment,OptionName==yourpropertyname

Remarque : remplacez applicationname par le nom de votre application, environmentname par le nom de votre environnement et yourpropertyname par le nom de votre propriété.

Si vous ne pouvez pas utiliser option_settings pour modifier votre configuration, utilisez la clé Resources pour personnaliser les ressources de votre environnement Elastic Beanstalk.

Elastic Beanstalk ajoute les ressources que vous définissez dans les fichiers de configuration au modèle AWS CloudFormation qui lance votre environnement. Le modèle CloudFormation prend en charge tous les types de ressources CloudFormation. Pour plus d’informations sur les noms de ressources logiques, consultez Modification des ressources créées par Elastic Beanstalk pour votre environnement.

Les fichiers de configuration doivent porter l’extension .config et utiliser le format YAML ou JSON.

Si votre fichier de configuration utilise le format YAML, assurez-vous d’utiliser des espaces cohérents pour l’indentation. Une indentation incorrecte peut entraîner des échecs de déploiement.

Utilisez des clés pour personnaliser les logiciels sur des serveurs Linux ou Windows. N’utilisez chaque clé qu’une seule fois dans chaque fichier de configuration.

Pour les plateformes basées sur Amazon Linux 2 et Amazon Linux 2023, il est recommandé d’utiliser Buildfile, Procfile et les hooks de plateforme pour exécuter du code personnalisé lors du provisionnement de l’instance. Vous pouvez toujours utiliser commands et container_commands dans vos fichiers de configuration. Pour plus d’informations, consultez Comment utiliser les hooks de plateforme pour personnaliser mon environnement Elastic Beanstalk ?

Lorsque vous déployez votre application sur Elastic Beanstalk, utilisez vos fichiers de configuration .ebextensions pour personnaliser les instances Amazon Elastic Compute Cloud (Amazon EC2). Pour obtenir des exemples de fichiers de configuration, consultez elastic-beanstalk-samples sur le site Web de GitHub.

Pour utiliser .ebextensions afin de configurer HTTPS pour votre environnement, consultez Configuration du protocole HTTPS pour votre environnement Elastic Beanstalk.

Appliquer vos paramètres personnalisés à votre application

Créez un paquet source d’application qui inclut vos fichiers de configuration, puis déployez votre application mise à jour.

Remarque : les outils d’archivage de fichiers peuvent ne pas inclure les répertoires cachés lorsque vous créez un fichier ZIP. Les navigateurs de fichiers peuvent masquer les dossiers dont le nom commence par un point, comme .ebextensions. Incluez le dossier .ebextensions à la racine du paquet de votre application lorsque vous créez son paquet source.

Résoudre les problèmes de configuration de .ebextensions

Si Elastic Beanstalk n’applique pas votre configuration .ebextensions après le déploiement, effectuez les actions suivantes :

Vérifier l’emplacement du répertoire et l’extension de fichier

Passez en revue les événements récents de l’environnement dans la console Elastic Beanstalk. Les messages de déploiement et de configuration d’Elastic Beanstalk apparaissent sur la page Événements. Vérifiez que vous avez configuré le répertoire .ebextensions à la racine de votre paquet source et que vos fichiers de configuration utilisent l’extension .config.

Consulter les journaux de déploiement

Connectez-vous à votre instance Amazon EC2 et vérifiez dans /var/log/eb-engine.log s’il existe des erreurs, des échecs de démarrage ou des problèmes de déploiement liés à vos fichiers de configuration. Consultez également /var/log/cfn-init.log et /var/log/cfn-init-cmd.log pour connaître les résultats du déploiement.

Pour consulter les journaux de déploiement, voir Affichage des journaux de déploiement dans la console.

Pour récupérer les journaux, voir Récupérer les journaux d’instance dans Affichage des journaux des instances Amazon EC2 dans votre environnement Elastic Beanstalk.

Annuler les modifications récentes de la configuration

Si la modification de votre configuration .ebextensions a provoqué un échec de déploiement, redéployez la version de votre application.

Informations connexes

Résolution des problèmes de votre environnement Elastic Beanstalk