Riferimento app.yaml 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.

Configura le impostazioni dell'app App Engine nel file app.yaml. Questo file specifica in che modo i percorsi URL corrispondono ai gestori delle richieste e ai file statici. Il file app.yaml contiene anche informazioni sul codice della tua app, ad esempio il runtime e l'identificatore della versione più recente.

Ogni servizio nella tua app ha il proprio file app.yaml, che funge da descrittore per il suo implementazione. Devi prima creare il file app.yaml per il servizio default prima di poter creare ed eseguire il deployment di file app.yaml per servizi aggiuntivi all'interno della tua app.

Struttura delle directory

Per scoprire di più sulla strutturazione di più servizi nella tua app, consulta Strutturare i servizi web in App Engine.

Esempio

Di seguito è riportato un esempio di file app.yaml per un'applicazione Python 2:

runtime: python27
api_version: 1
threadsafe: true

handlers:
- url: /
  script: home.app

- url: /index\.html
  script: home.app

- url: /stylesheets
  static_dir: stylesheets

- url: /(.*\.(gif|png|jpg))$
  static_files: static/\1
  upload: static/.*\.(gif|png|jpg)$

- url: /admin/.*
  script: admin.app
  login: admin

- url: /.*
  script: not_found.app

Una direttiva script: può contenere un percorso del file che termina con .py, il che significa che lo script utilizza CGI, oppure un percorso del modulo Python, con i nomi dei pacchetti separati da punti, il che significa che lo script utilizza WSGI.

Sintassi

La sintassi di app.yaml è il formato YAML.

Il formato YAML supporta i commenti. Una riga che inizia con il carattere cancelletto (#) viene ignorata:

# This is a comment.

I pattern di URL e percorsi file utilizzano la sintassi delle espressioni regolari estese POSIX, esclusi gli elementi di confronto e le classi di confronto. I riferimenti a ritroso alle corrispondenze raggruppate (ad es. \1) sono supportati, così come queste estensioni Perl: \w \W \s \S \d \D.

Elementi di runtime e app

Elemento Descrizione
application

L'approccio consigliato è rimuovere l'elemento application dal file app.yaml e utilizzare un flag della riga di comando per specificare l'ID applicazione:

  • Per utilizzare il comando gcloud app deploy, devi specificare il flag --project:
    gcloud app deploy --project [YOUR_PROJECT_ID]

Per ulteriori informazioni sull'utilizzo di questi comandi, consulta Esecuzione del deployment dell'app.

L'ID applicazione è l'ID progetto della console Google Cloud specificato quando hai creato l'applicazione nella console Google Cloud.

api_version

Obbligatorio. La versione dell'API nell'ambiente di runtime specificato utilizzata dalla tua app.

Questo campo è obsoleto nei runtime App Engine più recenti.

Quando Google annuncia il supporto di una nuova versione dell'API di un ambiente di runtime, l'app di cui è stato eseguito il deployment continuerà a utilizzare quella per cui è stata scritta. Per eseguire l'upgrade dell'app a una nuova versione dell'API, modifica questo valore e poi esegui nuovamente il deployment dell'app in App Engine. Quando specifichi il valore 1, viene utilizzato l'ambiente di runtime supportato più recente ogni volta che esegui il deployment dell'app (attualmente ).

Al momento, App Engine ha una versione dell'ambiente di runtime python27:1

auto_id_policy Facoltativo. Se imposti automaticamente gli identificatori delle entità, puoi modificare il metodo impiegato impostando il criterio di ID automatico. Di seguito sono riportate le opzioni valide:
default
Valore predefinito. Utilizza ID automatici sparsi, ovvero numeri interi grandi e ben distribuiti, sufficientemente piccoli da essere rappresentati da numeri in virgola mobile a 64 bit.
legacy
In una release futura, l'opzione precedente verrà ritirata e alla fine verrà rimossa. Per ulteriori informazioni, consulta il post del blog che annuncia questa modifica.
builtins

Facoltativo. L'SDK Python 2 include una serie di gestori integrati per le funzioni comuni delle applicazioni. L'istruzione builtins ti consente di includere gestori specifici in app.yaml.

Questo campo è obsoleto nel runtime di Python 3.

Puoi utilizzare i seguenti gestori integrati:

appstats
Attiva Appstats in /_ah/stats/, che puoi utilizzare per misurare il rendimento della tua applicazione. Per utilizzare Appstats, devi anche installare il registratore di eventi.
deferred
Attiva il gestore differito in /_ah/queue/deferred. Questo comando integrato consente agli sviluppatori di utilizzare deferred.defer() per semplificare la creazione delle attività della coda di lavoro.
remote_api
Attiva la funzionalità remote_api integrata in /_ah/remote_api/. Questo valore predefinito consente alle applicazioni remote con le credenziali appropriate di accedere al datastore da remoto.
Esempio:
builtins:
- deferred: on
- appstats: on

L'istruzione builtins è un'istanza speciale dell'istruzione includes. Ogni direttiva builtin è equivalente, in Python, a una direttiva includes con un percorso espanso. Ad esempio:

builtins:
- name: on

È equivalente a:

includes:
- $PYTHON_LIB/google/appengine/ext/builtins/name/

Quando utilizzi builtins nel file app.yaml, tutti gli handler definiti nel file include.yaml predefinito sostituiranno gli eventuali handler definiti nel file app.yaml. Tuttavia, se includi un file che utilizza builtins o includes, i gestori vengono aggiunti in base all'ordine della gerarchia di inclusione. In altre parole, i gestori dell'include "principale" vengono aggiunti prima degli builtins dell'include "secondario" e così via.

Ad esempio, considera il seguente app.yaml, che utilizza gli handler appstats integrati:

handlers:
- url: /.*
  script: main.app
builtins:
- appstats: on

L'elenco di gestori risultante è:

[/_ah/stats, /.*]

Se app.yaml utilizza un'istruzione includes:

includes:
- included.yaml

Il file included.yaml utilizza builtins:

handlers:
- url: /.*
  script: main.app
builtins:
- appstats: on

L'elenco di gestori risultante è ora:

[/.*, /_ah/stats]

L'ordine di posizionamento della clausola builtins in un .yaml file non cambia il comportamento.

default_expiration

Facoltativo. Imposta un periodo di cache predefinito globale per tutti i gestori di file statici di un'applicazione. Puoi anche configurare una durata della cache per gestori di file statici specifici. Il valore è una stringa di numeri e unità, separati da spazi, dove le unità possono essere d per giorni, h per ore, m per minuti e s per secondi. Ad esempio, "4d 5h" imposta la scadenza della cache su 4 giorni e 5 ore dopo la prima richiesta del file. Se omesso, il server di produzione imposta la scadenza su 10 minuti.

Esempio:
runtime: python27
api_version: 1
threadsafe: true

default_expiration: "4d 5h"

handlers:
# ...

Per ulteriori informazioni, consulta la sezione Scadenza della cache.

env_variables

Facoltativo. Puoi definire le variabili di ambiente nel file app.yaml per renderle disponibili alla tua app. Assicurati che la chiave in Variabili di ambiente corrisponda all'espressione "[a-zA-Z_][a-zA-Z0-9_]*" (inizia con l'alfabeto o "_" seguito da qualsiasi carattere alfanumerico o "_").

