Tester et déployer votre application

ID de la région

Le REGION_ID est un code abrégé que Google attribue en fonction de la région que vous sélectionnez lors de la création de votre application. Le code ne correspond pas à un pays ou une province, même si certains ID de région peuvent ressembler aux codes de pays et de province couramment utilisés. Pour les applications créées après février 2020, REGION_ID.r est inclus dans les URL App Engine. Pour les applications existantes créées avant cette date, l'ID de région est facultatif dans l'URL.

En savoir plus sur les ID de région

Découvrez comment exécuter votre application en local, la déployer et la tester sur App Engine.

Exécuter localement

Pour tester votre application avant le déploiement, exécutez-la dans l'environnement local avec les outils de développement que vous utilisez habituellement. Plutôt que d'employer dev_appserver, le serveur de développement local fourni avec le SDK Google Cloud, nous vous recommandons d'utiliser des outils Python standards, tels que virtualenv pour la création d'environnements isolés et pytest pour l'exécution de tests unitaires et d'intégration.

Par exemple, vous pouvez généralement exécuter une application Flask avec le serveur de développement Flask à l'aide de la commande suivante :

python main.py

Démarrez des applications Django à l'aide de la commande suivante :

python manage.py runserver

Pour simuler un environnement App Engine de production, exécutez le serveur WSGI (Web Server Gateway Interface) complet en local. Utilisez la même commande que celle spécifiée en tant que point d'entrée dans votre fichier app.yaml, par exemple :

gunicorn -b :$PORT main:app

Avant de déployer votre application

Avant de déployer votre application :

Le propriétaire du projet Google Cloud doit configurer votre projet Google Cloud pour App Engine.
assurez-vous que votre compte utilisateur inclut les droits requis.

Déployer votre application

Déployez votre application sur App Engine à l'aide de la commande gcloud app deploy. Pendant le déploiement, le service Cloud Build crée une image de conteneur de votre application à exécuter dans l'environnement standard. Chaque compilation est exécutée dans la même région que votre projet Google Cloud. Pour en savoir plus, consultez la page Gérer les images de compilation.

Pour déployer vos applications par programmation, utilisez l'API Admin.

Déployer un service

Déployer une application sur App Engine implique de mettre en œuvre des versions des services de votre application et de chacun de leurs fichiers de configuration.

Pour déployer une version du service de votre application, exécutez la commande suivante à partir du répertoire contenant le fichier app.yaml de votre service :

gcloud app deploy

Le fait de ne spécifier aucun fichier avec la commande a pour effet de ne déployer que le fichier app.yaml dans votre répertoire actuel. Par défaut, la commande deploy génère un ID unique pour la version que vous déployez. Elle effectue le déploiement de la version dans le projet Google Cloud pour lequel vous avez configuré Google Cloud CLI et achemine tout le trafic vers la nouvelle version.

Vous pouvez modifier le comportement par défaut de la commande en ciblant des fichiers spécifiques ou en incluant des paramètres supplémentaires :

Pour déployer les autres fichiers de configuration de votre service, vous devez cibler et déployer chaque fichier séparément. Exemple :
```
gcloud app deploy cron.yaml
gcloud app deploy dispatch.yaml
gcloud app deploy index.yaml
```
Pour spécifier un ID de version personnalisé, utilisez l'option --version.
Pour empêcher que le trafic ne soit automatiquement acheminé vers la nouvelle version, utilisez l'option --no-promote.
Pour effectuer un déploiement dans un projet Google Cloud spécifique, utilisez l'option --project.

Par exemple, pour déployer le service défini par le fichier app.yaml dans un projet Google Cloud spécifique, attribuez-lui un ID de version personnalisé et empêchez que le trafic ne soit acheminé vers la nouvelle version :

gcloud app deploy --project PROJECT_ID --version VERSION_ID --no-promote

Pour en savoir plus sur cette commande, consultez la documentation de référence sur gcloud app deploy.

Déployer plusieurs services

Vous utilisez la même commande de déploiement pour déployer ou modifier les différents services constituant votre application.

Avant de commencer :

