Guide de démarrage rapide pour Python dans l'environnement flexible App Engine

Guide de démarrage rapide pour 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

Python|Java|Node.js|Go|Ruby|PHP|.NET

Dans ce guide de démarrage rapide, vous allez apprendre à créer une petite application App Engine permettant d'afficher un court message.

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. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

4. Activez Cloud Build API.

   Activer l'API

5. Installez Google Cloud CLI.

6. Pour initialiser gcloudCLI, exécutez la commande suivante :

   gcloud init

7. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

8. Vérifiez que la facturation est activée pour votre projet Google Cloud.

9. Activez Cloud Build API.

   Activer l'API

10. Installez Google Cloud CLI.

11. Pour initialiser gcloudCLI, exécutez la commande suivante :

    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 tarifs.

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 Cloud Console. La région apparaît en haut de la page.

OK

Ce démarrage rapide présente une application Python simple, é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 simple pour Python 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

   Remarque : 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, procédez comme suit :

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 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 pour afficher l'application sur https://PROJECT_ID.REGION_ID.r.appspot.com

   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 Python dans un 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.

Nettoyer

Afin d'éviter que des frais ne vous soient facturés, vous pouvez supprimer votre projet Cloud pour interrompre la facturation de toutes les ressources utilisées dans le projet.

Attention : La suppression d'un projet aura les effets suivants :
• Tout le contenu du projet est supprimé. Si vous avez utilisé un projet existant pour les tâches de ce document, lorsque vous le supprimez, vous supprimez é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. Dans la console Google Cloud, accédez à la page Gérer les ressources.

   Accéder à la page Gérer les ressources

2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
3. Dans la boîte de dialogue, saisissez l'ID du projet, puis cliquez sur Arrêter pour supprimer le projet.

É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.

Pour apprendre pas à pas à créer une application qui utilise l'ensemble de la plate-forme et pas seulement App Engine, accédez à notre guide de démarrage rapide pour créer l'application Bookshelf.

En savoir plus sur l'environnement flexible App Engine

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

• Présentation d'App Engine
• Mode de routage des requêtes
• Mode de traitement des requêtes
• Mode de gestion des instances

Examiner le 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.

appengine/flexible/hello_world/main.py

Afficher sur GitHub

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello():
    """Return a friendly HTTP greeting."""
    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 de déploiement d'une application :

appengine/flexible/hello_world/app.yaml

Afficher sur GitHub

# 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:
  python_version: 3

# 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

Ici, le fichier app.yaml spécifie l'environnement d'exécution utilisé par l'application et définit env: flex, qui indique que l'application utilise l'environnement flexible.

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.

De plus, la section facultative runtime_config définit python_version sur Python 3. Si python_version n'est pas spécifié, Python 2 est utilisé par défaut. Vous pouvez également spécifier explicitement python_version: 2.

• 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

requirements.txt et le gestionnaire de packages Python pip servent à déclarer et à installer des dépendances d'application. Hello World requiert le framework Web Flask et le serveur WSGI Gunicorn.

appengine/flexible/hello_world/requirements.txt

Afficher sur GitHub

Flask==2.0.2
gunicorn==20.1.0

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