Las apps de Django que se ejecutan en App Engine estándar se escalan dinámicamente según el tráfico.
En este instructivo, se da por sentado que tienes conocimientos de 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. El entorno 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
- Crea y usa valores de 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
- Accede a tu cuenta de Google Cloud . Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud SQL Admin API, Secret Manager, and Cloud Build APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles.-
Instala la CLI de gcloud.
-
Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.
-
Para inicializar gcloud CLI, ejecuta el siguiente comando:
gcloud init -
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Cloud SQL Admin API, Secret Manager, and Cloud Build APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enablepermission. Learn how to grant roles.-
Instala la CLI de gcloud.
-
Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.
-
Para inicializar gcloud CLI, ejecuta el siguiente comando:
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 muestra 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.gitVe al directorio que contiene el código de muestra:
Linux/macOS
cd python-docs-samples/appengine/standard_python3/djangoWindows
cd python-docs-samples\appengine\standard_python3\django
Confirma tu 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 versión de Python sea al menos la 3.8.
python -VDeberías ver
Python 3.8.0o 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.txtWindows
python -m venv venv venv\scripts\activate pip install --upgrade pip pip install -r requirements.txt
Descarga el proxy de Cloud SQL Auth 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 Cloud SQL Auth.
El proxy de autenticación de Cloud SQL usa la API de Cloud SQL para interactuar con tu instancia de SQL. Para ello, se 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 loginDescarga e instala el proxy de Cloud SQL Auth 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.21.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.21.1/cloud-sql-proxy.linux.386
- Si no se encuentra el comando
curl, ejecutasudo apt install curly 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.21.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.21.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.21.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.21.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,alpineybuster. 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 enalpineobuster. 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.21.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
PATHo 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 respaldo
En este instructivo, se usan varios Google Cloud servicios para proporcionar la base de datos, el almacenamiento de medios y el almacenamiento de secretos que admiten el proyecto de Django implementado. Estos servicios se implementan en una región específica. Para lograr 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 a ti, consulta Productos disponibles por región.
En este instructivo, se usan los mecanismos integrados de hosting de activos 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 SQL Edition, elige "Enterprise".
En Ajuste predeterminado de edición, 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: Es el ID del proyecto de Google Cloud .REGION: La región deGoogle 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 Database Name, 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_NAMEReemplaza
DATABASE_NAMEpor 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 en la instancia creada recientemente:
gcloud sql users create DATABASE_USERNAME \ --instance INSTANCE_NAME \ --password DATABASE_PASSWORDReemplaza
PASSWORDpor una contraseña segura.
Almacena valores secretos en el Secret Manager
Ahora que los servicios de respaldo están configurados, Django necesita información sobre ellos. En lugar de colocar estos valores directamente en el código fuente de Django, este instructivo 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 muestra usa la API de Secret Manager para recuperar el valor del secreto y el paquete django-environ para cargar los valores en el entorno de Django. El secreto está configurado para que sea accesible desde App Engine estándar.
Crea un archivo llamado
.env, en el que se definan la cadena de conexión de la base de datos, el nombre del bucket de medios y un nuevo valor deSECRET_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) >> .envAlmacena 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 diálogo Valor del secreto, pega el contenido de tu archivo
.env.Haz clic en Crear secreto.
Borra el archivo local para evitar las invalidaciones de la configuración local.
gcloud
Crea un nuevo secreto,
django_settings, con el valor del archivo.env:gcloud secrets create django_settings --data-file .envBorra el archivo local para evitar las invalidaciones de la configuración local:
rm .env
Configura el acceso al secreto:
Console
Haz clic en la pestaña Permisos.
Haz clic en Otorgar acceso.
En el campo Miembros nuevos, ingresa
PROJECT_ID@appspot.gserviceaccount.comy, 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 secreto 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 enumera la nueva cuenta de servicio.
Cómo ejecutar la app en una computadora local
Con los servicios de respaldo 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 una terminal independiente, inicia el proxy de Cloud SQL Auth:
Linux/macOS
./cloud-sql-proxy PROJECT_ID:REGION:INSTANCE_NAMEWindows
cloud-sql-proxy.exe PROJECT_ID:REGION:INSTANCE_NAMEEn este paso, se establece una conexión entre tu computadora local y tu instancia de Cloud SQL a fin de realizar pruebas locales. Mantén el proxy de autenticación de Cloud SQL en ejecución durante todo el tiempo que realices pruebas locales en tu app. Ejecutar este proceso en una terminal separada te permite seguir trabajando mientras se ejecuta.
En la terminal original, establece el ID del proyecto de forma local (lo usa la API de Secret Manager):
Linux/macOS
export GOOGLE_CLOUD_PROJECT=PROJECT_IDWindows
set GOOGLE_CLOUD_PROJECT=PROJECT_IDEstablece 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=trueWindows
set USE_CLOUD_SQL_AUTH_PROXY=trueEjecuta 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 collectstaticInicia el servidor web de Django:
python manage.py runserver 8080En 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+Cpara 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 a la base de datos a la que se puede acceder de forma local, 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 createsuperuserInicia un servidor web local:
python manage.py runserverEn 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 implementar la aplicación en App Engine estándar:
- Para subir la app, ejecuta el siguiente comando, que implementa la app como se describe en
app.yamly establece 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.yamly actualiza el valor deAPPENGINE_URLcon la URL implementada:... env_variables: APPENGINE_URL: https://PROJECT_ID.uc.r.appspot.com - Sube los cambios de configuración:
gcloud app deploy
Cómo ejecutar la app implementada
Se implementó la app y ahora se puede acceder a ella:
Abre el sitio web implementado:
gcloud app browseComo 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 tu 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 tu 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 en funcionamiento, 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é establecida en 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 del usuario 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, crea el usuario de forma manual en PostgreSQL. Deberás tener instalado el terminal interactivo de psql o usar Cloud Shell, que tiene esta herramienta preinstalada.
Console
-
En la consola de Google Cloud , activa Cloud Shell.
En Cloud Shell, usa la terminal integrada para conectarte a tu instancia
INSTANCE_NAME:gcloud sql connect INSTANCE_NAME --user postgresIngresa la contraseña del usuario de postgres.
Ahora estás usando
psql. Deberías ver el mensaje depostgres=>.Crear un usuario
CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';Reemplaza
PASSWORDpor una contraseña aleatoria y única.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 postgresReemplaza
INSTANCE_NAMEpor la instancia de Cloud SQL creada.Ingresa la contraseña del usuario de postgres.
Ahora estás usando
psql. Deberías ver el 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 rutas base se copiaron de 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 Secret Manager en Python para recuperar la versión más reciente del secreto con nombre y extraerlo 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.
Configuración 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 indicarle a Django cuál es su URL alojada, de modo 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 pertinente.
Anulaciones de secretos 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 otro parámetro de 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 asistente env.db() de django-environ para cargar la cadena de conexión establecida en DATABASE_URL en el parámetro de configuración DATABASES.
Cuando ejecutas la aplicación de forma local y usas 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 ejecutas la app de forma local con DEBUG habilitado, Django entrega estos archivos de forma local:
Realiza una limpieza
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
- En la Google Cloud consola, ve a la página Administrar recursos.
- En la lista de proyectos, elige el proyecto que quieres borrar y haz clic en Borrar.
- En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.
¿Qué sigue?
- Aprende a configurar PostgreSQL para la producción
- Obtén más información sobre Django en Google Cloud