Pour pouvoir créer et déployer des services supplémentaires, vous devez d'abord déployer une version de votre application sur le service default.
L'ID de chacun de vos services doit être spécifié dans les fichiers de configuration app.yaml correspondants. Pour spécifier l'ID d'un service, incluez la définition de l'élément service dans chaque fichier de configuration. Par défaut, le fait d'exclure cette définition d'élément de votre fichier de configuration entraîne le déploiement de la version sur le service default.

Pour déployer plusieurs services, déployez séparément le fichier app.yaml de chaque service. Vous pouvez spécifier plusieurs fichiers à l'aide d'une seule commande gcloud app deploy :

gcloud app deploy service1/app.yaml service2/app.yaml

Afficher les journaux de compilation

Cloud Build diffuse des journaux de compilation et de déploiement visibles dans la section Historique Build de la console Google Cloud. Pour afficher les compilations de la région de l'application, utilisez le menu Région afin de filtrer par région.

Gérer les images de compilation

Chaque fois que vous déployez une nouvelle version :

App Engine crée une image de conteneur à l'aide du service Cloud Build.
Cloud Build crée l'image de conteneur dans la région de l'application et s'exécute dans l'environnement standard App Engine.
App Engine stocke les images de conteneurs créées dans Artifact Registry. Vous pouvez les télécharger pour les conserver ou les utiliser ailleurs.

Une fois le déploiement terminé, App Engine n'a plus besoin des images de conteneurs. Les images de conteneurs ne sont pas automatiquement supprimées. Pour éviter d'atteindre votre quota de stockage, vous pouvez supprimer en toute sécurité les images dont vous n'avez pas besoin. Toutefois, si vous avez besoin de vos images ultérieurement ou si vous souhaitez en conserver une copie, vous devez exporter une copie avant de les supprimer. Pour en savoir plus sur la gestion des images dans Artifact Registry, consultez la section Gérer les images.

Ignorer les fichiers

Vous pouvez utiliser un fichier .gcloudignore pour spécifier les fichiers et répertoires à ne pas importer dans App Engine lorsque vous déployez vos services. Cette opération est utile pour ignorer les artefacts de compilation et d'autres fichiers qui n'ont pas besoin d'être importés lors du déploiement.

Afficher votre application

Après avoir déployé votre application dans App Engine, vous pouvez exécuter la commande suivante pour lancer votre navigateur et l'afficher à l'adresse https://PROJECT_ID.REGION_ID.r.appspot.com :

gcloud app browse

Tester sur App Engine avant de basculer le trafic

Avant de configurer une nouvelle version pour recevoir du trafic, vous pouvez la tester sur App Engine. Par exemple, pour tester une nouvelle version de votre service default :

Déployez votre nouvelle version, mais empêchez que le trafic ne soit automatiquement acheminé vers la nouvelle version :
```
gcloud app deploy --no-promote
```
Affichez la nouvelle version en accédant à l'URL suivante :

https://VERSION_ID-dot-default-dot-PROJECT_ID.REGION_ID.r.appspot.com

Remarque : Vous pouvez trouver l'ID de version dans la console Google Cloud, ou en spécifier un lors du déploiement avec --version flag. Google Cloud CLI affiche également l'ID de version lors du déploiement.

Vous pouvez maintenant tester la nouvelle version dans l'environnement d'exécution App Engine. Vous pouvez déboguer l'application en consultant ses journaux. Pour en savoir plus, consultez la page Écrire des journaux d'application.

App Engine achemine les requêtes envoyées à https://PROJECT_ID.REGION_ID.r.appspot.com vers la version précédemment configurée pour recevoir le trafic.
Lorsque vous souhaitez envoyer du trafic vers la nouvelle version, utilisez la console Google Cloud pour migrer le trafic :

Gérer les versions

Sélectionnez la version que vous venez de déployer et cliquez sur Migrer le trafic.

Vous pouvez utiliser le même processus pour tester de nouvelles versions d'autres services en remplaçant default dans l'URL par le nom de votre service :

https://VERSION-dot-SERVICE-dot-PROJECT_ID.REGION_ID.r.appspot.com

Pour en savoir plus sur le ciblage de services et de versions spécifiques, consultez la page Mode de routage des requêtes.