Le variabili di ambiente precedute dal prefisso GAE sono riservate all'uso di sistema e non sono consentite nel app.yaml file.

Queste variabili saranno disponibili nel dizionario os.environ
env_variables:
  DJANGO_SETTINGS_MODULE: "myapp.settings"
error_handlers

Facoltativo. Utilizzato per configurare pagine di errore personalizzate restituite per diversi tipi di errore.

Questo elemento può contenere i seguenti elementi:

error_code
Facoltativo. error_code può essere uno dei seguenti:
over_quota
Indica che l'app ha superato una quota di risorse
timeout
Viene pubblicato se viene raggiunta una scadenza prima che la tua app risponda.

Il codice errore è facoltativo; se non è specificato, il file specificato è la risposta di errore predefinita per l'app.

file
Ogni voce del file indica un file statico da pubblicare al posto della risposta generica all'errore. Se specifichi un elemento file senza un elemento error_code corrispondente, il file statico sarà la pagina di errore predefinita per la tua app. I dati di errore personalizzati devono essere inferiori a 10 kilobyte.
Esempio
error_handlers:
  - file: default_error.html

  - error_code: over_quota
    file: over_quota.html
handlers

Obbligatorio. Un elenco di pattern URL e descrizioni di come devono essere gestiti. App Engine può gestire gli URL eseguendo il codice dell'applicazione o pubblicando file statici caricati con il codice, come immagini, CSS o JavaScript.

Consulta la sintassi degli elementi di gestione e dei sottoelementi

includes

Facoltativo. La direttiva includes ti consente di includere il file di configurazione di qualsiasi libreria o servizio nell'intera applicazione. Ad esempio, potresti includere una biblioteca di amministrazione degli utenti come segue:

includes:
- lib/user_admin.yaml

App Engine risolve il percorso incluso nel seguente ordine:

  • Percorso assoluto o relativo alla directory di lavoro. Il percorso specificato risolve in un file.
  • Relativo alla directory dell'applicazione, nota anche come basepath. Il percorso di base e il percorso risolvono in un file.
  • Relativo al file che include il file corrente. La posizione del file di riferimento e il percorso di inclusione risolvono il file incluso.

Se la direttiva include specifica una directory, App Engine cerca in quella directory un file denominato include.yaml. Se la direttiva include è un file, viene incluso quel file specifico. L'utilizzo di includes recupera solo i seguenti tipi di direttive dal file di destinazione (se presenti):

I pattern skip_files inclusi vengono aggiunti a quelli inclusi in app.yaml o all'elenco predefinito se non è presente un elenco esplicito in app.yaml. Tieni presente che skip_files confronta i percorsi assoluti.

inbound_services

Facoltativo. Le applicazioni devono attivare questi servizi prima di poter ricevere richieste in entrata. Puoi attivare il servizio per un'app Python 2 includendo una sezione inbound_services nel app.yaml file.

