Esecuzione di Django nell'ambiente flessibile di App Engine

prepara l'ambiente

Clonare un'app di esempio

Il codice per l'app Django di esempio si trova nel repository GoogleCloudPlatform/python-docs-samples su GitHub.

1. Puoi scaricare l'esempio come file ZIP ed estrarlo oppure clonare il repository sulla tua macchina locale:

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

2. Vai alla directory che contiene il codice di esempio:

   Linux/macOS

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

   Windows

   cd python-docs-samples\appengine\flexible\django_cloudsql
   

Conferma la configurazione Python

Questo tutorial si basa su Python per eseguire l'applicazione di esempio sulla tua macchina. Il codice campione richiede anche l'installazione di dipendenze

Per ulteriori dettagli, consulta la guida all'ambiente di sviluppo di Python.

1. Verifica che il tuo Python sia almeno la versione 3.7.

    python -V
   

   Dovresti vedere Python 3.7.3 o un valore superiore.

2. Crea un ambiente virtuale Python e installa le dipendenze:

   Linux/macOS

   python -m venv venv
   source venv/bin/activate
   pip install --upgrade pip
   pip install -r requirements.txt
   

   Windows

   python -m venv env
   venv\scripts\activate
   pip install --upgrade pip
   pip install -r requirements.txt
   

Scarica il proxy Cloud SQL Auth per connetterti a Cloud SQL dalla tua macchina locale

Una volta eseguito il deployment, l'applicazione utilizza il proxy Cloud SQL Auth integrato nell'ambiente flessibile di App Engine per comunicare con l'istanza Cloud SQL. Tuttavia, per testare la tua app localmente, devi installare e utilizzare una copia locale del proxy nel tuo ambiente di sviluppo. Per maggiori dettagli, consulta la guida al proxy Cloud SQL Auth.

Il proxy Cloud SQL Auth utilizza l'API Cloud SQL per interagire con la tua istanza SQL. A questo scopo, è necessaria l'autenticazione dell'applicazione tramite gcloud.

1. Autentica e acquisisci le credenziali per l'API:

   gcloud auth application-default login
   

2. Scarica e installa il proxy Cloud SQL Auth sulla tua macchina locale.

   Linux a 64 bit

   1. Scarica il proxy Cloud SQL Auth:

      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy

   2. Rendi il eseguibile del proxy Cloud SQL Auth eseguibile:

      chmod +x cloud_sql_proxy

   Linux a 32 bit

   1. Scarica il proxy Cloud SQL Auth:

      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy

   2. Se il comando wget non viene trovato, esegui sudo apt-get install wget e ripeti il comando di download.
   3. Rendi il eseguibile del proxy Cloud SQL Auth eseguibile:

      chmod +x cloud_sql_proxy

   macOS a 64 bit

   1. Scarica il proxy Cloud SQL Auth:

      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64

   2. Rendi il eseguibile del proxy Cloud SQL Auth eseguibile:

      chmod +x cloud_sql_proxy

   macOS a 32 bit

   1. Scarica il proxy Cloud SQL Auth:

      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386

   2. Rendi il eseguibile del proxy Cloud SQL Auth eseguibile:

      chmod +x cloud_sql_proxy

   Mac M1

   1. Scarica il proxy Cloud SQL Auth:

        curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.arm64
        

   2. Rendi il eseguibile del proxy Cloud SQL Auth eseguibile:

        chmod +x cloud_sql_proxy
        

   Windows a 64 bit

   Fai clic con il pulsante destro del mouse su https://dl.google.com/cloudsql/cloud_sql_proxy_x64.exe e seleziona Salva link con nome per scaricare il proxy Cloud SQL Auth. Rinomina il file come cloud_sql_proxy.exe.

   Windows a 32 bit

   Fai clic con il pulsante destro del mouse su https://dl.google.com/cloudsql/cloud_sql_proxy_x86.exe e seleziona Salva link con nome per scaricare il proxy Cloud SQL Auth. Rinomina il file come cloud_sql_proxy.exe.

   Immagine Docker proxy Cloud SQL Auth

   Per convenienza, diverse immagini container che contengono il proxy di autenticazione Cloud SQL sono disponibili su GitHub nel repository proxy di Cloud SQL Auth. Puoi estrarre l'immagine più recente sulla tua macchina locale utilizzando Docker con il seguente comando:

   docker pull gcr.io/cloudsql-docker/gce-proxy:1.30.1
   

   Altro sistema operativo

   Per altri sistemi operativi non inclusi, puoi compilare il proxy di autenticazione Cloud SQL dall'origine.

   Puoi scegliere di spostare il download in un punto comune, ad esempio una posizione in PATH o nella tua directory home. Se scegli di farlo, quando avvii il proxy di autenticazione Cloud SQL più avanti nel tutorial, ricorda di fare riferimento alla località scelta quando utilizzi i comandi cloud_sql_proxy.

