Las apps de Django que se ejecutan en el estándar de App Engine escalan dinámicamente según el tráfico.
En este instructivo, se da por sentado que conoces el desarrollo web con Django. Si es la primera vez que desarrollas con Django, es recomendable que escribas tu primera app de Django antes de continuar.
Si bien en este instructivo se muestra Django de forma específica, puedes usar este proceso de implementación con otros marcos de trabajo basados en Django, como Wagtail y el Django CMS.
En este instructivo, se usa Django 4, que requiere al menos Python 3.8. La versión estándar de App Engine admite Python 3.7 y versiones posteriores, incluido Python 3.8.
Objetivos
En este instructivo, podrás:
- Crear y conectar una base de datos de Cloud SQL
- Crear y usar valores secretos de Secret Manager
- Implementa una app de Django en el entorno estándar de App Engine.
Costos
En este documento, usarás los siguientes componentes facturables de Google Cloud:
Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios.
Antes de comenzar
- 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
- Si aún no lo hiciste, inicializa App Engine y selecciona tu región preferida:
gcloud app create
Prepara el entorno
Clona una app de ejemplo
El código de la app de ejemplo de Django está en el repositorio GoogleCloudPlatform/python-docs-samples en GitHub.
Puedes descargar la muestra como un archivo ZIP y extraerla o clonar el repositorio en tu máquina local:
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Ve al directorio que contiene el código de muestra:
Linux/macOS
cd python-docs-samples/appengine/standard_python3/django
Windows
cd python-docs-samples\appengine\standard_python3\django
Confirma la configuración de Python
En este instructivo, se usa Python para ejecutar la aplicación de ejemplo en tu máquina. El código de ejemplo también requiere la instalación de dependencias.
Para obtener más detalles, consulta la guía del entorno de desarrollo de Python.
Confirma que tu Python tenga al menos la versión 3.8.
python -V
Deberías ver
Python 3.8.0
o una versión posterior.Crea un entorno virtual de Python y, luego, instala las dependencias:
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
Descarga el proxy de autenticación de Cloud SQL para conectarte a Cloud SQL desde tu máquina local
Cuando se implementa, tu app usa el proxy de autenticación de Cloud SQL integrado en el entorno estándar de App Engine para comunicarse con tu instancia de Cloud SQL. Sin embargo, para probar tu aplicación de manera local, debes instalar y usar una copia local del proxy en tu entorno de desarrollo. Para obtener más detalles, consulta la guía del proxy de autenticación de Cloud SQL.
El proxy de autenticación de Cloud SQL usa la API de Cloud SQL para interactuar con tu instancia de SQL. Para ello, requiere la autenticación de la aplicación a través de gcloud CLI.
Autentica y adquiere credenciales para la API:
gcloud auth application-default login
Descarga e instala el proxy de autenticación de Cloud SQL en tu máquina local.
Linux de 64 bits
- Descarga el proxy de autenticación de 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
- Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
chmod +x cloud-sql-proxy
Linux de 32 bits
- Descarga el proxy de autenticación de 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
- Si no se encuentra el comando
curl
, ejecutasudo apt install curl
y repite el comando de descarga. - Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
chmod +x cloud-sql-proxy
macOS de 64 bits
- Descarga el proxy de autenticación de 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
- Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
chmod +x cloud-sql-proxy
Mac M1
- Descarga el proxy de autenticación de 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
- Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
chmod +x cloud-sql-proxy
Windows de 64 bits
Haz clic con el botón derecho en https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.x64.exe y selecciona Guardar vínculo como para descargar el proxy de autenticación de Cloud SQL. Cambia el nombre del archivo porcloud-sql-proxy.exe
.Windows de 32 bits
Haz clic con el botón derecho en https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.14.1/cloud-sql-proxy.x86.exe y selecciona Guardar vínculo como para descargar el proxy de autenticación de Cloud SQL. Cambia el nombre del archivo porcloud-sql-proxy.exe
.Imagen de Docker del proxy de Cloud SQL
El proxy de autenticación de Cloud SQL tiene diferentes imágenes de contenedor, como
distroless
,alpine
ybuster
. La imagen de contenedor del proxy de autenticación de Cloud SQL predeterminada usadistroless
, que no contiene shell. Si necesitas una shell o herramientas relacionadas, descarga una imagen basada enalpine
obuster
. Para obtener más información, consulta Imágenes de contenedor del proxy de autenticación de Cloud SQL.Puedes extraer la última imagen a tu máquina local con Docker a través del siguiente comando:
docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.14.1
Otro SO
Para otros sistemas operativos que no se incluyen aquí, puedes compilar el proxy de autenticación de Cloud SQL desde la fuente.Puedes mover la descarga a un lugar común, como una ubicación en tu
PATH
o tu directorio principal. Si decides hacerlo, cuando inicies el proxy de autenticación de Cloud SQL más adelante en el instructivo, recuerda hacer referencia a la ubicación que elegiste cuando uses los comandoscloud-sql-proxy
.- Descarga el proxy de autenticación de Cloud SQL:
Crea servicios de copia de seguridad
En este instructivo, se usan varios servicios de Google Cloud para proporcionar la base de datos, el almacenamiento de contenido multimedia y el almacenamiento secreto que admiten el proyecto de Django implementado. Estos servicios se implementan en una región específica. Para lograr la eficiencia entre los servicios, todos deben implementarse en la misma región. Para obtener más información sobre la región más cercana, consulta Productos disponibles por región.
En este instructivo, se usan los mecanismos integrados de hosting de recursos estáticos en App Engine estándar.Configura una instancia de Cloud SQL para PostgreSQL
Django admite oficialmente varias bases de datos relacionales, pero ofrece la mayor compatibilidad con PostgreSQL. Cloud SQL admite PostgreSQL, por lo que en este instructivo se elige usar ese tipo de base de datos.
En la siguiente sección, se describe la creación de una instancia, una base de datos y un usuario de base de datos de PostgreSQL para la app.
Crea la instancia de PostgreSQL:
Console
En la consola de Google Cloud, ve a la página Instancias de Cloud SQL.
Haga clic en Crear instancia.
Haz clic en Elegir PostgreSQL.
En Edición de SQL, elige "Enterprise".
En Edición predeterminada, elige "Zona de pruebas".
En el campo ID de instancia, ingresa
INSTANCE_NAME
.Ingresa una contraseña para el usuario de postgres.
Mantén los valores predeterminados en los otros campos.
Haz clic en Crear instancia.
La instancia tarda unos minutos en estar lista para su uso.
gcloud
Crea la instancia de PostgreSQL:
gcloud sql instances create INSTANCE_NAME \ --project PROJECT_ID \ --database-version POSTGRES_16 \ --tier db-n1-standard-2 \ --region REGION
Reemplaza lo siguiente:
INSTANCE_NAME
: El nombre de la instancia de Cloud SQLPROJECT_ID
: El ID del proyecto de Google CloudREGION
: la región de Google Cloud
La instancia demora unos minutos en crearse y estar lista para su uso.
Dentro de la instancia creada, crea una base de datos:
Console
- En la página de tu instancia, ve a la pestaña Bases de datos.
- Haz clic en Crear base de datos.
- En el diálogo Nombre de la base de datos, ingresa
DATABASE_NAME
. - Haz clic en Crear.
gcloud
Crea la base de datos en la instancia creada recientemente:
gcloud sql databases create DATABASE_NAME \ --instance INSTANCE_NAME
Reemplaza
DATABASE_NAME
por un nombre para la base de datos dentro de la instancia.
Crea un usuario de base de datos:
Console
- En la página de tu instancia, ve a la pestaña Usuarios.
- Haz clic en Agregar cuenta de usuario.
- En el diálogo Elige la forma de autenticación, en "Autenticación integrada", haz lo siguiente:
- Ingresa el nombre de usuario
DATABASE_USERNAME
. - Ingresa la contraseña
DATABASE_PASSWORD
- Haga clic en Agregar.
gcloud
Crea el usuario dentro de la instancia creada recientemente:
gcloud sql users create DATABASE_USERNAME \ --instance INSTANCE_NAME \ --password DATABASE_PASSWORD
Reemplaza
PASSWORD
por una contraseña segura.
Almacena valores secretos en el Secret Manager
Ahora que se configuraron los servicios de copia de seguridad, Django necesita información sobre estos servicios. En lugar de colocar estos valores directamente en el código fuente de Django, en este instructivo se usa Secret Manager para almacenar esta información de forma segura.
Cree un archivo de entorno de Django como un secreto del Secret Manager
Almacenas la configuración necesaria para iniciar Django en un archivo env seguro.
La app de ejemplo usa la API de Secret Manager para recuperar el valor secreto y el paquete django-environ
para cargar los valores en el entorno de Django. El secreto está configurado para que App Engine estándar pueda acceder a él.
Crea un archivo llamado
.env
en el que se defina la cadena de conexión de la base de datos, el nombre del bucket de contenido multimedia y un nuevo 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
Almacena el secreto en Secret Manager:
Console
En la consola de Google Cloud, ve a la página de Secret Manager.
Haz clic en Crear Secreto.
En el campo Nombre, ingresa
django_settings
.En el cuadro de diálogo Valor del secreto, pega el contenido de tu archivo
.env
.Haz clic en Crear secreto.
Borra el archivo local para evitar las anulaciones de la configuración local.
gcloud
Crea un secreto nuevo,
django_settings
, con el valor del archivo.env
:gcloud secrets create django_settings --data-file .env
Borra el archivo local para evitar las anulaciones de la configuración local:
rm .env
Configura el acceso al Secret:
Console
Haz clic en la pestaña Permisos.
Haz clic en Otorgar acceso.
En el campo Miembros nuevos, ingresa
PROJECT_ID@appspot.gserviceaccount.com
y, luego, presionaEnter
.En el menú desplegable Función, selecciona Descriptor de acceso a secretos de Secret Manager.
Haz clic en Guardar.
gcloud
Otorga acceso al Secret a la cuenta de servicio estándar de App Engine:
gcloud secrets add-iam-policy-binding django_settings \ --member serviceAccount:PROJECT_ID@appspot.gserviceaccount.com \ --role roles/secretmanager.secretAccessor
En el resultado, confirma que bindings
muestre la cuenta de servicio nueva.
Cómo ejecutar la app en una computadora local
Con los servicios de resguardo configurados, ahora puedes ejecutar la app en tu computadora. Esta configuración permite el desarrollo local, la creación de un superusuario y la aplicación de migraciones de bases de datos.
En otra terminal, inicia el proxy de Cloud SQL Auth:
Linux/macOS
./cloud-sql-proxy PROJECT_ID:REGION:INSTANCE_NAME
Windows
cloud-sql-proxy.exe PROJECT_ID:REGION:INSTANCE_NAME
En este paso, se establece una conexión entre tu computadora local y tu instancia de Cloud SQL para realizar pruebas locales. Mantén el proxy de Cloud SQL Auth en ejecución durante todo el tiempo que realices pruebas locales en tu app. Ejecutar este proceso en una terminal independiente te permite seguir trabajando mientras se ejecuta.
En la terminal original, establece el ID de proyecto de forma local (que usa la API de Secret Manager):
Linux/macOS
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
Windows
set GOOGLE_CLOUD_PROJECT=PROJECT_ID
Establece una variable de entorno para indicar que usas el proxy de autenticación de Cloud SQL (este valor se reconoce en el código):
Linux/macOS
export USE_CLOUD_SQL_AUTH_PROXY=true
Windows
set USE_CLOUD_SQL_AUTH_PROXY=true
Ejecuta las migraciones de Django para configurar tus modelos y recursos:
python manage.py makemigrations python manage.py makemigrations polls python manage.py migrate python manage.py collectstatic
Inicia el servidor web de Django:
python manage.py runserver 8080
En tu navegador, ve a http://localhost:8080.
Si estás en Cloud Shell, haz clic en el botón Vista previa en la Web y selecciona Vista previa en el puerto 8080.
En la página, se muestra el siguiente texto: “Hello, world. You're at the polls index”. El servidor web de Django que se ejecuta en tu computadora proporciona las páginas de la app de muestra.
Presiona
Ctrl
/Cmd
+C
para detener el servidor web local.
Usar la Consola del administrador de Django
Para acceder a la consola de administración de Django, debes crear un superusuario. Como tienes una conexión de acceso local a la base de datos, puedes ejecutar comandos de administración:
Crea un superusuario. Se te pedirá que ingreses un nombre de usuario, un correo electrónico y una contraseña.
python manage.py createsuperuser
Inicia un servidor web local:
python manage.py runserver
En tu navegador, ve a http://localhost:8000/admin.
Accede al sitio del administrador con el nombre de usuario y la contraseña que usaste cuando ejecutaste
createsuperuser
.
Implementar la app en el entorno estándar de App Engine
Con todos los servicios de respaldo configurados y la aplicación probada de forma local, ahora puedes implementarla en App Engine estándar:
- Para subir la app, ejecuta el siguiente comando, que implementa la app como se describe en
app.yaml
y configura la versión recién implementada como la versión predeterminada, lo que hace que entregue todo el tráfico nuevo:gcloud app deploy
- Para confirmar la configuración, escribe "yes" cuando se te solicite.
- Espera a que aparezca el mensaje que informa que la actualización se completó.
- Abre
app.yaml
y actualiza el valor deAPPENGINE_URL
con la URL implementada:... env_variables: APPENGINE_URL: https://PROJECT_ID.uc.r.appspot.com
- Sube los cambios de configuración:
gcloud app deploy
Ejecuta la app implementada
Se implementó la app y ahora se puede acceder a ella de las siguientes maneras:
Abre el sitio web implementado:
gcloud app browse
Como alternativa, muestra la URL y ábrela de forma manual:
gcloud app describe --format "value(defaultHostname)"
Un servidor web que se ejecuta en el entorno estándar de App Engine entrega tu solicitud.
Actualizar la aplicación
Para actualizar la aplicación, realiza cambios en el código y, luego, vuelve a ejecutar el comando gcloud app deploy
.
La implementación crea una versión nueva de tu app y la convierte en la versión predeterminada. Se conservan las versiones anteriores de la app. Todas estas versiones de la app son recursos facturables. Para reducir costos, borra las versiones no predeterminadas de tu app.
Configuración para producción
Ahora tienes una implementación de Django que funciona, pero puedes seguir otros pasos para asegurarte de que tu aplicación esté lista para la producción.
Cómo inhabilitar la depuración
Confirma que la variable DEBUG
en mysite/settings.py
esté configurada como False
. Esto evitará que se muestren páginas de error detalladas al usuario, lo que puede filtrar información sobre las configuraciones.
Limita los privilegios de los usuarios de la base de datos
Cualquier usuario que se cree con Cloud SQL tiene los privilegios asociados al rol cloudsqlsuperuser
: CREATEROLE
, CREATEDB
y LOGIN
.
Para evitar que el usuario de la base de datos de Django tenga estos permisos, créalo manualmente en PostgreSQL. Deberás tener instalada la terminal interactiva psql
o usar Cloud Shell, que tiene esta herramienta preinstalada.
Console
-
In the Google Cloud console, activate Cloud Shell.
En Cloud Shell, usa la terminal integrada para conectarte a tu instancia de
INSTANCE_NAME
:gcloud sql connect INSTANCE_NAME --user postgres
Ingresa la contraseña del usuario de postgres.
Ahora estás usando
psql
. Deberías ver un mensaje depostgres=>
.Crear un usuario
CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
Reemplaza
PASSWORD
por una contraseña única y aleatoria.Otorga derechos completos sobre la base de datos nueva al usuario nuevo:
GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
Salga de
psql
:\q
gcloud
Inicia una conexión a la instancia de SQL:
gcloud sql connect INSTANCE_NAME --user postgres
Reemplaza
INSTANCE_NAME
por la instancia de Cloud SQL creada.Ingresa la contraseña del usuario de postgres.
Ahora estás usando
psql
. Deberías ver un mensaje depostgres=>
.Crear un usuario
CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
Otorga derechos completos sobre la base de datos nueva al usuario nuevo:
GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
Salga de
psql
:\q
Examine el código
Aplicación de muestra
La app de muestra de Django se creó con las herramientas estándar de Django. Con los siguientes comandos, se crea el proyecto y la app de encuestas:
django-admin startproject mysite
python manage.py startapp polls
Las vistas, los modelos y las configuraciones de ruta base se copiaron de Cómo escribir tu primera app de Django (Parte 1 y Parte 2).
Secretos del Secret Manager
El archivo settings.py
contiene código que usa la API de Python de Secret Manager para recuperar la versión más reciente del secreto con nombre y transferirlo al entorno (con django-environ
):
El secreto se usa para almacenar varios valores secretos y reducir la cantidad de secretos diferentes que se deben configurar.
Configuraciones de CSRF
Django tiene protección integrada contra la falsificación de solicitudes entre sitios (CSRF). A partir de Django 4.0, los cambios en la forma en que funciona esto significan que es importante decirle a Django cuál es su URL alojada para que pueda ofrecer las mejores protecciones para los usuarios que envían datos.
Proporcionas la URL de la app como una variable de entorno en el archivo settings.py
. Este es el valor que Django usa para la configuración relevante.
Anulaciones de Secrets locales
Si se encuentra un archivo .env
en el sistema de archivos local, se usa en lugar del valor de Secret Manager. Crear un archivo .env
de forma local puede ayudar con las pruebas locales (p.ej., desarrollo local en una base de datos SQLite o cualquier otra configuración local).
Conexión a base de datos
El archivo settings.py
contiene la configuración de tu base de datos de SQL: Usa el auxiliar env.db()
de django-environ
para cargar la cadena de conexión establecida en DATABASE_URL
en la configuración de DATABASES
.
Cuando se ejecuta la aplicación de forma local y se usa el proxy de autenticación de Cloud SQL para acceder a la base de datos alojada, la marca USE_CLOUD_SQL_AUTH_PROXY
ajusta la configuración de la base de datos para usar el proxy.
Contenido estático alojado
El archivo app.yaml
contiene información de configuración para la implementación en App Engine.
Este archivo app.yaml
especifica que App Engine entrega archivos estáticos desde el directorio static/
:
Cuando se ejecuta la app de forma local con DEBUG
habilitado, Django entrega estos archivos de forma local:
Limpia
Para evitar que se apliquen cargos a tu cuenta de Google Cloud por los recursos usados en este instructivo, borra el proyecto que contiene los recursos o conserva el proyecto y borra los recursos individuales.
Borra el proyecto
- 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.
¿Qué sigue?
- Aprende a configurar PostgreSQL para producción
- Obtén más información sobre Django en Google Cloud