Utiliser des variables d'environnement de compilation

Vous pouvez définir des variables d'environnement de compilation pour les environnements d'exécution compatibles avec les packs de création.

Les variables d'environnement de compilation sont des paires clé/valeur que vous pouvez spécifier pour configurer le buildpack à utiliser pour déployer votre application. Par exemple, vous voudrez peut-être spécifier des options de compilateur.

Avant de commencer :

Les clés doivent commencer par une lettre ASCII en majuscule et peuvent inclure des lettres ASCII en majuscules, des chiffres et des traits de soulignement.
Vous devez éviter de créer des variables avec un préfixe de clé GOOGLE_*.
Les clés suivantes sont réservées à l'usage de Google :
- GOOGLE_RUNTIME
- GOOGLE_RUNTIME_VERSION
- GOOGLE_ENTRYPOINT
- GOOGLE_DEVMODE
Vous pouvez utiliser n'importe quelle clé compatible avec les packs de création.

Pour utiliser des variables d'environnement avec des packs de création, spécifiez le champ build_env_variables dans votre fichier app.yaml.

En savoir plus sur les packs de création.

Utiliser le serveur de développement local

Google Cloud CLI comprend un serveur de développement local nommé dev_appserver, que vous pouvez exécuter localement pour simuler l'exécution de votre application en production dans App Engine. Ce serveur de développement simule partiellement l'environnement dans lequel votre application s'exécute, ce qui vous permet de tester les applications écrites pour n'importe quel environnement d'exécution standard.

Exécuter le serveur de développement local

Après avoir créé le fichier de configuration app.yaml pour votre application, vous pouvez démarrer le serveur de développement local avec la commande dev_appserver.py pour l'exécuter localement.

Pour obtenir les identifiants d'accès pour votre compte utilisateur, exécutez la commande suivante :
```
gcloud auth login
```
Autorisez votre application locale à utiliser temporairement vos identifiants utilisateur pour accéder à l'API :
```
gcloud auth application-default login
```
Pour démarrer le serveur de développement local, procédez comme suit :

Dans le répertoire contenant votre fichier de configuration app.yaml, exécutez la commande dev_appserver.py et spécifiez votre ID de projet et le chemin d'accès à votre fichier app.yaml :
```
python3 CLOUD_SDK_ROOT/bin/dev_appserver.py --application=PROJECT_ID app.yaml
```
Pour modifier le port, incluez l'option --port :
```
python3 CLOUD_SDK_ROOT/bin/dev_appserver.py --application=PROJECT_ID app.yaml --port=9999
```
Pour tester une application Python 3, exécutez dev_appserver.py avec un interpréteur Python 3, en veillant à spécifier le binaire Python 3 dans l'option --runtime_python_path, par exemple :
```
python3 CLOUD_SDK_ROOT/bin/dev_appserver.py --runtime_python_path=/usr/bin/python3 --application=PROJECT_ID app.yaml --port=9999
```
Pour en savoir plus sur les options de la commande dev_appserver.py, consultez la page Options du serveur de développement local.
Lorsque le serveur de développement local démarre, il configure un environnement de développement qui préinstalle les dépendances identifiées dans votre fichier requirements.txt.
Le serveur de développement local est désormais en cours d'exécution et à l'écoute des requêtes. Saisissez l'adresse http://localhost:8080/ dans votre navigateur Web pour observer l'application en action.

Si vous avez spécifié un port personnalisé avec l'option --port, n'oubliez pas d'ouvrir votre navigateur pour ce port.
Pour arrêter le serveur local à partir de la ligne de commande, appuyez sur Ctrl-C sur votre clavier.

Détecter l'environnement d'exécution de l'application

Pour déterminer si votre code est en cours d'exécution en production ou sur le serveur de développement local, vous pouvez vérifier la variable d'environnement GAE_ENV :

if os.getenv('GAE_ENV', '').startswith('standard'):
  # Production in the standard environment
else:
  # Local execution.

Utiliser le serveur de développement local avec les services Google Cloud

Vous pouvez intégrer l'outil dev_appserver avec d'autres composants Google Cloud.

Bibliothèques clientes Cloud