Crea servizi di supporto

Questo tutorial utilizza diversi servizi Google Cloud per fornire il database, l'archiviazione multimediale e l'archiviazione segreta che supportano il progetto Django di cui è stato eseguito il deployment. Il deployment di questi servizi si svolge in un'area geografica specifica. Per ottimizzare l'efficienza tra i servizi, devi eseguire il deployment di tutti i servizi nella stessa area geografica. Per ulteriori informazioni sull'area geografica più vicina a te, consulta Prodotti disponibili per area geografica.

Configurare un'istanza Cloud SQL per PostgreSQL

Django supporta ufficialmente più database relazionali, ma offre il maggiore supporto per PostgreSQL. PostgreSQL è supportato da Cloud SQL, quindi questo tutorial sceglie di utilizzare questo tipo di database.

La sezione seguente descrive la creazione di un'istanza, un database e un utente di database PostgreSQL per l'app.

1. Crea l'istanza PostgreSQL:

   Console

   1. In Cloud Console, vai alla pagina Istanze Cloud SQL.

      Vai alla pagina Istanze Cloud SQL

   2. Fai clic su Crea istanza.

   3. Fai clic su PostgreSQL.

   4. Nel campo ID istanza, inserisci INSTANCE_NAME.

   5. Inserisci una password per l'utente postgres.

   6. Mantieni i valori predefiniti per gli altri campi.

   7. Fai clic su Crea.

   Sono necessari alcuni minuti per creare l'istanza e prima che sia pronta per l'utilizzo.

   gcloud

   • Crea l'istanza PostgreSQL:

     gcloud sql instances create INSTANCE_NAME \
         --project PROJECT_ID \
         --database-version POSTGRES_13 \
         --tier db-f1-micro \
         --region REGION
     

   Sostituisci quanto segue:

   • INSTANCE_NAME: nome dell'istanza Cloud SQL
   • PROJECT_ID: l'ID progetto di Google Cloud
   • REGION: l'area geografica Google Cloud

   Sono necessari alcuni minuti per creare l'istanza e prima che sia pronta per l'utilizzo.

2. All'interno dell'istanza creata, crea un database:

   Console

   1. Nella pagina dell'istanza, vai alla scheda Database.
   2. Fai clic su Crea database.
   3. Nella finestra di dialogo Nome database, inserisci DATABASE_NAME.
   4. Fai clic su Crea.

   gcloud

   • Crea il database all'interno dell'istanza creata di recente:

     gcloud sql databases create DATABASE_NAME \
         --instance INSTANCE_NAME
     

     Sostituisci DATABASE_NAME con un nome per il database all'interno dell'istanza.

3. Crea un utente del database:

   Console

   1. Nella pagina dell'istanza, vai alla scheda Utenti.
   2. Fai clic su Add User Account (Aggiungi account utente).
   3. Nella finestra di dialogo Aggiungi un account utente all'istanza in "Autenticazione integrata":
   4. Inserisci il nome utente DATABASE_USERNAME.
   5. Inserisci la password DATABASE_PASSWORD
   6. Fai clic su Aggiungi.

   gcloud

   • Crea l'utente all'interno dell'istanza creata di recente:

     gcloud sql users create DATABASE_USERNAME \
         --instance INSTANCE_NAME \
         --password DATABASE_PASSWORD
     

     Sostituisci PASSWORD con una password sicura.