Sono disponibili i seguenti servizi in entrata:

mail
Consente all'applicazione di ricevere posta.
warmup
Attiva le richieste di warmup. Consulta Configurazione delle richieste di warmup.
Esempio:
inbound_services:
  - mail
  - warmup
instance_class

Facoltativo. La classe di istanza per questo servizio.

I seguenti valori sono disponibili in base al scaling del servizio:

Scalabilità automatica
F1, F2, F4, F4_1G
Valore predefinito: F1

Se vuoi, utilizza l'elemento automatic_scaling per modificare le impostazioni predefinite per la scalabilità automatica, ad esempio il numero minimo e massimo di istanze, la latenza e le connessioni simultanee.

Nota: se instance_class è impostato su F2 o su un valore superiore, puoi ottimizzare le istanze impostando max_concurrent_requests su un valore superiore al valore predefinito di 10. Per determinare il valore ottimale, aumentalo gradualmente e monitora il rendimento della tua applicazione.

Scalabilità di base e manuale
B1, B2, B4, B4_1G, B8
Valore predefinito: B2

Le classi di istanze di base e manuali richiedono di specificare l'elemento basic_scaling o l'elemento manual_scaling.

libraries

Facoltativo. Il runtime di Python 2.7 include alcune librerie di terze parti. Alcune sono disponibili per impostazione predefinita, mentre altre sono disponibili solo se configurate. Puoi specificare la versione da utilizzare specificando i valori name e version.

Questo campo è obsoleto nel runtime di Python 3.

libraries:
- name: PIL
  version: "1.1.7"
- name: webob
  version: "latest"
        

Tieni presente che quando specifichi latest, l'SDK determina la versione più recente della libreria al momento del deployment. Una volta eseguito il deployment, la versione della libreria non cambierà. L'unico modo per ottenere una versione diversa della libreria è eseguire nuovamente il deployment.

Se stai sviluppando un'applicazione che non ha ancora utenti, non devi monitorare le nuove versioni. Tuttavia, se la tua applicazione è in uso attivo, attenzione: potresti scoprire che inizia a utilizzare una nuova versione della libreria non compatibile con le versioni precedenti.

Per un elenco delle librerie di terze parti incluse, consulta Librerie di terze parti. Puoi utilizzare librerie di terze parti in puro Python aggiuntive installandole in una directory locale.

Se utilizzi l'ambiente flessibile, consulta Utilizzare le librerie Python nell'ambiente flessibile.

module

Nota: i moduli ora si chiamano Servizi.

Per gestire la tua app con l'interfaccia alla gcloud CLI, utilizza invece l'elemento service.

runtime

Obbligatorio. Il nome dell'ambiente di runtime utilizzato dalla tua app. Ad esempio, per specificare Python 2.7, utilizza:

runtime: python27
service

I servizi erano precedentemente noti come Moduli.

Supportato solo dall'interfaccia a riga di comando gcloud o dai plug-in basati su gcloud CLI, ad esempio: gcloud app deploy .

Obbligatorio se crei un servizio. Facoltativo per il servizio default. Ogni servizio e ogni versione deve avere un nome. Un nome può contenere numeri, lettere e trattini. La lunghezza combinata di VERSION-dot-SERVICE-dot-PROJECT_ID, dove VERSION è il nome della versione, SERVICE è il nome del servizio e PROJECT_ID è l'ID progetto, non deve essere superiore a 63 caratteri e non deve iniziare o terminare con un trattino. Scegli un nome univoco per ogni servizio e per ogni versione. Non riutilizzare i nomi tra servizi e versioni.

Esempio:
service: service-name

Nota: il comando gcloud app deploy è compatibile con le versioni precedenti e supporta i file app.yaml esistenti che includono i servizi dichiarati come moduli, ad esempio:

module: service-name
service_account

Facoltativo. L'elemento service_account consente di specificare un account di servizio gestito dall'utente come identità per la versione. L'account di servizio specificato viene utilizzato per accedere ad altri servizi Google Cloud ed eseguire attività.

Esempio:
service_account: [SERVICE_ACCOUNT_NAME]@[PROJECT_ID].iam.gserviceaccount.com
skip_files

Facoltativo. L'elemento skip_files specifica i file nella directory dell'applicazione che non devono essere caricati su App Engine. Il valore è un'espressione regolare o un elenco di espressioni regolari. Qualsiasi nome file che corrisponde a una delle espressioni regolari viene omesso dall'elenco dei file da caricare quando viene caricata l'applicazione. I nomi file sono relativi alla directory del progetto.

skip_files ha il seguente valore predefinito:

skip_files:
- ^(.*/)?#.*#$
- ^(.*/)?.*~$
- ^(.*/)?.*\.py[co]$
- ^(.*/)?.*/RCS/.*$
- ^(.*/)?\..*$

Il pattern predefinito esclude i file di backup di Emacs con nomi del tipo #...# e ...~, .pyc e .pyo, i file in una directory di controllo revisione RCS e i file nascosti Unix con nomi che iniziano con un punto (.).

