Creare un'app Python nell'ambiente flessibile di App Engine

Creare un'app Python nell'ambiente flessibile di App Engine

ID regione

REGION_ID è un codice abbreviato assegnato da Google in base alla regione selezionata quando crei l'app. Il codice non corrisponde a un paese o a una provincia, anche se alcuni ID regione possono sembrare simili ai codici di paesi e province di uso comune. Per le app create dopo febbraio 2020, REGION_ID.r è incluso negli URL di App Engine. Per le app esistenti create prima di questa data, l'ID regione è facoltativo nell'URL.

Scopri di più sugli ID regione.

Ok

Nota: se stai eseguendo il deployment di un nuovo servizio web Python su Google Cloud, consigliamo di iniziare con Cloud Run.

Questa guida rapida mostra come creare ed eseguire il deployment di un'app che visualizza un breve messaggio. Puoi utilizzare l'applicazione di esempio in questa guida rapida per qualsiasi versione supportata di Python, specificando la versione del runtime e il sistema operativo nel file app.yaml.

Prima di iniziare

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

Prerequisiti aggiuntivi

1. Inizializza la tua app App Engine con il tuo progetto e scegli la relativa area geografica:

   gcloud app create --project=[YOUR_PROJECT_ID]
   

   Quando richiesto, seleziona la regione in cui vuoi collocare l'applicazione App Engine.

   Attenzione: non puoi modificare la regione di un'app una volta impostata.

2. Installa quanto segue sulla tua macchina locale:

   • Scarica e installa Git.

• Esegui il seguente comando per installare il componente gcloud che include l'estensione App Engine per Python:

  gcloud components install app-engine-python
  

3. Prepara l'ambiente per lo sviluppo Python. Ti consigliamo di avere installato sul tuo sistema la versione più recente di Python, pip e altri strumenti correlati. Per le istruzioni, consulta la Guida alla configurazione dell'ambiente di sviluppo Python.

Località App Engine

App Engine è regionale, il che significa che l'infrastruttura che esegue le tue app si trova in una regione specifica e Google la gestisce in modo che sia disponibile in modo ridondante in tutte le zone della regione.

Soddisfare i requisiti di latenza, disponibilità o durabilità è uno dei fattori principali per la scelta della regione in cui vengono eseguite le app. In genere, puoi selezionare la regione più vicina agli utenti della tua app, ma devi prendere in considerazione le località in cui è disponibile App Engine, nonché le località degli altri prodotti e servizi Google Cloud utilizzati dalla tua app. L'utilizzo di servizi in più località può influire sulla latenza e sul prezzo della tua app.

Non puoi modificare la regione di un'app dopo averla impostata.

Nota: due posizioni, chiamate europe-west e us-central nei comandi App Engine e nella console Google Cloud, vengono chiamate europe-west1 e us-central1, rispettivamente, in altre parti della documentazione di Google.

Se hai già creato un'applicazione App Engine, puoi visualizzarne la regione effettuando una delle seguenti operazioni:

• Esegui il comando gcloud app describe.

• Apri la dashboard di App Engine nella console Google Cloud. La regione viene visualizzata nella parte superiore della pagina.

Ok

Questa guida rapida mostra l'app Python 3 più recente scritta con il framework web Flask che può essere dispiegato in App Engine. Anche se questo sample utilizza Flask, puoi utilizzare qualsiasi framework web che soddisfi i requisiti sopra indicati. I framework alternativi includono Django, Pyramid, Bottle e web.py.

scarica l'app Hello World

Abbiamo creato un'app Hello World per App Engine in modo che tu possa capire rapidamente come eseguire il deployment di un'app in Google Cloud.

1. Clona il repository dell'app di esempio Hello World sulla tua macchina locale.

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

   In alternativa puoi scaricare l'esempio come file ZIP ed estrarlo.

2. Passa alla directory che contiene il codice campione.

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

Esegui Hello World sulla tua macchina locale

Per eseguire l'applicazione Hello World nel computer locale:

Mac OS / Linux

Nota: queste istruzioni descrivono come configurare un ambiente virtuale in Python 3. Per le app Python 2, utilizza virtualenv per configurare un ambiente virtuale.

1. Crea un ambiente Python isolato:

   python3 -m venv env
   source env/bin/activate

2. Se non sei nella directory che contiene il codice campione, vai alla directory che contiene il codice campione hello_world. Poi installa le dipendenze:

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

3. Esegui l'applicazione:

   python main.py

4. Nel browser web, inserisci il seguente indirizzo:

   http://localhost:8080

   Se utilizzi Cloud Shell, nella barra degli strumenti fai clic su Anteprima web e seleziona Anteprima sulla porta 8080.

Windows

Nota: queste istruzioni descrivono come configurare un ambiente virtuale in Python 3. Per le app Python 2, utilizza virtualenv per configurare un ambiente virtuale.

Utilizza PowerShell per eseguire i pacchetti Python.

1. Individua l'installazione di PowerShell.
2. Fai clic con il tasto destro del mouse sulla scorciatoia di PowerShell e avvialo come amministratore.
3. Crea un ambiente Python isolato.

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

4. Naviga alla directory del progetto e installa le dipendenze. Se non ti trovi nella directory che contiene il codice campione, vai alla directory che contiene il codice campione hello_world. Poi installa le dipendenze:

   cd YOUR_SAMPLE_CODE_DIR
   pip install -r requirements.txt

5. Esegui l'applicazione:

   python main.py