Configurare un bucket Cloud Storage

Puoi archiviare risorse statiche incluse di Django e i contenuti multimediali caricati dagli utenti nella memoria di oggetti ad alta disponibilità utilizzando Cloud Storage. Il pacchetto django-storages[google] gestisce l'interazione di Django con questo backend di archiviazione.

Archivia valori di secret in Secret Manager

Ora che i servizi di supporto sono configurati, Django ha bisogno di informazioni su questi servizi. Anziché inserire questi valori direttamente nel codice sorgente di Django, questo tutorial utilizza Secret Manager per archiviare queste informazioni in modo sicuro.

Crea file di ambiente Django come secret di Secret Manager

Archivia le impostazioni necessarie per avviare Django in un file env protetto. L'app di esempio utilizza l'API Secret Manager per recuperare il valore secret e il pacchetto django-environ per caricare i valori nell'ambiente Django. Il secret è configurato per essere accessibile da App Engine flessibile.

1. Crea un file denominato .env, definendo la stringa di connessione al database, il nome del bucket multimediale e un nuovo valore SECRET_KEY:

   echo DATABASE_URL=postgres://DATABASE_USERNAME:DATABASE_PASSWORD@//cloudsql/PROJECT_ID:REGION:INSTANCE_NAME/DATABASE_NAME > .env
   echo GS_BUCKET_NAME=PROJECT_ID_MEDIA_BUCKET >> .env
   echo SECRET_KEY=$(cat /dev/urandom | LC_ALL=C tr -dc '[:alpha:]'| fold -w 50 | head -n1) >> .env
   

2. Archivia il secret in Secret Manager:

   Console

   1. In Cloud Console, vai alla pagina di Secret Manager.

      Vai alla pagina Secret Manager

   2. Fai clic su Crea secret.

   3. Nel campo Nome, inserisci django_settings.

   4. Nella finestra di dialogo Valore segreto, incolla il contenuto del file .env.

   5. Fai clic su Crea secret.

   6. Elimina il file locale per evitare sostituzioni di impostazioni locali.

   gcloud

   1. Crea un nuovo secret, django_settings, con il valore del file .env:

      gcloud secrets create django_settings --data-file .env
      

   2. Per confermare la creazione del secret, controlla:

      gcloud secrets describe django_settings
      
      gcloud secrets versions access latest --secret django_settings
      

   3. Elimina il file locale per evitare sostituzioni delle impostazioni locali:

      rm .env
      

3. Configura l'accesso al secret:

   Console

   1. Fai clic sulla scheda Autorizzazioni.
   2. Fai clic su Aggiungi.
   3. Nel campo Nuovi membri, inserisci PROJECT_ID@appspot.gserviceaccount.com, quindi premi Enter.
   4. Nel menu a discesa Ruolo, seleziona Accesso segreto Secret Manager.
   5. Fai clic su Salva.

   gcloud

   1. Concedi l'accesso al secret all'account di servizio flessibile di App Engine:

      gcloud secrets add-iam-policy-binding django_settings \
          --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \
          --role roles/secretmanager.secretAccessor
      

Esecuzione dell'applicazione nel computer locale

Dopo aver configurato i servizi di supporto, ora puoi eseguire l'app sul tuo computer. Questa configurazione consente lo sviluppo locale, la creazione di un super user e l'applicazione di migrazioni dei database.

1. In un terminale separato, avvia il proxy di autenticazione Cloud SQL:

   Linux/macOS

   ./cloud_sql_proxy -instances="PROJECT_ID:REGION:INSTANCE_NAME"=tcp:5432
   

   Windows

   cloud_sql_proxy.exe -instances="PROJECT_ID:REGION:INSTANCE_NAME"=tcp:5432
   

   Questo passaggio stabilisce una connessione dal computer locale alla tua istanza Cloud SQL a scopo di test locale. Mantieni il proxy Cloud SQL Auth in esecuzione per tutto il tempo per testare l'app localmente. L'esecuzione di questo processo in un terminale separato ti consente di continuare a lavorare durante l'esecuzione del processo.

