Créer une application Python dans l'environnement flexible App Engine

Créer une application Python dans l'environnement flexible App Engine

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

OK

Dans ce guide de démarrage rapide, vous allez apprendre à créer et à déployer une application permettant d'afficher un court message. Vous pouvez utiliser l'exemple d'application de ce guide de démarrage rapide pour toute version compatible de Python, en spécifiant la version de l'environnement d'exécution et le système d'exploitation dans votre fichier app.yaml.

Avant de commencer

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

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

   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

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Build API.

   Enable the API

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

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

   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

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Build API.

   Enable the API

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

Conditions préalables supplémentaires

1. Initialisez votre application App Engine avec votre projet, puis choisissez sa région :

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   Lorsque vous y êtes invité, sélectionnez la région dans laquelle vous souhaitez localiser votre application App Engine.

   Attention : Une fois la région d'une application définie, vous ne pouvez plus la modifier.

2. Installez les composants requis suivants :

   • Téléchargez et installez git.

• Exécutez la commande suivante pour installer le composant gcloud qui inclut l'extension App Engine pour Python :

  gcloud components install app-engine-python
  

3. Préparez l'environnement au développement de Python. Il est recommandé d'installer la dernière version de Python, pip et d'autres outils connexes sur votre système. Pour obtenir des instructions, consultez le guide de configuration de l'environnement de développement Python.

Zones App Engine

App Engine est régional, ce qui signifie que l'infrastructure qui exécute vos applications est située dans une région spécifique, et que Google la gère de sorte qu'elle soit disponible de manière redondante dans toutes les zones de cette région.

Lors de la sélection d'une région dans laquelle exécuter vos applications, vous devez tout d'abord considérer vos exigences en matière de latence, de disponibilité et de durabilité. Vous pouvez généralement sélectionner la région la plus proche des utilisateurs de votre application, mais pensez aussi aux emplacements où App Engine est disponible ainsi qu'aux emplacements des autres produits et services Google Cloud que votre application utilise. L'utilisation de services situés dans des emplacements différents peut avoir des répercussions sur la latence de votre application, ainsi que sur les pricing.

Une fois que vous avez défini la région d'une application, vous ne pouvez plus la modifier.

Remarque : Deux emplacements, appelés europe-west et us-central dans les commandes App Engine et dans Google Cloud Console, sont respectivement appelés europe-west1 et us-central1 dans les autres documentations de Google.

Si vous avez déjà créé une application App Engine, vous pouvez afficher sa région en effectuant l'une des opérations suivantes :

• Exécutez la commande gcloud app describe.

• Ouvrez le tableau de bord App Engine dans la console Google Cloud. La région apparaît en haut de la page.

OK

Ce guide de démarrage rapide présente la dernière application Python 3 écrite à l'aide du framework Web Flask et pouvant être déployée sur App Engine. Bien que cet exemple utilise Flask, vous pouvez opter pour n'importe quel framework Web répondant aux exigences ci-dessus. Il est également possible d'utiliser d'autres frameworks comme Django, Pyramid, Bottle et web.py.

Télécharger l'application Hello World

Nous avons créé une application Hello World pour App Engine afin de vous aider à comprendre rapidement comment déployer une application sur Google Cloud.

1. Clonez le dépôt de l'exemple d'application Hello World sur votre ordinateur.

   git clone https://github.com/GoogleCloudPlatform/python-docs-samples
   

   Vous pouvez également télécharger l'exemple en tant que fichier zip et l'extraire.

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

      cd python-docs-samples/appengine/flexible/hello_world
   

Exécuter Hello World sur votre ordinateur local

Pour exécuter l'application Hello World sur votre ordinateur local :

macOS/Linux

Remarque : Ces instructions décrivent comment configurer un environnement virtuel dans Python 3. Pour les applications Python 2, configurez un environnement virtuel à l'aide de virtualenv.

1. Créez un environnement Python isolé :

   python3 -m venv env
   source env/bin/activate

2. Si vous n'êtes pas dans le répertoire qui contient l'exemple de code, accédez au répertoire qui contient l'exemple de code hello_world. Ensuite, installez les dépendances :

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

3. Exécutez l'application :

   python main.py

4. Dans votre navigateur Web, saisissez l'adresse suivante :

   http://localhost:8080

   Si vous utilisez Cloud Shell, cliquez sur Aperçu sur le Web dans la barre d'outils et sélectionnez Prévisualiser sur le port 8080.

Windows

Remarque : Ces instructions décrivent comment configurer un environnement virtuel dans Python 3. Pour les applications Python 2, configurez un environnement virtuel à l'aide de virtualenv.

Exécutez les packages Python à l'aide de PowerShell.

1. Localisez votre installation de PowerShell.
2. Cliquez avec le bouton droit sur le raccourci PowerShell et démarrez une session en tant qu'administrateur.
3. Créez un environnement Python isolé.

   python -m venv env
   .\env\Scripts\activate

4. Accédez au répertoire de votre projet et installez les dépendances : Si vous n'êtes pas dans le répertoire qui contient l'exemple de code, accédez au répertoire qui contient l'exemple de code hello_world. Ensuite, installez les dépendances :

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

5. Exécutez l'application :

   python main.py

6. Dans votre navigateur Web, saisissez l'adresse suivante :

   http://localhost:8080

Le message Hello World de l'exemple d'application s'affiche sur la page. Dans votre fenêtre de terminal, appuyez sur Ctrl+C pour quitter le serveur Web.

Déployer et exécuter Hello World sur App Engine

Pour déployer votre application dans l'environnement flexible App Engine :