Per estendere l'elenco di espressioni regolari riportato sopra, copia e incolla l'elenco in app.yaml e aggiungi le tue espressioni regolari. Ad esempio, per saltare i file i cui nomi terminano con .bak oltre ai pattern predefiniti, aggiungi una voce come questa per skip_files:

skip_files:
- ^(.*/)?#.*#$
- ^(.*/)?.*~$
- ^(.*/)?.*\.py[co]$
- ^(.*/)?.*/RCS/.*$
- ^(.*/)?\..*$
- ^(.*/)?.*\.bak$

Per saltare una directory completa, aggiungi il nome della directory all'elenco. Ad esempio, per saltare una directory denominata logs, aggiungi la seguente riga a quelle descritte in precedenza:

skip_files:
- logs/
threadsafe

Obbligatorio. Configura l'applicazione in modo che utilizzi le richieste in parallelo. Se utilizzi la libreria di threading di Python, i dati a livello di thread, come restituiti da threading.local(), vengono cancellati dopo ogni richiesta.

Questo campo è obsoleto nel runtime di Python 3.

threadsafe: [true | false]

Nota: la direttiva threadsafe è obbligatoria per le applicazioni Python 2.7. threadsafe: true richiede che tutti gli script handler siano WSGI. In altre parole, ogni script deve essere specificato in una script: direttiva utilizzando il percorso del modulo Python con i nomi dei pacchetti separati da punti. L'ultimo componente di una direttiva script: che utilizza il percorso di un modulo Python è il nome di una variabile globale in service:. Questa variabile deve essere un'app WSGI e in genere viene chiamata app per convenzione.

version

L'approccio consigliato è rimuovere l'elemento version dal file app.yaml e utilizzare un flag a riga di comando per specificare l'ID versione:

  • Per utilizzare il comando gcloud app deploy, specifica il flag -v:
    gcloud app deploy -v [YOUR_VERSION_ID]

Per ulteriori informazioni sull'utilizzo di questo comando, consulta Eseguire il deployment dell'app.

Un identificatore per la versione del codice dell'applicazione di cui esegui il deployment in App Engine.

L'ID versione può contenere lettere minuscole, cifre e trattini. non può iniziare con il prefisso ah- e i nomi default e latest sono riservati e non possono essere utilizzati.

Nota: i nomi delle versioni devono iniziare con una lettera per distinguerli dalle istanze numeriche, che sono sempre specificate da un numero. In questo modo viene evitata l'ambiguità con URL come 123-dot-my-service.uc.r.appspot.com, che possono essere interpretati in due modi: se esiste la versione "123", il target sarà la versione "123" del servizio in questione. Se questa versione non esiste, il target sarà l'istanza numero 123 della versione predefinita del servizio.

Ogni versione di un'applicazione conserva la propria copia di app.yaml. Quando viene caricata un'applicazione, la versione indicata nel file app.yaml caricato è la versione che viene creata o sostituita dal caricamento. Un amministratore può modificare la versione dell'applicazione che gestisce il traffico utilizzando la console Google Cloud e può anche testare altre versioni prima di configurarle per ricevere il traffico.

vpc_access_connector

Facoltativo. Configura l'applicazione in modo che utilizzi un connettore di accesso VPC serverless, in modo che possa inviare richieste alle risorse interne della rete VPC. Per saperne di più, consulta Connessione a una rete VPC.

name
Valore letterale di stringa. Specifica il nome completo del connettore di accesso VPC serverless tra virgolette:
"projects/PROJECT_ID/locations/REGION/connectors/CONNECTOR_NAME"
egress_setting
Facoltativo. Il valore predefinito è private-ranges-only. egress_setting può essere uno dei seguenti:
private-ranges-only
Valore predefinito. Le richieste agli indirizzi IP interni vengono inviate tramite il connettore di accesso VPC serverless alla rete VPC collegata. Le richieste agli indirizzi IP esterni vengono inviate alla rete internet pubblica.
all-traffic
Tutte le richieste vengono inviate tramite il connettore Accesso VPC serverless alla rete VPC collegata.
Esempio
vpc_access_connector:
  name: "projects/PROJECT_ID/locations/REGION/connectors/CONNECTOR_NAME"
  egress_setting: all-traffic

Elemento Handlers

L'elemento handlers è obbligatorio nel file di configurazione app.yaml. L'elemento fornisce un elenco di pattern URL e descrizioni di come devono essere gestiti. App Engine può gestire gli URL eseguendo il codice dell'applicazione o pubblicando file statici caricati con il codice, ad esempio immagini, CSS o JavaScript.

I pattern vengono valutati nell'ordine in cui appaiono nel file app.yaml, dall'alto verso il basso. La prima mappatura il cui pattern corrisponde all'URL è quella utilizzata per gestire la richiesta.

La tabella seguente elenca i sottoelementi dell'elemento handlers che controllano il comportamento di script, file statici, directory statiche e altre impostazioni.