2. In un nuovo terminale, imposta l'ID progetto localmente (utilizzato dall'API Secret Manager):

   Linux/macOS

     export GOOGLE_CLOUD_PROJECT=PROJECT_ID
   

   Windows

     set GOOGLE_CLOUD_PROJECT=PROJECT_ID
   

3. Imposta una variabile di ambiente per indicare che utilizzi il proxy Cloud SQL Auth (questo valore è riconosciuto nel codice):

   Linux/macOS

     export USE_CLOUD_SQL_AUTH_PROXY=true
   

   Windows

     set USE_CLOUD_SQL_AUTH_PROXY=true
   

4. Esegui le migrazioni Django per configurare i modelli e gli asset:

   python manage.py makemigrations
   python manage.py makemigrations polls
   python manage.py migrate
   python manage.py collectstatic
   

5. Avvia il server web di Django:

   python manage.py runserver
   

6. Nel browser, vai alla pagina http://localhost:8000.

   Nella pagina viene visualizzato il seguente testo: "Hello world. Sei nell'indice dei sondaggi." Il server web di Django in esecuzione sul computer fornisce le pagine di esempio dell'app.

7. Premi Ctrl/Cmd+C per arrestare il server web locale.

Utilizzare la Console di amministrazione Django

Per accedere alla Console di amministrazione di Django devi creare un super user. Poiché hai una connessione accessibile in locale al database, puoi eseguire comandi di gestione:

1. Crea un super user. Ti verrà chiesto di inserire nome utente, indirizzo email e password.

   python manage.py createsuperuser
   

2. Avvia un server web locale:

   python manage.py runserver
   

3. Nel browser, vai alla pagina http://localhost:8000/admin.

4. Accedi al sito di amministrazione utilizzando il nome utente e la password che hai utilizzato quando hai eseguito createsuperuser.

Eseguire il deployment dell'app nell'ambiente flessibile di App Engine

Con tutti i servizi di supporto configurati e l'applicazione testata in locale, puoi eseguire il deployment dell'app in App Engine flessibile:

1. Apri app.yaml e aggiorna il valore cloud_sql_instances con la stringa di istanza Cloud SQL:

   ...
   beta_settings:
       cloud_sql_instances: PROJECT_ID:REGION:INSTANCE_NAME
   

2. Carica l'app eseguendo questo comando, che esegue il deployment dell'app come descritto in app.yaml e imposta la versione di cui hai appena eseguito il deployment come versione predefinita, consentendo di gestire tutto il nuovo traffico:

   gcloud app deploy

3. Conferma le impostazioni digitando "yes" (sì) quando richiesto.
4. Attendi il messaggio che ti comunica che l'aggiornamento è stato completato.

Esecuzione dell'app di cui hai eseguito il deployment

Il deployment dell'app è stato eseguito e ora puoi accedervi:

• Apri il sito web di cui hai eseguito il deployment:

  gcloud app browse
  

• In alternativa, visualizza l'URL e aprilo manualmente:

  gcloud app describe --format "value(defaultHostname)"
  

La tua richiesta viene gestita da un server web in esecuzione nell'ambiente flessibile di App Engine.

Aggiornamento dell'applicazione

Per aggiornare la tua applicazione, apporta modifiche al codice, quindi esegui di nuovo il comando gcloud app deploy.

Il deployment crea una nuova versione dell'app e la promuove alla versione predefinita. Vengono mantenute le versioni precedenti dell'app e le istanze della macchina virtuale (VM) associate. Tutte queste versioni di app e istanze VM sono risorse fatturabili. Per ridurre i costi, elimina le versioni non predefinite dell'app.

Configurazione per la produzione in corso...

Ora hai un deployment Django funzionante, ma ci sono ulteriori passaggi che puoi seguire per assicurarti che la tua applicazione sia pronta per la produzione.

