Le app Django in esecuzione su App Engine standard si adattano in modo dinamico in base al traffico.
Questo tutorial presuppone che tu abbia familiarità con lo sviluppo web di Django. Se non hai mai sviluppato con Django, ti consigliamo di leggere la sezione su come scrivere la tua prima app Django prima di continuare.
Sebbene questo tutorial mostri Django in modo specifico, puoi utilizzare questa procedura di deployment con altri framework basati su Django, come Wagtail e Django CMS.
Questo tutorial utilizza Django 4, che richiede almeno Python 3.8. App Engine standard supporta Python 3.7 e versioni successive, incluso Python 3.8.
Obiettivi
In questo tutorial, imparerai a:
- Crea e connetti un database Cloud SQL.
- Crea e utilizza i valori dei secret di Secret Manager.
- Esegui il deployment di un'app Django in App Engine standard.
Costi
In questo documento utilizzi i seguenti componenti fatturabili di Google Cloud:
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il Calcolatore prezzi.
Prima di iniziare
- 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.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud SQL Admin API, Secret Manager, and Cloud Build APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud SQL Admin API, Secret Manager, and Cloud Build APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
- Se non l'hai ancora fatto, inizializza App Engine e seleziona la regione che preferisci:
gcloud app create
prepara l'ambiente
Clona un'app di esempio
Il codice dell'app di esempio Django si trova nel repository GoogleCloudPlatform/python-docs-samples su GitHub.
Puoi scaricare l'esempio come file ZIP ed estrarlo o clonare il repository sulla tua macchina locale:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Vai alla directory che contiene il codice di esempio:
Linux/macOS
cd python-docs-samples/appengine/standard_python3/django
Windows
cd python-docs-samples\appengine\standard_python3\django
Verifica la configurazione di 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 maggiori dettagli, consulta la guida all'ambiente di sviluppo Python.
Verifica di avere almeno la versione 3.8 di Python.
python -V
Dovresti visualizzare
Python 3.8.0
o una versione successiva.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 venv venv\scripts\activate pip install --upgrade pip pip install -r requirements.txt
Scarica il proxy di autenticazione Cloud SQL per connetterti a Cloud SQL dal computer locale
Quando viene eseguita il deployment, l'app utilizza il proxy di autenticazione Cloud SQL integrato nell'ambiente standard di App Engine per comunicare con l'istanza Cloud SQL. Tuttavia, per testare l'app localmente, devi installare e utilizzare una copia locale del proxy nell'ambiente di sviluppo. Per ulteriori dettagli, consulta la guida al proxy di autenticazione Cloud SQL.
Il proxy di autenticazione Cloud SQL utilizza l'API Cloud SQL per interagire con l'istanza SQL. Per farlo, è necessaria l'autenticazione dell'applicazione tramite la CLI gcloud.
Autentica e acquisisci le credenziali per l'API:
gcloud auth application-default login
Scarica e installa il proxy di autenticazione Cloud SQL sulla tua macchina locale.
Linux a 64 bit
- Scarica il proxy di autenticazione Cloud SQL:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.linux.amd64
- Rendi eseguibile il proxy di autenticazione Cloud SQL:
chmod +x cloud-sql-proxy
Linux a 32 bit
- Scarica il proxy di autenticazione Cloud SQL:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.linux.386
- Se il comando
curl
non viene trovato, eseguisudo apt install curl
e ripeti il comando di download. - Rendi eseguibile il proxy di autenticazione Cloud SQL:
chmod +x cloud-sql-proxy
macOS a 64 bit
- Scarica il proxy di autenticazione Cloud SQL:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.darwin.amd64
- Rendi eseguibile il proxy di autenticazione Cloud SQL:
chmod +x cloud-sql-proxy
Mac M1
- Scarica il proxy di autenticazione Cloud SQL:
curl -o cloud-sql-proxy https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.darwin.arm64
- Rendi eseguibile il proxy di autenticazione Cloud SQL:
chmod +x cloud-sql-proxy
Windows a 64 bit
Fai clic con il tasto destro del mouse su https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.x64.exe e seleziona Salva link come per scaricare il proxy di autenticazione Cloud SQL. Rinomina il file incloud-sql-proxy.exe
.Windows a 32 bit
Fai clic con il tasto destro del mouse su https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.x86.exe e seleziona Salva link come per scaricare il proxy di autenticazione Cloud SQL. Rinomina il file incloud-sql-proxy.exe
.Immagine Docker del proxy di autenticazione Cloud SQL
Il proxy di autenticazione Cloud SQL ha immagini contenitore diverse, ad esempio
distroless
,alpine
ebuster
. L'immagine del contenitore del proxy di autenticazione Cloud SQL predefinita utilizzadistroless
, che non contiene shell. Se hai bisogno di una shell o di strumenti correlati, scarica un'immagine basata sualpine
obuster
. Per ulteriori informazioni, consulta Immagini del contenitore del proxy di autenticazione Cloud SQL.Puoi eseguire il pull dell'immagine più recente sulla tua macchina locale utilizzando Docker con il seguente comando:
docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.14.1
Altro sistema operativo
Per altri sistemi operativi non inclusi qui, puoi compilare il proxy di autenticazione Cloud SQL dal codice sorgente.Puoi scegliere di spostare il download in una posizione comune, ad esempio una posizione su
PATH
o nella home directory. Se scegli di farlo, quando avvii il proxy di autenticazione Cloud SQL più avanti nel tutorial, ricordati di fare riferimento alla posizione scelta quando utilizzi i comandicloud-sql-proxy
.- Scarica il proxy di autenticazione Cloud SQL:
Crea servizi di supporto
Questo tutorial utilizza diversi servizi Google Cloud per fornire il database, lo spazio di archiviazione multimediale e lo spazio di archiviazione delle chiavi segrete che supportano il progetto Django di cui è stato eseguito il deployment. Questi servizi vengono implementati in una regione specifica. Per l'efficienza tra i servizi, tutti i servizi devono essere di cui viene eseguito il deployment nella stessa regione. Per ulteriori informazioni sulla regione più vicina a te, consulta Prodotti disponibili per regione.
Questo tutorial utilizza i meccanismi di hosting di asset statici integrati in App Engine standard.Configura un'istanza Cloud SQL per PostgreSQL
Django supporta ufficialmente più database relazionali, ma offre il supporto più completo per PostgreSQL. PostgreSQL è supportato da Cloud SQL, pertanto 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.
Crea l'istanza PostgreSQL:
Console
Nella console Google Cloud, vai alla pagina Istanze Cloud SQL.
Fai clic su Crea istanza.
Fai clic su Scegli PostgreSQL.
Per Versione SQL, scegli "Enterprise".
Per Preimpostazione di modifica, scegli "Sandbox".
Nel campo ID istanza, inserisci
INSTANCE_NAME
.Inserisci una password per l'utente postgres.
Mantieni i valori predefiniti per gli altri campi.
Fai clic su Crea istanza.
L'istanza sarà pronta per l'uso dopo alcuni minuti.
gcloud
Crea l'istanza PostgreSQL:
gcloud sql instances create INSTANCE_NAME \ --project PROJECT_ID \ --database-version POSTGRES_16 \ --tier db-n1-standard-2 \ --region REGION
Sostituisci quanto segue:
INSTANCE_NAME
: il nome dell'istanza Cloud SQLPROJECT_ID
: l'ID progetto Google CloudREGION
: la regione Google Cloud
La creazione dell'istanza e la sua disponibilità sono operazioni che richiedono alcuni minuti.
All'interno dell'istanza creata, crea un database:
Console
- Nella pagina dell'istanza, vai alla scheda Database.
- Fai clic su Crea database.
- Nella finestra di dialogo Nome database, inserisci
DATABASE_NAME
. - Fai clic su Crea.
gcloud
Crea il database nell'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.
Crea un utente di database:
Console
- Nella pagina dell'istanza, vai alla scheda Utenti.
- Fai clic su Aggiungi account utente.
- Nella finestra di dialogo Scegli la modalità di autenticazione, in "Autenticazione integrata":
- Inserisci il nome utente
DATABASE_USERNAME
. - Inserisci la password
DATABASE_PASSWORD
- Fai clic su Aggiungi.
gcloud
Crea l'utente nell'istanza creata di recente:
gcloud sql users create DATABASE_USERNAME \ --instance INSTANCE_NAME \ --password DATABASE_PASSWORD
Sostituisci
PASSWORD
con una password sicura.
Memorizzare i valori dei secret in Secret Manager
Ora che i servizi di supporto sono configurati, Django ha bisogno di informazioni su questi servizi. Invece di inserire questi valori direttamente nel codice sorgente di Django, questo tutorial utilizza Secret Manager per archiviare queste informazioni in modo sicuro.
Crea il file di ambiente Django come secret di Secret Manager
Memorizza le impostazioni necessarie per avviare Django in un file env protetto.
L'app di esempio utilizza l'API Secret Manager per recuperare il valore del segreto e il pacchetto django-environ
per caricare i valori nell'ambiente Django. Il secret è configurato per essere accessibile da App Engine standard.
Crea un file denominato
.env
, che definisce la stringa di connessione al database, il nome del bucket multimediale e un nuovo valoreSECRET_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
Archivia il secret in Secret Manager:
Console
Nella console Google Cloud, vai alla pagina Secret Manager.
Fai clic su Crea secret.
Nel campo Nome, inserisci
django_settings
.Nella finestra di dialogo Valore secret, incolla i contenuti del file
.env
.Fai clic su Crea secret.
Elimina il file locale per evitare le sostituzione delle impostazioni locali.
gcloud
Crea un nuovo secret,
django_settings
, con il valore del file.env
:gcloud secrets create django_settings --data-file .env
Elimina il file locale per impedire le sostituzione delle impostazioni locali:
rm .env
Configura l'accesso al secret:
Console
Fai clic sulla scheda Autorizzazioni.
Fai clic su Concedi accesso.
Nel campo Nuovi membri, inserisci
PROJECT_ID@appspot.gserviceaccount.com
e premiEnter
.Nel menu a discesa Ruolo, seleziona Accesso ai segreti di Secret Manager.
Fai clic su Salva.
gcloud
Concedi l'accesso al secret al account di servizio standard di App Engine:
gcloud secrets add-iam-policy-binding django_settings \ --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \ --role roles/secretmanager.secretAccessor
Nell'output, verifica che bindings
elenchi il nuovo account di servizio.
Esecuzione dell'applicazione nel computer locale
Con i servizi di supporto configurati, ora puoi eseguire l'app sul computer. Questa configurazione consente lo sviluppo locale, la creazione di un superutente e l'applicazione di migrazioni del database.
In un terminale separato, avvia il proxy di autenticazione Cloud SQL:
Linux/macOS
./cloud-sql-proxy PROJECT_ID:REGION:INSTANCE_NAME
Windows
cloud-sql-proxy.exe PROJECT_ID:REGION:INSTANCE_NAME
Questo passaggio stabilisce una connessione dal computer locale all'istanza Cloud SQL per scopi di test locale. Mantieni in esecuzione il proxy di autenticazione Cloud SQL per tutto il tempo in cui testi l'app in locale. L'esecuzione di questo processo in un terminale separato ti consente di continuare a lavorare durante l'esecuzione.
Nel terminale originale, 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
Imposta una variabile di ambiente per indicare che utilizzi il proxy di autenticazione Cloud SQL (questo valore è riconosciuto nel codice):
Linux/macOS
export USE_CLOUD_SQL_AUTH_PROXY=true
Windows
set USE_CLOUD_SQL_AUTH_PROXY=true
Esegui le migrazioni di 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
Avvia il server web Django:
python manage.py runserver 8080
Nel browser, vai alla pagina http://localhost:8080.
Se sei in Cloud Shell, fai clic sul pulsante Anteprima web e seleziona Anteprima sulla porta 8080.
La pagina mostra il seguente testo: "Hello, world. Ti trovi nell'indice dei sondaggi." Il server web Django in esecuzione sul computer carica le pagine dell'app di esempio.
Premi
Ctrl
/Cmd
+C
per interrompere il server web locale.
Utilizzare la Console di amministrazione di Django
Per accedere alla Console di amministrazione di Django, devi creare un superutente. Poiché hai una connessione accessibile localmente al database, puoi eseguire i comandi di gestione:
Crea un superutente. Ti verrà chiesto di inserire un nome utente, un indirizzo email e una password.
python manage.py createsuperuser
Avvia un server web locale:
python manage.py runserver
Nel browser, vai all'indirizzo http://localhost:8000/admin.
Accedi al sito di amministrazione utilizzando il nome utente e la password che hai utilizzato quando hai eseguito
createsuperuser
.
Esegui il deployment dell'app nell'ambiente standard di App Engine
Dopo aver configurato tutti i servizi di supporto e aver testato l'applicazione localmente, ora puoi eseguire il deployment dell'app in App Engine standard:
- Carica l'app eseguendo il seguente comando, che esegue il deployment dell'app come descritto in
app.yaml
e imposta la versione appena di cui è stato eseguito il deployment come predefinita, in modo che venga utilizzato per tutto il nuovo traffico:gcloud app deploy
- Conferma le impostazioni digitando "yes" quando richiesto.
- Attendi il messaggio che ti informa del completamento dell'aggiornamento.
- Apri
app.yaml
e aggiorna il valore diAPPENGINE_URL
con l'URL di cui è stato eseguito il deployment:... env_variables: APPENGINE_URL: https://PROJECT_ID.uc.r.appspot.com
- Carica le modifiche alla configurazione:
gcloud app deploy
Eseguire l'app di cui è stato eseguito il deployment
L'app è stata dispiata ed è ora accessibile:
Apri il sito web di cui è stato eseguito il deployment:
gcloud app browse
In alternativa, visualizza l'URL e apri manualmente:
gcloud app describe --format "value(defaultHostname)"
La richiesta viene gestita da un server web in esecuzione nell'ambiente standard di App Engine.
Aggiornamento dell'applicazione
Per aggiornare l'applicazione, apporta le modifiche al codice, quindi esegui di nuovo il comando gcloud app deploy
.
Il deployment crea una nuova versione della tua app e la promuove a versione predefinita. Le versioni precedenti dell'app rimangono invariate. Tutte queste versioni dell'app sono risorse fatturabili. Per ridurre i costi, elimina le versioni non predefinite dell'app.
Configurazione per la produzione
Ora hai un deployment di Django funzionante, ma puoi eseguire ulteriori passaggi per assicurarti che la tua applicazione sia pronta per la produzione.
Disattivare il debug
Verifica che la variabile DEBUG
in mysite/settings.py
sia impostata su False
. In questo modo,
viene impedita la visualizzazione all'utente di pagine di errore dettagliate, che potrebbero rivelare informazioni sulle configurazioni.
Limita i privilegi degli utenti del database
Tutti gli utenti creati utilizzando Cloud SQL dispongono dei privilegi associati al ruolo cloudsqlsuperuser
: CREATEROLE
, CREATEDB
e LOGIN
.
Per impedire all'utente del database Django di disporre di queste autorizzazioni, crealo manualmente in PostgreSQL. Devi avere installato il psql
terminale interattivo o utilizzare Cloud Shell, su cui questo strumento è preinstallato.
Console
-
In the Google Cloud console, activate Cloud Shell.
In Cloud Shell, utilizza il terminale integrato per connetterti all'istanza
INSTANCE_NAME
:gcloud sql connect INSTANCE_NAME --user postgres
Inserisci la password dell'utente postgres.
Al momento stai utilizzando
psql
. Dovresti visualizzare il promptpostgres=>
.Crea un utente:
CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
Sostituisci
PASSWORD
con una password casuale e univoca.Concedi i diritti completi sul nuovo database al nuovo utente:
GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
Uscita
psql
:\q
gcloud
Avvia una connessione all'istanza SQL:
gcloud sql connect INSTANCE_NAME --user postgres
Sostituisci
INSTANCE_NAME
con l'istanza Cloud SQL creata.Inserisci la password dell'utente postgres.
Al momento stai utilizzando
psql
. Dovresti visualizzare il promptpostgres=>
.Crea un utente:
CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
Concedi i diritti completi sul nuovo database al nuovo utente:
GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
Uscita
psql
:\q
comprendi il codice
Applicazione di esempio
L'app di esempio Django è stata creata utilizzando gli strumenti Django standard. I seguenti comandi creano il progetto e l'app per i 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 Scrivere la tua prima app Django (Parte 1 e Parte 2).
Secret di Secret Manager
Il file settings.py
contiene il codice che utilizza l'API Python di Secret Manager per recuperare la versione più recente del segreto denominato e importarlo nell'ambiente (utilizzando django-environ
):
Il segreto viene utilizzato per archiviare più valori segreti al fine di ridurre il numero di segreti diversi da configurare.
Configurazioni CSRF
Django ha una protezione integrata contro la falsificazione delle richieste tra siti (CSRF). A partire da Django 4.0, le modifiche al funzionamento di questa funzionalità rendono importante indicare a Django qual è l'URL in cui è ospitato, in modo che possa offrire le migliori protezioni per gli utenti che inviano dati.
Fornisci l'URL dell'app come variabile di ambiente nel file settings.py
.
Si tratta del valore utilizzato da Django per le impostazioni pertinenti.
Sostituzioni di 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
localmente può essere utile per i test locali (ad es. lo sviluppo locale in un database SQLite o altre impostazioni locali).
Connessione al database
Il file settings.py
contiene la configurazione del database SQL. Utilizza l'helper env.db()
da django-environ
per caricare la stringa di connessione impostata in DATABASE_URL
nell'impostazione DATABASES
.
Quando l'applicazione viene eseguita localmente e utilizzi il proxy di autenticazione Cloud SQL per accedere al database ospitato, il flag USE_CLOUD_SQL_AUTH_PROXY
regola le impostazioni del database in modo da utilizzare il proxy.
Contenuti statici ospitati
Il file app.yaml
contiene informazioni di configurazione per il deployment in App Engine.
Questo file app.yaml
specifica che App Engine serve file statici
dalla directory static/
:
Quando l'app viene eseguita localmente con DEBUG
abilitato, questi file vengono pubblicati localmente da Django:
Esegui la pulizia
Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.
Elimina il progetto
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Passaggi successivi
- Scopri come configurare PostgreSQL per la produzione
- Scopri di più su Django su Google Cloud