Elemento Descrizione
application_readable Facoltativo. Valore booleano. Per impostazione predefinita, i file dichiarati nei gestori dei file statici vengono caricati come dati statici e vengono pubblicati solo per gli utenti finali. Non possono essere letti da un'applicazione. Se questo campo è impostato su true, i file vengono caricati anche come dati di codice in modo che l'applicazione possa leggerli. Entrambi i caricamenti vengono addebitati sulle quote di risorse per lo spazio di archiviazione di codice e dati statici.

Questo campo è obsoleto nei runtime App Engine più recenti.

expiration Facoltativo. Il periodo di tempo per cui un file statico pubblicato da questo gestore deve essere memorizzato nella cache da proxy web e browser. Il valore è una stringa di numeri e unità, separati da spazi, in cui le unità possono essere d per i giorni, h per le ore, m per i minuti e s per i secondi. Ad esempio, "4d 5h" imposta la scadenza della cache su 4 giorni e 5 ore dopo la prima richiesta del file. Se omesso, viene utilizzato il valore default_expiration dell'applicazione. Per ulteriori dettagli, consulta la sezione Scadenza della cache.
http_headers

Facoltativo. Puoi impostare le intestazioni HTTP per le risposte degli elaboratori di directory o file statici. Se devi impostare le intestazioni HTTP nei gestori script, devi farlo nel codice dell'app. Per informazioni sulle intestazioni di risposta che influiscono sulla memorizzazione nella cache, consulta Memorizzazione nella cache dei contenuti statici.

Esempio
handlers:
- url: /images
  static_dir: static/images
  http_headers:
    X-Foo-Header: foo
    X-Bar-Header: bar value
    vary: Accept-Encoding
  # ...

Supporto CORS

Un uso importante di questa funzionalità è supportare la condivisione delle risorse tra origini (CORS), ad esempio l'accesso ai file ospitati da un'altra app App Engine.

Ad esempio, potresti avere un'app di gioco mygame.uc.r.appspot.com che accede agli asset ospitati da myassets.uc.r.appspot.com. Tuttavia, se mygame tenta di eseguire un XMLHttpRequest di JavaScript su myassets, non avrà esito positivo a meno che l'handler per myassets non restituisca un'intestazione di risposta Access-Control-Allow-Origin: contenente il valore http://mygame.uc.r.appspot.com.

Ecco come fare in modo che il gestore dei file statici restituisca il valore obbligatorio dell'intestazione della risposta:

handlers:
- url: /images
  static_dir: static/images
  http_headers:
    Access-Control-Allow-Origin: https://mygame.uc.r.appspot.com
  # ...

Nota: se vuoi consentire a tutti di accedere alle tue risorse, puoi utilizzare il carattere jolly '*' anziché https://mygame.uc.r.appspot.com.

mime_type

Facoltativo. Se specificato, tutti i file pubblicati da questo gestore verranno pubblicati utilizzando il tipo MIME specificato. Se non specificato, il tipo MIME di un file verrà dedotto dall'estensione del nome file. Se lo stesso file viene caricato con più estensioni, l'estensione risultante può dipendere dall'ordine in cui sono stati eseguiti i caricamenti.

Per saperne di più sui possibili tipi di contenuti multimediali MIME, visita il sito web dei tipi di contenuti multimediali MIME IANA

redirect_http_response_code

Facoltativo. redirect_http_response_code viene utilizzato con l'impostazione secure per impostare il codice di risposta HTTP restituito quando viene eseguito un reindirizzamento richiesto dalla configurazione dell'impostazione secure. L'elemento redirect_http_response_code ha i seguenti valori possibili:

301
Codice di risposta Spostato in modo permanente.
302
Codice di risposta trovato.
303
Vedi Codice di risposta: altro.
307
Codice di risposta del reindirizzamento temporaneo.
Esempio
handlers:
- url: /youraccount/.*
  script: accounts.app
  login: required
  secure: always
  redirect_http_response_code: 301

Quando la richiesta di un utente viene reindirizzata, il codice di stato HTTP viene impostato sul valore del parametro redirect_http_response_code. Se il parametro non è presente, verrà restituito il valore 302.

script

Facoltativo. Specifica il percorso allo script dalla directory principale dell'applicazione:

handlers:
# The root URL (/) is handled by the WSGI application named
# "app" in home.py. No other URLs match this pattern.
- url: /
  script: home.app

# The URL /index.html is also handled by the home.py script.
- url: /index\.html
  script: home.app

# A regular expression can map parts of the URL to the
# path of the script.
- url: /browse/(books|videos|tools)
  script: \1.catalog.app

# All other URLs use the WSGI application named in "app"
# in not_found.py.
- url: /.*
  script: not_found.app

Una direttiva script: deve essere un percorso di importazione di Python, ad esempio package.module.app che rimanda a un'applicazione WSGI. L'ultimo componente di una direttiva script: che utilizza il percorso di un modulo Python è il nome di una variabile globale nel modulo: questa variabile deve essere un'app WSGI e solitamente viene chiamata app per convenzione.

Nota: come per un'istruzione import di Python, ogni sottodirectory che è un pacchetto deve contenere un file denominato __init__.py.

Nei runtime App Engine più recenti, il comportamento di questo campo è cambiato.