6. Nel browser web, inserisci il seguente indirizzo:

   http://localhost:8080

Nella pagina viene visualizzato il messaggio Hello World dell'app di esempio. Nella finestra del terminale, premi Ctrl+C per uscire dal server web.

Esegui il deployment di Hello World e avviala in App Engine

Per eseguire il deployment dell'app nell'ambiente flessibile di App Engine:

1. Esegui il deployment dell'app Hello World eseguendo il comando seguente dalla directory hello_world:

   gcloud app deploy

   Scopri di più sui flag facoltativi.

   Flag comuni dei comandi gcloud

   • Includi il flag --version per specificare un ID che identifichi in modo univoco la versione della tua app, altrimenti ne verrà generato uno per te. Esempio: --version [YOUR_VERSION_ID]
   • Includi il flag --project per specificare un ID progetto Google Cloud alternativo rispetto a quello inizializzato come predefinito nello strumento gcloud. Esempio: --project [YOUR_PROJECT_ID]

   Esempio:

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

   Per scoprire di più sul deployment dell'app dalla riga di comando, consulta Testare e eseguire il deployment dell'app. Per un elenco di tutti i flag dei comandi, consulta la documentazione di riferimentogcloud app deploy.

   Ok

2. Avvia il browser per visualizzare l'app all'indirizzo https://PROJECT_ID.REGION_ID.r.appspot.com

   gcloud app browse

   dove PROJECT_ID rappresenta il tuo ID progetto Google Cloud.

Questa volta, la pagina che mostra il messaggio Hello World viene pubblicata da un server web in esecuzione su un'istanza App Engine.

Complimenti! Hai eseguito il deployment della tua prima app App Engine nell'ambiente flessibile di App Engine.

Se hai riscontrato errori durante il deployment dell'applicazione, consulta i suggerimenti per la risoluzione dei problemi.

Consulta le sezioni seguenti per informazioni sulla pulizia e sui possibili passaggi successivi che puoi intraprendere.

Esegui la pulizia

Per evitare addebiti, puoi eliminare il tuo progetto Google Cloud per interrompere la fatturazione per tutte le risorse utilizzate al suo interno.

Attenzione: l'eliminazione di un progetto ha i seguenti effetti:
• L'intero contenuto del progetto viene eliminato. Se hai utilizzato un progetto esistente per le attività descritte in questo documento, quando lo elimini elimini anche tutto il lavoro svolto nel progetto.
• Gli ID progetto personalizzati non sono più disponibili. Quando hai creato questo progetto, potresti aver creato un ID progetto personalizzato che vuoi utilizzare in futuro. Per conservare gli URL che utilizzano l'ID progetto, ad esempio un appspot.com URL, elimina le risorse selezionate all'interno del progetto anziché eliminare l'intero progetto.
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.

Passaggi successivi

Scopri l'intera piattaforma

Ora che sai come sviluppare e implementare app App Engine, puoi esplorare il resto di Google Cloud. Hai già installato Google Cloud CLI, che ti fornisce gli strumenti per interagire con prodotti come Cloud SQL, Cloud Storage, Firestore e altri ancora.

Scopri di più sull'ambiente flessibile di App Engine

Ecco alcuni argomenti che ti aiuteranno a continuare a imparare su App Engine:

• Panoramica di App Engine
• Routing delle richieste
• Gestione delle richieste
• Gestione delle istanze

Revisione del codice Hello World

Hello World è l'app App Engine più semplice possibile, in quanto contiene un solo servizio, ha una sola versione e tutto il codice si trova nella directory principale dell'app. Questa sezione descrive in dettaglio ogni file dell'app.

main.py

L'app Hello World è un'app Flask di base composta da un solo file.

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

Il file app.yaml descrive la seguente configurazione per la tua app:

• Imposta env: flex, a indicare che la tua app utilizza l'ambiente flessibile di App Engine.

• Specifica il runtime utilizzato dall'app. Se escludi l'impostazione runtime_version, App Engine utilizza la versione Python più recente come versione predefinita per l'app.

• entrypoint indica ad App Engine come avviare l'app. Questa app utilizza gunicorn per eseguire l'app Python come alternativa al server di sviluppo di Flask (utilizzato quando viene eseguita in locale). La variabile $PORT viene impostata da App Engine quando avvia l'app. Per ulteriori informazioni su entrypoint, consulta Avvio dell'app.

Nota: questo è il modo più semplice per avviare gunicorn. Tuttavia, questo approccio esegue l'applicazione con un singolo worker bloccante, il che significa che tutte le richieste HTTP vengono gestite in serie, inclusi i controlli dell'integrità. In pratica, l'applicazione non risponde in caso di richieste lente. Per maggiori dettagli su come configurare gunicorn per la produzione, consulta la sezione Configurazione consigliata di 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

• Per ulteriori informazioni sul funzionamento del runtime di Python, consulta Il runtime di Python.

• Per ulteriori dettagli su come progettare l'app in modo da sfruttare le versioni e i servizi, consulta Panoramica di App Engine.

• Per maggiori dettagli sulle impostazioni di configurazione per App Engine, consulta Configurare l'app con app.yaml.

requirements.txt

requirements.txt e il gestore dei pacchetti Python pip dichiarano e installano le dipendenze dell'applicazione. Hello World richiede Flask, un framework web, e Gunicorn, un server WSGI.

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 definisce le librerie che verranno installate sia localmente sia durante il deployment in App Engine.