De nombreuses bibliothèques clientes Google Cloud dépendent de la présence de la variable d'environnement GOOGLE_CLOUD_PROJECT, qui doit être votre ID de projet Google Cloud. Vous pouvez trouver sa valeur en exécutant la commande gcloud config list project ou en consultant la page de votre projet dans la console Google Cloud.

Pour vous assurer que cette variable d'environnement est définie correctement lors du développement local, initialisez dev_appserver à l'aide du paramètre --application=PROJECT_ID, comme indiqué dans l'exemple ci-dessus.

Émulateurs Cloud

Vous pouvez tester votre application avec des émulateurs pour Cloud Datastore, Cloud Bigtable et Cloud Pub/Sub.

Actualiser automatiquement les modifications apportées aux fichiers `requirements.txt` et `app.yaml`

Le serveur de développement local installe automatiquement les dépendances identifiées dans votre fichier requirements.txt. L'outil dev_appserver vous permet également de tester les fonctionnalités configurées via le fichier app.yaml. Par exemple, vous pouvez tester la capacité de votre application à diffuser des fichiers statiques. Si vous apportez des modifications aux fichiers requirements.txt et app.yaml lorsque l'outil dev_appserver est en cours d'exécution, votre application redémarre automatiquement afin de refléter ces modifications. Cela peut nécessiter un délai d'exécution ponctuel, en raison du téléchargement et de l'installation des dépendances.

Gestion des instances et routage dans le serveur de développement

Découvrir les adresses d'instance

Le serveur de développement local crée toutes les instances de scaling manuel au démarrage. Les instances des services de scaling automatique et de base sont gérées de manière dynamique. Le serveur attribue un port à chaque service, et les clients peuvent compter sur le serveur pour équilibrer la charge et sélectionner une instance automatiquement. Les attributions de port pour l'adressage de chaque service s'affichent dans le flux de messages du journal du serveur.

Voici les ports attribués à une application qui définit trois services :

INFO Starting module "default" running at: http://localhost:8084
INFO Starting module "service1" running at: http://localhost:8082
INFO Starting module "service2" running at: http://localhost:8083

Lorsque vous utilisez l'adresse d'un service, par exemple http://localhost:8082/, le serveur crée ou sélectionne une instance du service et lui envoie la requête.

Le serveur attribue des ports uniques à chaque instance d'un service. Vous pouvez utiliser le serveur d'administration pour connaître ces ports. Ce dernier dispose d'un port unique qui s'affiche dans le journal des messages :

INFO Starting admin server at: http://localhost:8000

Cette adresse vous permet d'accéder à la console du serveur d'administration. Cliquez sur Instances pour afficher l'état dynamique des instances de votre application.

Une entrée distincte s'affiche pour chaque instance manuelle et de base. Les numéros d'instance sont des liens renvoyant à des adresses de port uniques pour chaque instance. Cliquez sur le lien pour envoyer une requête directement à cette instance.

Fichiers de distribution

Si votre application inclut un fichier dispatch.yaml, le flux de messages du journal inclut un port de coordinateur :

INFO Starting dispatcher running at: http://localhost:8080

Les requêtes adressées à ce port sont acheminées conformément aux règles du fichier de distribution. Le serveur n'accepte pas les règles du fichier dispatch.yaml qui incluent des noms d'hôte (par exemple, url: "customer1.myapp.com/*"). Les règles comportant des formats de chemins relatifs (url: "*/fun") sont acceptées. Vous pouvez donc utiliser des URL telles que http://localhost/fun/mobile pour atteindre des instances. Le serveur signale une erreur dans le flux du journal si vous tentez de démarrer une application avec un fichier dispatch.yaml contenant des règles basées sur l'hôte.

Utiliser Cloud Trace

Cloud Trace est utile pour comprendre comment les requêtes se propagent dans votre application. Consultez des informations détaillées sur la latence d'une seule requête, ou affichez la latence totale de votre application.

Pour afficher les détails des traces dans Cloud Trace, vous pouvez suivre les instructions de la page Rechercher et explorer des traces. Vous pouvez filtrer la liste de traces en fonction de votre service et de votre version App Engine spécifiques.