secure Facoltativo. Qualsiasi gestore di URL può utilizzare l'impostazione secure, inclusi i gestori di script e i gestori di file statici. L'elemento secure ha i seguenti valori possibili:
optional
Sia le richieste HTTP che quelle HTTPS con URL corrispondenti all'handler vanno a buon fine senza reindirizzamenti. L'applicazione può esaminare la richiesta per determinare quale protocollo è stato utilizzato e rispondere di conseguenza. Questo è il valore predefinito quando secure non viene fornito per un gestore.
never
Le richieste per un URL che corrispondono a questo gestore e che utilizzano HTTPS vengono reindirizzate automaticamente all'URL HTTP equivalente. Quando la richiesta HTTPS di un utente viene reindirizzata a una richiesta HTTP, i parametri di ricerca vengono rimossi dalla richiesta. In questo modo, un utente non può inviare accidentalmente i dati delle query tramite una connessione non sicura che era stata pensata per una connessione sicura.
always
Le richieste di un URL che corrispondono a questo gestore e che non utilizzano HTTPS vengono reindirizzate automaticamente all'URL HTTPS con lo stesso percorso. I parametri di query vengono conservati per il reindirizzamento.
Esempio
handlers:
- url: /youraccount/.*
  script: accounts.app
  login: required
  secure: always

Il server web di sviluppo non supporta le connessioni HTTPS. Ignora il parametro secure, pertanto i percorsi destinati all'utilizzo con HTTPS possono essere testati utilizzando connessioni HTTP standard al server web di sviluppo.

Per scegliere come target una versione specifica della tua app utilizzando il dominio REGION_ID.r.appspot.com, sostituisci i punti che di solito separano i componenti del sottodominio dell'URL con la stringa "-dot-", ad esempio:
https://VERSION_ID-dot-default-dot-PROJECT_ID.REGION_ID.r.appspot.com

Per utilizzare i domini personalizzati con HTTPS, devi prima attivare e configurare i certificati SSL per quel dominio.

L'accesso e la disconnessione dagli Account Google vengono sempre eseguiti utilizzando una connessione sicura, indipendentemente dalla configurazione degli URL dell'applicazione.

static_dir

Facoltativo. Il percorso della directory contenente i file statici, dalla directory principale dell'applicazione. Tutto ciò che segue la fine del pattern url corrispondente viene aggiunto a static_dir per formare il percorso completo del file richiesto.

Ogni file nella directory statica viene pubblicato utilizzando il tipo MIME corrispondente all'estensione del nome file, a meno che non venga sostituito dall'impostazione mime_type della directory. Tutti i file nella directory specificata vengono caricati come file statici e nessuno di questi può essere eseguito come script.

Tutti i file in questa directory vengono caricati con l'app come file statici. App Engine archivia e pubblica i file statici separatamente dai file della tua app. Per impostazione predefinita, i file statici non sono disponibili nel file system dell'app. Questo valore può essere modificato impostando l'opzione application_readable su true.

Esempio:
handlers:
# All URLs beginning with /stylesheets are treated as paths to
# static files in the stylesheets/ directory.
- url: /stylesheets
  static_dir: stylesheets
  # ...
static_files

Facoltativo. Un gestore di pattern di file statici associa un pattern URL ai percorsi dei file statici caricati con l'applicazione. L'espressione regolare del pattern URL può definire raggruppamenti di espressioni regolari da utilizzare nella costruzione del percorso del file. Puoi utilizzarlo al posto di static_dir per mappare file specifici in una struttura di directory senza mappare l'intera directory.

Esempio:
handlers:
# All URLs ending in .gif .png or .jpg are treated as paths to
# static files in the static/ directory. The URL pattern is a
# regular expression, with a grouping that is inserted into the
# path to the file.
- url: /(.*\.(gif|png|jpg))$
  static_files: static/\1
  upload: static/.*\.(gif|png|jpg)$
  # ...

App Engine archivia e pubblica i file statici separatamente dai file dell'applicazione. Per impostazione predefinita, i file statici non sono disponibili nel file system dell'applicazione. Questo valore può essere modificato impostando su true l'opzione application_readable.

I file statici non possono essere gli stessi dei file di codice dell'applicazione. Se un percorso file statico corrisponde a un percorso di uno script utilizzato in un gestore dinamico, lo script non sarà disponibile per il gestore dinamico.

upload

Facoltativo. Un'espressione regolare che corrisponde ai percorsi dei file di tutti i file a cui farà riferimento questo gestore. Questo è necessario perché l'handler non può determinare quali file nella directory dell'applicazione corrispondono ai pattern url e static_files specificati. I file statici vengono caricati e gestiti separatamente dai file dell'applicazione. L'esempio riportato sopra potrebbe utilizzare il seguente pattern upload: archives/(.*)/items/(.*)

url

Elemento obbligatorio in handlers. Il pattern dell'URL come expression regolare. L'espressione può contenere raggruppamenti a cui fare riferimento nel percorso del file dello script con i riferimenti incrociati delle espressioni regolari. Ad esempio, /profile/(.*)/(.*) corrisponde all'URL /profile/edit/manager e utilizza edit e manager come primo e secondo raggruppamento.