Disattiva debug

Verifica che la variabile DEBUG in mysite/settings.py sia impostata su False. In questo modo, non sarà possibile mostrare all'utente pagine di errore dettagliate contenenti informazioni sulle configurazioni.

Limita i privilegi utente del database

Tutti gli utenti creati tramite Cloud SQL hanno i privilegi associati al ruolo cloudsqlsuperuser: CREATEROLE, CREATEDB e LOGIN.

Per impedire che l'utente del database Django abbia queste autorizzazioni, crea manualmente l'utente in PostgreSQL. Dovrai avere installato il terminale interattivo di psql oppure utilizzare Cloud Shell su cui è preinstallato questo strumento.

Comprendere il codice

Applicazione di esempio

L'app di esempio Django è stata creata usando gli strumenti standard Django. I seguenti comandi creano il progetto e l'app Sondaggi:

django-admin startproject mysite
python manage.py startapp polls

Le visualizzazioni di base, i modelli e le configurazioni dei percorsi sono stati copiati da Scrittura della prima app Django (Parte 1 e Parte 2).

Secret di Secret Manager

Il file settings.py contiene il codice che utilizza l'API Secret Manager Python per recuperare l'ultima versione del secret denominato e eseguirne il pull nell'ambiente (utilizzando django-environ):

env = environ.Env(DEBUG=(bool, False))
env_file = os.path.join(BASE_DIR, ".env")

if os.path.isfile(env_file):
    # Use a local secret file, if provided

    env.read_env(env_file)
# ...
elif os.environ.get("GOOGLE_CLOUD_PROJECT", None):
    # Pull secrets from Secret Manager
    project_id = os.environ.get("GOOGLE_CLOUD_PROJECT")

    client = secretmanager.SecretManagerServiceClient()
    settings_name = os.environ.get("SETTINGS_NAME", "django_settings")
    name = f"projects/{project_id}/secrets/{settings_name}/versions/latest"
    payload = client.access_secret_version(name=name).payload.data.decode("UTF-8")

    env.read_env(io.StringIO(payload))
else:
    raise Exception("No local .env or GOOGLE_CLOUD_PROJECT detected. No secrets found.")

Il secret viene utilizzato per archiviare più valori del secret per ridurre il numero di diversi secret da configurare.

Sostituzioni secret locali

Se nel file system locale viene trovato un file .env, viene utilizzato al posto del valore di Secret Manager. La creazione di un file .env a livello locale può essere utile per i test locali (ad es., sviluppo locale rispetto a un database SQLite o altre impostazioni locali).

Connessione al database

Il file settings.py contiene la configurazione per il database SQL. Se configuri USE_CLOUD_SQL_AUTH_PROXY, l'impostazione DATABASES viene modificata per dedurre l'uso del proxy di autenticazione Cloud SQL.

# Use django-environ to parse the connection string
DATABASES = {"default": env.db()}

# If the flag as been set, configure to use proxy
if os.getenv("USE_CLOUD_SQL_AUTH_PROXY", None):
    DATABASES["default"]["HOST"] = "127.0.0.1"
    DATABASES["default"]["PORT"] = 5432

Statico archiviato su cloud

Il file settings.py utilizza inoltre django-storages per integrare il bucket multimediale di Cloud Storage direttamente nel progetto:

# Define static storage via django-storages[google]
GS_BUCKET_NAME = env("GS_BUCKET_NAME")
STATIC_URL = "/static/"
DEFAULT_FILE_STORAGE = "storages.backends.gcloud.GoogleCloudStorage"
STATICFILES_STORAGE = "storages.backends.gcloud.GoogleCloudStorage"
GS_DEFAULT_ACL = "publicRead"

App Engine app.yaml

Il file app.yaml contiene le informazioni di configurazione per il deployment nell'ambiente flessibile:

runtime: python
env: flex
entrypoint: gunicorn -b :$PORT mysite.wsgi

beta_settings:
    cloud_sql_instances: PROJECT_ID:REGION:INSTANCE_NAME

runtime_config:
  python_version: 3