Os aplicativos do Django executados no ambiente flexível do App Engine são escalonados dinamicamente de acordo com o tráfego.
Neste tutorial, presume-se que você esteja familiarizado com o desenvolvimento de Web com o Django. Se você é novo no desenvolvimento do Django, é recomendável escrever seu primeiro aplicativo Django antes de continuar.
Embora este tutorial demonstre especificamente o Django, é possível usar esse processo de implantação com outros frameworks baseados em Django, como Wagtail e Django CMS.
Este tutorial usa o Django 3, que requer pelo menos o Python 3.7. O App Engine flexível é compatível com o Python 3.7.
Objetivos
Com este tutorial, você vai:
- Criar e conectar um banco de dados do Cloud SQL.
- Criar e usar valores de secret do Secret Manager.
Implantar um aplicativo Django no ambiente flexível do App Engine.
Hospedar arquivos estáticos no Cloud Storage.
Custos
Neste documento, você usará os seguintes componentes faturáveis do Google Cloud:
Para gerar uma estimativa de custo baseada na projeção de uso deste tutorial, use a calculadora de preços.
Antes de começar
- 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 ainda não tiver feito isso, inicialize o App Engine e selecione a região de sua preferência:
gcloud app create
Preparar o ambiente
Clonar um aplicativo de exemplo
O código do aplicativo de amostra Django está no repositório GoogleCloudPlatform/python-docs-samples no GitHub.
É possível fazer o download da amostra como um arquivo ZIP e extraí-lo ou clonar o repositório na máquina local:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Acesse o diretório que contém o código de amostra:
Linux/MacOS
cd python-docs-samples/appengine/flexible/django_cloudsql
Windows
cd python-docs-samples\appengine\flexible\django_cloudsql
Confirmar a configuração do Python
Este tutorial depende do Python para executar o aplicativo de amostra na máquina. O exemplo de código também requer a instalação de dependências
Para mais detalhes, consulte o guia do ambiente de desenvolvimento em Python.
Confirme se o Python contém a versão 3.7 ou posterior.
python -V
Você verá
Python 3.7.3
ou superior.Crie um ambiente virtual do Python e instale as dependências:
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
Faça o download do proxy do Cloud SQL Auth para se conectar ao Cloud SQL pela máquina local
Quando implantado, o aplicativo usa o proxy de autenticação do Cloud SQL integrado ao ambiente flexível do App Engine para se comunicar com a instância do Cloud SQL. No entanto, para testar o aplicativo no local, é necessário instalar e usar uma cópia local do proxy no ambiente de desenvolvimento. Para mais detalhes, consulte o guia do proxy do Cloud SQL Auth.
O proxy do Cloud SQL Auth usa a API Cloud SQL para interagir com sua instância do SQL. Para fazer isso, ele quer a autenticação do aplicativo pelo gcloud.
Autentique e receba as credenciais da API:
gcloud auth application-default login
Faça o download e instale o proxy do Cloud SQL Auth na sua máquina local.
Linux de 64 bits
- Faça o download do proxy do Cloud SQL Auth:
wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
- Torne o proxy do Cloud SQL Auth executável:
chmod +x cloud_sql_proxy
Linux de 32 bits
- Faça o download do proxy do Cloud SQL Auth:
wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy
- Se o comando
wget
não for encontrado, executesudo apt-get install wget
e repita o comando de download. - Torne o proxy do Cloud SQL Auth executável:
chmod +x cloud_sql_proxy
macOS de 64 bits
- Faça o download do proxy do Cloud SQL Auth:
curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64
- Torne o proxy do Cloud SQL Auth executável:
chmod +x cloud_sql_proxy
macOS de 32 bits
- Faça o download do proxy do Cloud SQL Auth:
curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386
- Torne o proxy do Cloud SQL Auth executável:
chmod +x cloud_sql_proxy
Mac M1
- Faça o download do proxy do Cloud SQL Auth:
curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.arm64
- Torne o proxy do Cloud SQL Auth executável:
chmod +x cloud_sql_proxy
Windows de 64 bits
Clique com o botão direito do mouse em https://dl.google.com/cloudsql/cloud_sql_proxy_x64.exe e selecione Salvar link como para fazer o download do proxy do Cloud SQL Auth. Renomeie o arquivo paracloud_sql_proxy.exe
.Windows de 32 bits
Clique com o botão direito do mouse em https://dl.google.com/cloudsql/cloud_sql_proxy_x86.exe e selecione Salvar link como para fazer o download do proxy do Cloud SQL Auth. Renomeie o arquivo paracloud_sql_proxy.exe
.Imagem do Docker do proxy do Cloud SQL Auth
Por conveniência, várias imagens de contêiner que contêm o proxy do Cloud SQL Auth estão disponíveis no GitHub no repositório do proxy do Cloud SQL Auth. É possível extrair a imagem mais recente na sua máquina local usando o Docker com o seguinte comando:docker pull gcr.io/cloudsql-docker/gce-proxy:1.30.1
Outros SOs
Para outros sistemas operacionais não incluídos aqui, compile o proxy do Cloud SQL Auth na origem.Você pode optar por mover o download para um lugar comum, como um local no
PATH
ou seu diretório principal. Se você optar por fazer isso, ao iniciar o proxy do Cloud SQL Auth posteriormente no tutorial, lembre-se de consultar o local escolhido ao usar os comandoscloud_sql_proxy
.- Faça o download do proxy do Cloud SQL Auth:
Criar serviços de apoio
Neste tutorial, usamos vários serviços do Google Cloud para fornecer o banco de dados, o armazenamento de mídia e o armazenamento de secrets que oferecem suporte ao projeto Django implantado. Esses serviços são implantados em uma região específica. Para garantir a eficiência entre os serviços, todos eles precisam ser implantados na mesma região. Para mais informações sobre a região mais próxima de você, consulte Produtos disponíveis por região.
Configurar uma instância do Cloud SQL para PostgreSQL
O Django oficialmente oferece suporte a vários bancos de dados relacionais, mas oferece a maior parte do suporte para o PostgreSQL. O PostgreSQL conta com o suporte do Cloud SQL. Portanto, este tutorial escolhe usar esse tipo de banco de dados.
A seção a seguir descreve a criação de uma instância, um banco de dados e um usuário do banco de dados do PostgreSQL para o aplicativo.
Crie a instância do PostgreSQL:
Console
No Console do Cloud, acesse a página Instâncias do Cloud SQL.
Clique em Create Instance.
Clique em PostgreSQL.
No campo ID da instância, insira
INSTANCE_NAME
.Insira uma senha para o usuário postgres.
Mantenha os valores padrão dos outros campos.
Clique em Criar.
Leva alguns minutos para criar a instância e ela deve estar pronta para uso.
gcloud
Crie a instância do PostgreSQL:
gcloud sql instances create INSTANCE_NAME \ --project PROJECT_ID \ --database-version POSTGRES_13 \ --tier db-f1-micro \ --region REGION
Substitua:
INSTANCE_NAME
: o nome da instância do Cloud SQL.PROJECT_ID
: o ID do projeto do Google CloudREGION
: a região do Google Cloud
Leva alguns minutos para criar a instância e ela deve estar pronta para uso.
Na instância criada, crie um banco de dados:
Console
- Na página da instância, acesse a guia Bancos de dados.
- Clique em Create database.
- Na caixa de diálogo Nome do banco de dados, insira
DATABASE_NAME
. - Clique em Criar.
gcloud
Crie o banco de dados na instância recém-criada:
gcloud sql databases create DATABASE_NAME \ --instance INSTANCE_NAME
Substitua
DATABASE_NAME
por um nome para o banco de dados dentro da instância.
Crie um usuário de banco de dados:
Console
- Na página da instância, acesse a guia Usuários.
- Clique em Adicionar conta de usuário.
- Na caixa de diálogo Adicionar uma conta de usuário à instância, em "Autenticação integrada":
- Digite o nome de usuário
DATABASE_USERNAME
. - Insira a senha
DATABASE_PASSWORD
- Clique em Adicionar.
gcloud
Crie o usuário na instância recém-criada:
gcloud sql users create DATABASE_USERNAME \ --instance INSTANCE_NAME \ --password DATABASE_PASSWORD
Substitua
PASSWORD
por uma senha segura.
Configurar um bucket do Cloud Storage
É possível armazenar recursos estáticos incluídos no Django e mídia enviada por usuários
em armazenamento de objetos altamente disponível usando o Cloud Storage.
O pacote django-storages[google]
processa a interação do Django
com esse back-end de armazenamento.
Console
- In the Google Cloud console, go to the Cloud Storage Buckets page.
- Click Create bucket.
- On the Create a bucket page, enter your bucket information. To go to the next
step, click Continue.
- For Name your bucket, enter a name that meets the bucket naming requirements.
- For Location, select the following: MEDIA_BUCKET
- For Choose a default storage class for your data, select the following: Standard.
- For Choose how to control access to objects, select an Access control option.
- For Advanced settings (optional), specify an encryption method, a retention policy, or bucket labels.
- Click Create.
gcloud
A ferramenta de linha de comando gsutil
foi instalada como parte da instalação da CLI gcloud.
Crie um bucket do Cloud Storage:
gsutil mb -l REGION gs://PROJECT_ID_MEDIA_BUCKET
Substitua
MEDIA_BUCKET
por um sufixo para o bucket de mídia. Combinado com o ID do projeto, isso cria um nome de bucket exclusivo.
Armazenar valores do secret no Secret Manager
Agora que os serviços de backup estão configurados, o Django precisa de informações sobre esses serviços. Em vez de colocar esses valores diretamente no código-fonte do Django, este tutorial usa o Secret Manager para armazenar essas informações com segurança.
O ambiente padrão do App Engine interage com secrets usando a conta de serviço.Criar o arquivo de ambiente Django como um secret do Secret Manager
Você armazena as configurações necessárias para iniciar o Django em um arquivo env protegido.
O aplicativo de amostra usa a API Secret Manager para recuperar o valor do
secret e o pacote django-environ
para carregar os valores no ambiente Django. O secret é configurado
para ser acessível pelo ambiente flexível do App Engine.
Crie um arquivo chamado
.env
, definindo a string de conexão do banco de dados, o nome do bucket de mídia e um novo valorSECRET_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
Armazene o secret no Secret Manager:
Console
No Console do Cloud, acesse a página do Secret Manager.
Clique em Criar secret.
No campo Nome, use
django_settings
.Na caixa de diálogo Valor do secret, cole o conteúdo do arquivo
.env
.Clique em Criar secret.
Exclua o arquivo local para evitar modificações de configuração locais.
gcloud
Crie um novo secret,
django_settings
, com o valor do arquivo.env
:gcloud secrets create django_settings --data-file .env
Para confirmar a criação do secret, verifique-o:
gcloud secrets describe django_settings gcloud secrets versions access latest --secret django_settings
Exclua o arquivo local para evitar modificações de configuração locais:
rm .env
Configure o acesso ao secret:
Console
- Clique na guia Permissões.
- Clique em Adicionar.
- No campo Novos membros, digite
PROJECT_ID@appspot.gserviceaccount.com
e pressioneEnter
. - No menu suspenso Papel, selecione Acessador de secrets do Secret Manager.
- Clique em Save.
gcloud
Conceda acesso ao secret para a conta de serviço flexível do App Engine:
gcloud secrets add-iam-policy-binding django_settings \ --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \ --role roles/secretmanager.secretAccessor
Executar o app no computador local
Com os serviços de backup configurados, agora você pode executar o aplicativo no seu computador. Essa configuração permite o desenvolvimento local, a criação de um superusuário e a aplicação de migrações de banco de dados.
Em um terminal separado, inicie o proxy do Cloud SQL Auth:
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
Essa etapa estabelece uma conexão do computador local com a instância do Cloud SQL para testes locais. Mantenha o proxy do Cloud SQL Auth em execução durante todo o teste local do aplicativo. A execução desse processo em um terminal separado permite que você continue trabalhando enquanto esse processo é executado.
Em um novo terminal, defina o ID do projeto localmente (usado pela API Secret Manager):
Linux/macOS
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
Windows
set GOOGLE_CLOUD_PROJECT=PROJECT_ID
Defina uma variável de ambiente para indicar que você está usando o proxy do Cloud SQL Auth (esse valor é reconhecido no código):
Linux/macOS
export USE_CLOUD_SQL_AUTH_PROXY=true
Windows
set USE_CLOUD_SQL_AUTH_PROXY=true
Execute as migrações do Django para configurar os modelos e os recursos:
python manage.py makemigrations python manage.py makemigrations polls python manage.py migrate python manage.py collectstatic
Inicie o servidor da Web do Django:
python manage.py runserver
No navegador, acesse http://localhost:8000/.
A página exibe o seguinte texto: "Hello, world. Você está no índice de pesquisas". O servidor da Web do Django em execução no seu computador exibe as páginas do aplicativo de amostra.
Pressione
Ctrl
/Cmd
+C
para interromper o servidor da Web local.
Como usar o console de administração do Django
Para fazer login no Admin Console do Django, você precisa criar um superusuário. Como você tem uma conexão acessível localmente com o banco de dados, é possível executar comandos de gerenciamento:
Crie um superusuário. Você será solicitado a inserir um nome de usuário, e-mail e senha.
python manage.py createsuperuser
Inicie um servidor da Web local:
python manage.py runserver
No navegador, acesse http://localhost:8000/admin.
Faça login no site de administração usando o nome de usuário e a senha que você usou ao executar
createsuperuser
.
Como implantar o app no ambiente flexível do App Engine
Com todos os serviços de backup configurados e o aplicativo testado localmente, você pode implantar o aplicativo no ambiente flexível do App Engine:
- Abra
app.yaml
e atualize o valor decloud_sql_instances
com a string de instância do Cloud SQL:... beta_settings: cloud_sql_instances: PROJECT_ID:REGION:INSTANCE_NAME
- Faça upload do aplicativo executando o seguinte comando, que implanta o aplicativo conforme descrito em
app.yaml
e define a versão recém-implantada como a versão padrão, fazendo com que ela veicule todo o novo tráfego:gcloud app deploy
- Quando solicitado, confirme as configurações digitando "sim".
- Aguarde a notificação sobre a conclusão da atualização.
Como executar o aplicativo implantado
O app foi implantado e agora pode ser acessado:
Abra o site implantado:
gcloud app browse
Como alternativa, exiba o URL e abra manualmente:
gcloud app describe --format "value(defaultHostname)"
Sua solicitação é atendida por um servidor da Web em execução no ambiente flexível do App Engine.
Atualização do aplicativo
Para atualizar seu aplicativo, faça alterações no código e execute o comando gcloud app deploy
novamente.
A implantação cria uma nova versão do aplicativo e a define como padrão. As versões anteriores do app são mantidas, assim como as instâncias de máquina virtual (VM, na sigla em inglês) associadas. Todas essas versões de app e instâncias de VM são recursos faturáveis. Para reduzir custos, exclua as versões não padrão do seu app.
Como configurar para produção
Agora você tem uma implantação do Django funcionando, mas pode seguir algumas etapas para garantir que seu aplicativo esteja pronto para produção.
Desativar depuração
Confirme se a variável DEBUG
em mysite/settings.py
está definida como False
. Isso
impedirá que as páginas de erro detalhadas sejam exibidas para o usuário, o que pode vazar informações sobre as configurações.
Limitar os privilégios de usuário do banco de dados
Todos os usuários criados com o Cloud SQL têm os privilégios associados ao
papel cloudsqlsuperuser
:
CREATEROLE
, CREATEDB
e LOGIN
.
Para impedir que o usuário do banco de dados do Django tenha essas permissões, crie-o manualmente no PostgreSQL. Você precisará ter o terminal interativo psql
instalado ou usar o Cloud Shell com essa ferramenta pré-instalada.
Console
-
In the Google Cloud console, activate Cloud Shell.
No Cloud Shell, use o terminal integrado para se conectar à instância
INSTANCE_NAME
:gcloud sql connect INSTANCE_NAME --user postgres
Insira a senha do usuário do postgres.
Agora você está usando o
psql
. Você verá o promptpostgres=>
.Crie um usuário:
CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
Substitua
PASSWORD
por uma senha aleatória e exclusiva.Conceda direitos totais sobre o novo banco de dados para o novo usuário:
GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
Saia de
psql
:\q
gcloud
Inicie uma conexão com a instância do SQL:
gcloud sql connect INSTANCE_NAME --user postgres
Substitua
INSTANCE_NAME
pela instância criada do Cloud SQL.Insira a senha do usuário do postgres.
Agora você está usando o
psql
. Você verá o promptpostgres=>
.Crie um usuário:
CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
Conceda direitos totais sobre o novo banco de dados para o novo usuário:
GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
Saia de
psql
:\q
Entenda o código
Exemplo de aplicativo
O app de exemplo do Django foi criado com ferramentas padrão do Django. Os comandos a seguir criam o projeto e o aplicativo de pesquisa:
django-admin startproject mysite
python manage.py startapp polls
As visualizações básicas, os modelos e as configurações de rota foram copiados de Como criar seu primeiro aplicativo Django (Parte 1 e Parte 2).
Secrets do Secret Manager
O arquivo settings.py
contém o código que usa a API Secret Manager Python para recuperar a versão mais recente do secret nomeado e extraí-la para o ambiente (usando django-environ
):
O secret foi usado para armazenar diversos valores de secret para reduzir o número de diferentes secrets que precisavam ser configurados.
Substituições de secret local
Se um arquivo .env
for encontrado no sistema de arquivos local, ele será usado no lugar do valor do Secret Manager. Criar um arquivo .env
localmente pode ajudar com testes locais. Por exemplo, desenvolvimento local em um banco de dados SQLite ou outras configurações locais.
Conexão com o banco de dados
O arquivo settings.py
contém a configuração do banco de dados SQL. Se você
definir o USE_CLOUD_SQL_AUTH_PROXY
, a configuração DATABASES
será alterada para inferir
o uso do proxy do Cloud SQL Auth.
Estática, armazenada em nuvem
O arquivo settings.py
também usa django-storages
para integrar o bucket de mídia do Cloud Storage diretamente ao projeto:
App Engine app.yaml
O arquivo
app.yaml
contém informações de configuração da implantação no ambiente flexível:
Limpar
Para evitar cobranças na sua conta do Google Cloud pelos recursos usados no tutorial, exclua o projeto que os contém ou mantenha o projeto e exclua os recursos individuais.
Excluir o projeto
- 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.
A seguir
- Saiba como configurar o PostgreSQL para produção
- Saiba mais sobre o Django no Google Cloud.