Il pattern URL presenta alcune differenze di comportamento se utilizzato con i seguenti elementi:

static_dir
Utilizza un prefisso URL. Il pattern di espressioni regolari non deve contenere agrupamenti se utilizzato con l'elemento static_dir. Tutti gli URL che iniziano con questo prefisso vengono gestiti da questo gestore, che utilizza la parte dell'URL dopo il prefisso come parte del percorso del file.
static_files
Un gestore di pattern di file statici associa un pattern URL ai percorsi dei file statici caricati con l'applicazione. L'espressione regolare del pattern URL può definire raggruppamenti di espressioni regolari da utilizzare nella compilazione del percorso del file. Puoi utilizzarlo al posto di static_dir per mappare file specifici in una struttura di directory senza mappare l'intera directory.

Ridimensionare gli elementi

Gli elementi nella tabella seguente configurano la scalabilità dell'applicazione. Per scoprire di più sulla scalabilità delle app App Engine, consulta Tipi di scalabilità.

Elemento Descrizione
automatic_scaling

Facoltativo. Applicabile solo per le applicazioni che utilizzano una classe di istanze F1 o superiore.

Specifica questo elemento per modificare le impostazioni predefinite per la scalabilità automatica, come l'impostazione di livelli minimi e massimi per il numero di istanze, la latenza e le connessioni simultanee per un servizio.

Questo elemento può contenere i seguenti elementi:

max_instances
Facoltativo. Specifica un valore compreso tra 0 e 2147483647, dove zero disattiva l'impostazione.

Questo parametro specifica il numero massimo di istanze che App Engine deve creare per questa versione del modulo. Questa opzione è utile per limitare i costi di un modulo.

min_instances
Facoltativo. Il numero minimo di istanze da creare per App Engine per questa versione del modulo. Queste istanze pubblicano il traffico quando arrivano le richieste e continuano a farlo anche quando vengono avviate istanze aggiuntive in base alle esigenze di gestione del traffico.

Specifica un valore compreso tra 0 e 1000. Puoi impostare il parametro sul valore 0 per consentire il ridimensionamento a 0 istanze al fine di ridurre i costi quando non vengono inviate richieste. Tieni presente che ti viene addebitato il costo per il numero di istanze specificate, indipendentemente dal fatto che ricevano o meno traffico.

max_idle_instances

Facoltativo. Il numero massimo di istanze inattive che App Engine deve mantenere per questa versione. Specifica un valore compreso tra 1 e 1000. Se non specificato, il valore predefinito è automatic, il che significa che App Engine gestirà il numero di istanze inattive. Tieni presente che:

  • Un valore massimo elevato riduce il numero di istanze inattive in modo più graduale quando i livelli di carico tornano alla normalità dopo un picco. In questo modo, l'applicazione mantiene prestazioni costanti durante le oscillazioni del carico delle richieste, ma aumenta anche il numero di istanze inattive (e i conseguenti costi di gestione) durante questi periodi di carico elevato.
  • Un valore massimo basso mantiene bassi i costi di gestione, ma può peggiorare le prestazioni in presenza di livelli di carico volatili.

Nota: quando si torna ai livelli normali dopo un picco di carico, il numero di istanze inattive può superare temporaneamente il valore massimo specificato. Tuttavia, non ti verrà addebitato il costo di più istanze rispetto al numero massimo specificato.

min_idle_instances

(Facoltativo) Il numero di istanze aggiuntive da mantenere in esecuzione e pronte a gestire il traffico per questa versione.

App Engine calcola il numero di istanze necessarie per gestire il traffico corrente dell'applicazione in base alle impostazioni di scalabilità come target_cpu_utilization e target_throughput_utilization. L'impostazione min_idle_instances specifica il numero di istanze da eseguire oltre a questo numero calcolato. Ad esempio, se App Engine calcola che sono necessarie 5 istanze per gestire il traffico e min_idle_instances è impostato su 2, App Engine eseguirà 7 istanze (5, calcolate in base al traffico, più altre 2 per min_idle_instances).

Tieni presente che ti viene addebitato il costo per il numero di istanze specificate, indipendentemente dal fatto che ricevano o meno traffico. Tieni presente che:

  • Un numero minimo ridotto consente di ridurre i costi di gestione durante i periodi di inattività, ma significa che potrebbero essere disponibili meno istanze immediatamente per rispondere a un picco di carico improvviso.
  • Un valore minimo elevato ti consente di preparare l'applicazione per picchi rapidi nel carico delle richieste. App Engine mantiene in esecuzione il numero minimo di istanze per gestire le richieste in entrata. Ti viene addebitato il numero di istanze specificate, indipendentemente dal fatto che gestiscano o meno le richieste.

    Se imposti un numero minimo di istanze inattive, latenza in sospeso avrà un effetto minore sul rendimento della tua applicazione.

target_cpu_utilization
Facoltativo. Specifica un valore compreso tra 0,5 e 0,95. Il valore predefinito è 0.6.