1. Déployez l'application Hello World en exécutant la commande suivante à partir du répertoire hello_world :

   gcloud app deploy

   Obtenez plus d'informations sur les options facultatives.

   Options de commande gcloud courantes

   • Incluez l'option --version pour spécifier un ID qui identifie de manière unique cette version de votre application, sans quoi un ID est généré automatiquement. Exemple : --version [YOUR_VERSION_ID]
   • Incluez l'option --project pour spécifier un ID de projet Google Cloud différent de celui que vous avez initialisé par défaut dans l'outil gcloud. Exemple :--project [YOUR_PROJECT_ID]

   Exemple :

   gcloud app deploy --version pre-prod-5 --project my-sample-app

   Pour en savoir plus sur le déploiement de votre application à partir de la ligne de commande, consultez la section Tester et déployer votre application. Pour obtenir la liste de toutes les options de commande, consultez la documentation de référence gcloud app deploy.

   OK

2. Lancez votre navigateur et accédez à https://PROJECT_ID.REGION_ID.r.appspot.com pour afficher l'application.

   gcloud app browse

   Où PROJECT_ID représente l'ID de votre projet Google Cloud.

Cette fois, la page qui affiche le message Hello World est diffusée par un serveur Web exécuté sur une instance App Engine.

Félicitations ! Vous avez déployé votre première application App Engine dans l'environnement flexible App Engine !

Si vous rencontrez des erreurs lors du déploiement de votre application, consultez les conseils de dépannage.

Consultez les sections suivantes pour en savoir plus sur le nettoyage et découvrir les prochaines étapes que vous pourriez effectuer.

Effectuer un nettoyage

Vous pouvez supprimer votre projet Google Cloud. Cette démarche interrompra la facturation de toutes les ressources utilisées dans le projet.

Attention : La suppression d'un projet entraîne les effets décrits ci-dessous :
• 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.
1. In the Google Cloud console, go to the Manage resources page.

   Go to Manage resources

2. In the project list, select the project that you want to delete, and then click Delete.
3. In the dialog, type the project ID, and then click Shut down to delete the project.

Étapes suivantes

Découvrez la plate-forme dans son ensemble

Maintenant que vous savez comment développer et déployer des applications App Engine, vous pouvez explorer le reste de Google Cloud. Google Cloud CLI est déjà installé et vous permet d'interagir avec des produits tels que Cloud SQL, Cloud Storage, Firestore, etc.

Découvrez l'environnement flexible App Engine

Voici quelques articles qui vous aideront à mieux connaître App Engine :

• Présentation d'App Engine
• Routage des requêtes
• Gérer les requêtes
• Gérer les instances

Examen du code Hello World

Hello World est l'application App Engine la plus simple qui soit : elle ne contient qu'un seul service, ne possède qu'une seule version, et tout le code se trouve dans le répertoire racine de l'application. Cette section décrit chacun des fichiers de l'application en détail.

main.py

L'application Hello World est une application Flask basique à fichier unique.

from flask import Flask


app = Flask(__name__)


@app.route("/")
def hello() -> str:
    """Return a friendly HTTP greeting.

    Returns:
        A string with the words 'Hello World!'.
    """
    return "Hello World!"


if __name__ == "__main__":
    # This is used when running locally only. When deploying to Google App
    # Engine, a webserver process such as Gunicorn will serve the app.
    app.run(host="127.0.0.1", port=8080, debug=True)

app.yaml

Le fichier app.yaml décrit la configuration suivante pour votre application :

• Définit env: flex, qui indique que votre application utilise l'environnement flexible App Engine.

• Spécifie l'environnement d'exécution utilisé par l'application. Si vous excluez le paramètre runtime_version, App Engine utilise la dernière version de Python comme version par défaut pour votre application.

• L'élément entrypoint indique à App Engine comment démarrer l'application. Cette application utilise gunicorn pour diffuser l'application Python au lieu du serveur de développement de Flask (utilisé lors de l'exécution en local). La variable $PORT est définie par App Engine au démarrage de l'application. Pour en savoir plus sur entrypoint, consultez la section Démarrage de l'application.

Remarque : Il s'agit du moyen le plus simple d'exécuter Gunicorn. Cependant, cette approche exécute l'application avec un seul agent de blocage, ce qui signifie que toutes les demandes HTTP sont traitées en série, y compris les vérifications d'état. En pratique, l'application ne répond plus en cas de requêtes lentes. Pour en savoir plus sur la configuration de Gunicorn en production, consultez la section Configuration recommandée pour Gunicorn.

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

runtime: python
env: flex
entrypoint: gunicorn -b :$PORT main:app

runtime_config:
  operating_system: ubuntu22

# This sample incurs costs to run on the App Engine flexible environment.
# The settings below are to reduce costs during testing and are not appropriate
# for production use. For more information, see:
# https://cloud.google.com/appengine/docs/flexible/python/configuring-your-app-with-app-yaml
manual_scaling:
  instances: 1
resources:
  cpu: 1
  memory_gb: 0.5
  disk_size_gb: 10

• Pour plus d'informations sur le fonctionnement de l'environnement d'exécution Python, consultez la page Environnement d'exécution Python.

• Pour apprendre à concevoir votre application en tirant parti des versions et des services, consultez la page Présentation d'App Engine.

• Pour en savoir plus sur les paramètres de configuration d'App Engine, consultez la page Configurer une application avec app.yaml.

requirements.txt

Le fichier requirements.txt et le gestionnaire de paquets Python pip déclarent et installent les dépendances de l'application. Hello World requiert le framework Web Flask et le serveur WSGI Gunicorn.

Flask==3.0.3; python_version > '3.6'
Flask==2.3.3; python_version < '3.7'
Werkzeug==3.0.3; python_version > '3.6'
Werkzeug==2.3.7; python_version < '3.7'
gunicorn==22.0.0

requirements.txt définit les bibliothèques qui seront installées localement et lors du déploiement sur App Engine.