ID da região
O REGION_ID
é um código abreviado que o Google atribui
com base na região que você selecionou ao criar o aplicativo. O código não
corresponde a um país ou estado, ainda que alguns IDs de região sejam semelhantes
aos códigos de país e estado geralmente usados. Para apps criados após
fevereiro de 2020, o REGION_ID.r
está incluído nos
URLs do App Engine. Para apps existentes criados antes dessa data, o
ID da região é opcional no URL.
Saiba mais sobre IDs de região.
Defina as configurações do aplicativo App Engine no arquivo
app.yaml
.
Esse arquivo especifica como os caminhos do URL correspondem aos gerenciadores de solicitação e aos arquivos estáticos.
O arquivo app.yaml
também contém informações sobre o
código do aplicativo, como o ambiente de execução e o identificador da versão
mais recente.
Cada serviço do aplicativo
tem um arquivo app.yaml
próprio, que atua como descritor da
implantação. Primeiro, é necessário criar o arquivo app.yaml
do serviço default
antes de criar e implantar arquivos app.yaml
de outros serviços do aplicativo.
Estrutura do diretório
Para saber mais sobre como estruturar vários serviços no seu aplicativo, consulte Como estruturar serviços da Web no App Engine.Exemplo
Veja a seguir um exemplo de um arquivo app.yaml
para um
aplicativo PHP 5:
runtime: php55 api_version: 1 handlers: # Serve images as static resources. - url: /(.+\.(gif|png|jpg))$ static_files: \1 upload: .+\.(gif|png|jpg)$ application_readable: true # Serve php scripts. - url: /(.+\.php)$ script: \1
O exemplo acima veiculará arquivos com extensão de gif
, png
ou jpg
como
recursos estáticos. Os arquivos foram configurados para serem legíveis pelo
código do aplicativo no ambiente de execução.
Todos os scripts PHP também serão veiculados no exemplo. É possível restringir o gerenciador
de scripts a scripts de nível raiz usando a expressão url: /([^/]+\.php)
. Os aplicativos
atuais podem ser úteis para simular o roteamento do Apache mod_rewrite
$_GET['q']
.
Veja abaixo uma configuração mais extensa do app.yaml
:
runtime: php55 api_version: 1 handlers: - url: / script: home.php - url: /index\.html script: home.php - url: /stylesheets static_dir: stylesheets - url: /(.*\.(gif|png|jpg))$ static_files: static/\1 upload: static/.*\.(gif|png|jpg)$ - url: /admin/.* script: admin.php login: admin - url: /.* script: not_found.php
Sintaxe
A sintaxe de app.yaml
é o formato YAML (em inglês).
O formato YAML é compatível com comentários. As linhas iniciadas com o caractere de cerquilha (#
) são ignoradas:
# This is a comment.
Os padrões de caminho de URL e arquivo usam a sintaxe de expressões regulares estendidas POSIX, excluindo elementos e classes de compilação. São aceitas tanto as referências inversas às correspondências agrupadas (por exemplo, \1
) quanto as extensões Perl: \w \W \s \S \d \D
.
Elementos do ambiente de execução e do aplicativo
Elemento | Descrição |
---|---|
application |
A abordagem recomendada consiste em remover o elemento
Para mais informações sobre como usar esses comandos, consulte Como implantar seu app. O ID do aplicativo é o ID do projeto do console do Google Cloud que você especificou quando criou o aplicativo no console do Google Cloud. |
api_version |
Obrigatório. A versão da API no ambiente de execução específico usado pelo aplicativo. Este campo está obsoleto em ambientes de execução mais recentes do App Engine.
Quando o Google anunciar o suporte para uma nova versão da API do ambiente de execução, o aplicativo implantado continuará usando a versão para que ele foi escrito. Para atualizar o aplicativo para uma nova versão da API, altere esse valor e implante novamente o aplicativo no App Engine. Quando você especifica o valor
No momento, o App Engine tem uma versão do
ambiente de execução |
default_expiration |
Opcional. Define um período de cache padrão global para todos os gerenciadores de arquivos estáticos de um aplicativo. Você também pode configurar a duração de um cache para gerenciadores de arquivos estáticos específicos. O valor é uma string de números e unidades, separados por espaços, em que as unidades podem ser d para dias, h para horas, m para minutos e s para segundos. Por exemplo, runtime: php55 api_version: 1 default_expiration: "4d 5h" handlers: # ... Para mais informações, consulte Expiração do cache. |
env_variables
|
Opcional.
Você pode definir variáveis de ambiente no arquivo
As variáveis de ambiente com o prefixo env_variables: MY_VAR: "my value" MY_VAR e my value são o nome e o valor da variável de ambiente
que você quer definir e cada entrada de variável de ambiente é recuada em dois
espaços no elemento
env_variables . Para variáveis de ambiente, não foi atribuído
um valor padrão a "None" .
Em seguida, é possível recuperar o valor dessas variáveis usando
echo getenv('MY_VAR'); echo $_SERVER['MY_VAR']; |
error_handlers |
Opcional. Usado para configurar páginas de erro personalizadas que são retornadas para diferentes tipos de erro. É possível que este elemento contenha:
error_handlers: - file: default_error.html - error_code: over_quota file: over_quota.html |
handlers |
Obrigatório. Uma lista de padrões de URL e de descrições de como eles precisam ser processados. O App Engine pode processar os URLs executando o código do aplicativo ou disponibilizando arquivos estáticos enviados com o código, como imagens, CSS ou JavaScript. |
inbound_services |
Opcional.
Os aplicativos precisam ativar esses serviços antes de poder receber solicitações
de entrada. É possível ativar o serviço para um aplicativo PHP 5
incluindo uma seção Os seguintes serviços de entrada estão disponíveis:
inbound_services: - mail - warmup |
instance_class |
Opcional. A classe de instância deste serviço. Os seguintes valores estão disponíveis dependendo do escalonamento do serviço:
|
module |
Observação: os módulos agora são denominados serviços. Para gerenciar seu app com a CLI gcloud, use o elemento service. |
runtime |
Obrigatório. O nome do ambiente de execução usado pelo app. Por exemplo, para especificar PHP 5, use: runtime: php55 |
service |
Os serviços antes eram conhecidos como módulos.
Compatível apenas com os plug-ins da CLI gcloud ou
baseados na CLI gcloud, por exemplo:
Obrigatório ao criar um serviço.
Opcional para o serviço service: service-name
Observação: o comando module: service-name |
service_account |
Opcional. O elemento service_account: [SERVICE_ACCOUNT_NAME]@[PROJECT_ID].iam.gserviceaccount.com |
skip_files |
Opcional.
O elemento O skip_files: - ^(.*/)?#.*#$ - ^(.*/)?.*~$ - ^(.*/)?.*\.py[co]$ - ^(.*/)?.*/RCS/.*$ - ^(.*/)?\..*$
O padrão exclui arquivos de backup Emacs com nomes nos formatos
Para ampliar a lista de expressões regulares acima, copie e cole essa lista no skip_files: - ^(.*/)?#.*#$ - ^(.*/)?.*~$ - ^(.*/)?.*\.py[co]$ - ^(.*/)?.*/RCS/.*$ - ^(.*/)?\..*$ - ^(.*/)?.*\.bak$
Para ignorar um diretório completo, adicione o nome do diretório à lista. Por exemplo, para ignorar um diretório denominado skip_files: - logs/ |
version |
A abordagem recomendada consiste em remover o elemento
Para mais informações sobre como usar esse comando, consulte Como implantar o aplicativo. Um identificador da versão do código do aplicativo que você implanta no App Engine.
O código da versão pode conter letras minúsculas, dígitos e hifens. Ele não pode começar com o prefixo
Observação: os nomes das versões têm que começar com uma letra, para distingui-las
de instâncias numéricas que são sempre especificadas por um número. Isso
evita a ambiguidade com URLs como
Cada versão de um aplicativo retém sua própria cópia do
|
Elemento handlers
O elemento handlers
é obrigatório no arquivo de configuração app.yaml
. Ele contém uma lista de padrões de URL e descrições de como eles serão processados. O App Engine pode processar URLs executando o código do aplicativo ou exibindo arquivos estáticos enviados com o código, como imagens, CSS ou JavaScript.
Os padrões são avaliados na ordem em que aparecem no arquivo app.yaml
, de cima para baixo. O primeiro mapeamento com padrão que corresponde ao URL é usado para processar a solicitação.
A tabela a seguir lista os subelementos do elemento handlers
que controlam o comportamento de scripts arquivos estáticos, diretórios estáticos e outras configurações.
Elemento | Descrição |
---|---|
application_readable |
Opcional. Booleano. Por padrão, os arquivos declarados em gerenciadores de arquivos estáticos são enviados como dados estáticos e são exibidos somente para usuários finais. Eles não podem ser lidos no aplicativo. Se este campo for definido como verdadeiro, os arquivos também serão enviados como dados de código para que possam ser lidos no aplicativo.
Ambos os uploads são cobrados de acordo com o código e as cotas de recursos de armazenamento de dados estáticos.
Este campo está obsoleto em ambientes de execução mais recentes do App Engine. |
expiration
|
Opcional.
É recomendável que a duração de um arquivo estático exibido por este gerenciador seja armazenada em cache por proxies e navegadores da Web. O valor é uma sequência de números e unidades, separados por espaços, em que as unidades podem ser d para dias, h para horas, m para minutos e s para segundos. Por exemplo, "4d 5h" define a expiração do cache para quatro dias e cinco horas após o arquivo ser solicitado pela primeira vez. Se omitido, o default_expiration do aplicativo é usado. Consulte Expiração do
cache para mais detalhes.
|
http_headers |
Opcional. Defina cabeçalhos HTTP para ver respostas dos gerenciadores de diretório ou arquivo estático. Se você precisar definir cabeçalhos HTTP nos gerenciadores de handlers: - url: /images static_dir: static/images http_headers: X-Foo-Header: foo X-Bar-Header: bar value vary: Accept-Encoding # ... Suporte ao CORSEste recurso é importante para permitir o compartilhamento de recursos entre origens (CORS, na sigla em inglês), como o acesso aos arquivos hospedados por outro aplicativo do App Engine.
Por exemplo, um aplicativo de jogo Para que o gerenciador de arquivo estático retorne esse valor de cabeçalho de resposta solicitado, realize as ações a seguir: handlers: - url: /images static_dir: static/images http_headers: Access-Control-Allow-Origin: https://mygame.uc.r.appspot.com # ...
Observação: para permitir que todos acessem os recursos, use o caractere curinga |
mime_type |
Opcional. Se especificado, todos os arquivos exibidos por este gerenciador serão exibidos usando o tipo MIME especificado. Se não especificado, o tipo MIME de um arquivo será derivado da extensão do nome do arquivo. Se for feito upload do mesmo arquivo com várias extensões, a extensão resultante poderá depender da ordem em que os uploads ocorreram. Para mais informações sobre os possíveis tipos de mídia MIME, consulte o site sobre os tipos de mídia IANA MIME (em inglês) |
redirect_http_response_code |
Opcional.
handlers: - url: /youraccount/.* script: accounts.php secure: always redirect_http_response_code: 301
Quando a solicitação de um usuário for redirecionada, o código de status HTTP será definido com o valor do parâmetro |
script |
Opcional. Especifica o caminho para o script a partir do diretório raiz do aplicativo: ... handlers: - url: /profile/(.*)/(.*) script: /employee/\2/\1.php # specify a script Nos ambientes de execução mais recentes do App Engine, o comportamento desse campo mudou. |
secure |
Opcional. Qualquer gerenciador de URL pode usar a configuração secure , incluindo gerenciadores de script e de arquivos estáticos. É possível que o elemento secure tenha os seguintes valores:
handlers: - url: /youraccount/.* script: accounts.php secure: always
O servidor da Web de desenvolvimento não é compatível com conexões HTTPS. Ele
ignora o parâmetro
Para direcionar uma versão específica do aplicativo usando o domínio Para usar domínios personalizados com HTTPS, primeiro é preciso ativar e configurar certificados SSL para esse domínio. O login e o logout das contas do Google sempre são realizados por meio de uma conexão segura, sem relação com a configuração dos URLs do aplicativo. |
static_dir
|
Opcional. O caminho para o diretório que contém os arquivos estáticos, do diretório raiz do aplicativo. Tudo depois do fim do padrão
Cada arquivo no diretório estático é exibido pelo MIME que corresponde à própria extensão de nome de arquivo, a menos que seja modificado pela configuração
Todos os arquivos neste diretório são carregados com seu aplicativo como arquivos estáticos. No App Engine, os arquivos estáticos são armazenados e exibidos separadamente dos arquivos do aplicativo. Por padrão, os arquivos estáticos não estão disponíveis no sistema de arquivos do app. Para alterar essa configuração, defina a opção handlers: # All URLs beginning with /stylesheets are treated as paths to # static files in the stylesheets/ directory. - url: /stylesheets static_dir: stylesheets # ... |
static_files
|
Opcional. Um gerenciador de padrão de arquivo estático associa um padrão de URL com caminhos para arquivos estáticos enviados com o aplicativo. A expressão regular do padrão de URL pode definir os agrupamentos de expressões regulares a serem usados na construção do caminho do arquivo. Use isso em vez de 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)$ # ...
O App Engine armazena e veicula arquivos estáticos separadamente dos arquivos do aplicativo. Por padrão, os arquivos estáticos não estão disponíveis no sistema de arquivos do aplicativo. Para alterar essa configuração, defina a opção Os arquivos estáticos não podem ser iguais aos arquivos do código do aplicativo. Se um caminho de arquivo estático corresponder ao caminho para um script usado em um gerenciador dinâmico, o script não ficará disponível para o gerenciador dinâmico. |
upload |
Opcional. Uma expressão regular que corresponde aos caminhos de arquivo para todos os arquivos que serão referenciados por este gerenciador. Isso é necessário porque o gerenciador não pode determinar quais arquivos no diretório do aplicativo correspondem aos padrões de |
url |
Elemento obrigatório em O padrão do URL tem algumas diferenças de comportamento quando usado com os seguintes elementos:
|
Como escalonar elementos
Os elementos da tabela a seguir configuram o escalonamento do seu aplicativo. Para saber mais sobre como os aplicativos do App Engine são escalonados, consulte Tipos de escalonamento.
Elemento | Descrição |
---|---|
automatic_scaling |
Opcional. Aplicável somente a aplicativos que usam uma classe de instância de F1 ou superior. Especifique esse elemento para alterar as configurações padrão do escalonamento automático, como a definição de níveis mínimo e máximo para o número de instâncias, latência e conexões simultâneas de um serviço. É possível que este elemento contenha:
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 |
É necessário que os aplicativos que usarem uma classe de instância de B1 ou superior especifiquem esse elemento ou Esse elemento ativa o escalonamento básico das classes de instância B1 e superior e pode conter os seguintes elementos:
basic_scaling: max_instances: 11 idle_timeout: 10m |
manual_scaling |
É necessário que os aplicativos que usarem uma classe de instância de B1 ou superior especifiquem esse elemento ou Esse elemento permite o escalonamento manual de classes de instância B1 e superior e pode conter o seguinte elemento:
manual_scaling: instances: 5 |