Questo parametro specifica la soglia di utilizzo della CPU a cui verranno avviate nuove istanze per gestire il traffico, consentendoti di trovare il giusto equilibrio tra prestazioni e costi: i valori più bassi aumentano le prestazioni e i costi, mentre i valori più elevati riducono le prestazioni, ma anche i costi. Ad esempio, un valore di 0,7 indica che le nuove istanze verranno avviate quando l'utilizzo della CPU raggiunge il 70%.

target_throughput_utilization
Facoltativo. Specifica un valore compreso tra 0,5 e 0,95. Il valore predefinito è 0.6.

Utilizzato con max_concurrent_requests per specificare quando viene avviata una nuova istanza a causa di richieste simultanee. Quando il numero di richieste simultanee raggiunge un valore uguale a max_concurrent_requests volte target_throughput_utilization, lo scheduler tenta di avviare una nuova istanza.

max_concurrent_requests

Facoltativo. Il numero di richieste in parallelo che un'istanza con scalabilità automatica può accettare prima che lo scheduler generi una nuova istanza (valore predefinito: 10, valore massimo: 1000).

Utilizzato con target_throughput_utilization per specificare quando viene avviata una nuova istanza a causa di richieste concorrenti. Quando il numero di richieste simultanee raggiunge un valore pari a max_concurrent_requests volte target_throughput_utilization, lo scheduler tenta di avviare una nuova istanza.

Ti consigliamo di non impostare max_concurrent_requests su un valore inferiore a 10, a meno che tu non abbia bisogno di un singolo thread. Un valore inferiore a 10 potrebbe comportare la creazione di più istanze di quante ne siano necessarie per un'app sicura per i thread e potrebbe comportare costi non necessari.

Se questa impostazione è troppo elevata, la latenza dell'API potrebbe aumentare. Tieni presente che il programmatore potrebbe generare una nuova istanza prima che venga raggiunto il numero massimo effettivo di richieste.

max_pending_latency

Il tempo massimo che App Engine deve consentire a una richiesta di rimanere in coda in attesa prima di avviare istanze aggiuntive per gestire le richieste in modo da ridurre latenza in sospeso. Quando viene raggiunta questa soglia, viene attivato un indicatore di aumento e si verifica un aumento del numero di istanze. Se non specificato, il valore predefinito è automatic. Ciò significa che le richieste possono rimanere nella coda in attesa per un massimo di 10 secondi, il limite di tempo massimo per le richieste in attesa, prima che vengano avviate nuove istanze.

Un valore massimo basso indica che App Engine avvia nuove istanze prima per le richieste in attesa, migliorando le prestazioni, ma aumentando i costi di gestione.

Un valore massimo elevato significa che gli utenti potrebbero attendere più a lungo per la pubblicazione delle loro richieste (se ci sono richieste in attesa e non sono disponibili istanze inattive per gestirle), ma il costo di esecuzione dell'applicazione sarà inferiore.

min_pending_latency

Un elemento facoltativo che puoi impostare per specificare il tempo minimo che App Engine deve consentire a una richiesta di attendere nella fila in attesa prima di avviare una nuova istanza per gestirla. La specifica di un valore può ridurre i costi di gestione, ma aumentare il tempo di attesa degli utenti per l'elaborazione delle richieste.

Per le app gratuite, il valore predefinito è 500ms. Per le app pagate, il valore predefinito è 0.

Questo elemento funziona insieme all'elemento max_pending_latency per determinare quando App Engine crea nuove istanze. Se le richieste in attesa sono in coda:

  • Se il valore è inferiore a min_pending_latency specificato, App Engine non creerà nuove istanze.
  • Più di max_pending_latency, App Engine tenterà di creare una nuova istanza.
  • Tra l'ora specificata da min_pending_latency e max_pending_latency, App Engine tenterà di riutilizzare un'istanza esistente. Se nessuna istanza è in grado di elaborare la richiesta prima di max_pending_latency, App Engine creerà una nuova istanza.
Esempio
automatic_scaling:
  target_cpu_utilization: 0.65
  min_instances: 5
  max_instances: 100
  min_pending_latency: 30ms
  max_pending_latency: automatic
  max_concurrent_requests: 50
basic_scaling

Le applicazioni che utilizzano una classe di istanze di B1 o versioni successive devono specificare questo elemento o manual_scaling.

Questo elemento consente la scalabilità di base delle classi di istanze B1 e successive e può contenere i seguenti elementi:

max_instances
Obbligatorio. Il numero massimo di istanze che App Engine può creare per questa versione del servizio. Questa opzione è utile per limitare i costi di un servizio.
idle_timeout
Facoltativo. L'istanza verrà arrestata dopo questo periodo di tempo dalla ricezione dell'ultima richiesta. Il valore predefinito è 5 minuti (5m).
Esempio
basic_scaling:
  max_instances: 11
  idle_timeout: 10m
manual_scaling

Le applicazioni che utilizzano una classe di istanze di B1 o versioni successive devono specificare questo elemento o basic_scaling.

Questo elemento consente la scalabilità manuale delle classi di istanze B1 e successive e può contenere il seguente elemento:

instances
Il numero di istanze da assegnare al servizio all'avvio.
Esempio
manual_scaling:
  instances: 5