Ejecuta Django en el entorno estándar de App Engine

Las apps de Django que se ejecutan en el entorno estándar de App Engine escalan dinámicamente según el tráfico.

En este instructivo, se supone que estás familiarizado con el desarrollo web de Django. Si es la primera vez que usas las herramientas de desarrollo de Django, te recomendamos escribir 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 3, que requiere al menos Python 3.7. App Engine estándar es compatible con Python 3.7 y versiones posteriores.

Objetivos

En este instructivo, podrás:

  • Crear y conectar una base de datos de Cloud SQL
  • Crea y usa los valores secretos de Secret Manager.
  • Implementa una app de Django en el entorno estándar de App Engine.

Costos

En este instructivo, se usan 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. Es posible que los usuarios nuevos de Google Cloud sean aptos para obtener una prueba gratuita.

Antes de comenzar

  1. 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.
  2. En la página del selector de proyectos de Google Cloud Console, selecciona o crea un proyecto de Google Cloud.

    Ir al selector de proyecto

  3. Asegúrate de que la facturación esté habilitada para tu proyecto de Cloud. Descubre cómo confirmar que tienes habilitada la facturación en un proyecto.

  4. Habilita las API de Cloud SQL Admin API, Secret Manager, and Cloud Build.

    Habilita las API

  5. Instala e inicializa el SDK de Cloud.
  6. 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.

  1. 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
    
  2. 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

Este instructivo se basa en Python para ejecutar la aplicación de muestra en tu máquina. El código de muestra también requiere la instalación de dependencias

Para obtener más detalles, consulta la guía del entorno de desarrollo de Python.

  1. Confirma que tu versión de Python sea al menos la versión 3.7.

     python -V
    

    Deberías ver Python 3.7.3 o versiones posteriores.

  2. Crea un entorno virtual de Python e 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 env
    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, la app usa el proxy de autenticación de Cloud SQL que está integrado en el entorno estándar de App Engine para comunicarse con la 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, se requiere la autenticación de la aplicación mediante gcloud.

  1. Autentica y adquiere credenciales para la API:

    gcloud auth application-default login
    
  2. Descarga y, luego, instala el proxy de autenticación de Cloud SQL en tu máquina local.

    Linux de 64 bits

    1. Descarga el proxy de autenticación de Cloud SQL:
      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 -O cloud_sql_proxy
      
    2. Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
      chmod +x cloud_sql_proxy
      

    Linux de 32 bits

    1. Descarga el proxy de autenticación de Cloud SQL:
      wget https://dl.google.com/cloudsql/cloud_sql_proxy.linux.386 -O cloud_sql_proxy
      
    2. Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
      chmod +x cloud_sql_proxy
      

    macOS de 64 bits

    1. Descarga el proxy de autenticación de Cloud SQL:
      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.amd64
      
    2. Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
      chmod +x cloud_sql_proxy
      

    macOS de 32 bits

    1. Descarga el proxy de autenticación de Cloud SQL:
      curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.386
      
    2. Haz que el proxy de autenticación de Cloud SQL sea ejecutable:
      chmod +x cloud_sql_proxy
      

    Windows de 64 bits

    Para descargar el proxy de autenticación de Cloud SQL, haz clic con el botón derecho en https://dl.google.com/cloudsql/cloud_sql_proxy_x64.exe y selecciona Guardar vínculo como. Cambia el nombre del archivo por cloud_sql_proxy.exe.

    Windows de 32 bits

    Para descargar el proxy de autenticación de Cloud SQL, haz clic derecho en https://dl.google.com/cloudsql/cloud_sql_proxy_x86.exe y selecciona Guardar vínculo como. Cambia el nombre del archivo por cloud_sql_proxy.exe.

    Imagen de Docker del proxy de Cloud SQL Auth

    Para mayor comodidad, varias imágenes de contenedor que contienen el proxy de autenticación de Cloud SQL están disponibles en GitHub en el repositorio del proxy de autenticación de Cloud SQL. Puedes extraer la última imagen a tu máquina local usando Docker mediante el siguiente comando:
    docker pull gcr.io/cloudsql-docker/gce-proxy:1.19.1
    

    Otro SO

    Para otros sistemas operativos que no se incluyen aquí, puedes compilar el proxy de Cloud SQL Auth desde la fuente.

    Puedes mover la descarga a un lugar común, como una ubicación de 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 elegida cuando uses los comandos cloud_sql_proxy.

Crear 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 Django implementado. Estos servicios se implementan en una región específica. Para que los servicios sean eficientes, es mejor implementar todos los servicios en la misma región. Para obtener más información sobre la región más cercana a tu ubicación, consulta Productos disponibles por región.

En este instructivo, se opta por usar los mecanismos de hosting de elementos estáticos integrados en el entorno estándar de App Engine.

Configura una instancia de Cloud SQL para PostgreSQL

Django tiene compatibilidad oficial con varias bases de datos relacionales, pero ofrece la mayor compatibilidad con PostgreSQL. Como PostgreSQL es compatible con Cloud SQL, en este instructivo se usa ese tipo de base de datos.

En la siguiente sección, se describe la creación de una instancia de PostgreSQL, una base de datos y un usuario de base de datos para la app.

  1. Crea la instancia de PostgreSQL

    Console

    1. En Cloud Console, ve a la página Instancias de Cloud SQL:

      Ir a la página de instancias de Cloud SQL

    2. Haga clic en Crear instancia.

    3. Haz clic en PostgreSQL.

    4. En el campo ID de instancia, ingresa INSTANCE_NAME.

    5. Ingresa una contraseña para el usuario de postgres.

    6. Mantén los valores predeterminados en los otros campos.

    7. Haga clic en Crear.

    La instancia toma unos minutos en crearse y estar lista para su uso.

    gcloud

    • Crea la instancia de PostgreSQL:

      gcloud sql instances create INSTANCE_NAME \
          --project PROJECT_ID \
          --database-version POSTGRES_13 \
          --tier db-f1-micro \
          --region REGION
      

    Reemplaza lo siguiente:

    • INSTANCE_NAME: Es el nombre de la instancia de Cloud SQL.
    • PROJECT_ID: El ID del proyecto de Google Cloud
    • REGION: La región de Google Cloud

    La instancia toma unos minutos en crearse y estar lista para su uso.

  2. Dentro de la instancia creada, crea una base de datos:

    Console

    1. En la página de tu instancia, ve a la pestaña Bases de datos.
    2. Haga clic en Create database.
    3. En el cuadro de diálogo Nombre de la base de datos, ingresa DATABASE_NAME.
    4. Haga clic en Crear.

    gcloud

    • Crea la base de datos dentro de la instancia recién creada:

      gcloud sql databases create DATABASE_NAME \
          --instance INSTANCE_NAME
      

      Reemplaza DATABASE_NAME por un nombre para la base de datos dentro de la instancia.

  3. Crea un usuario de la base de datos

    Console

    1. En la página de tu instancia, ve a la pestaña Usuarios.
    2. Haz clic en Agregar cuenta de usuario.
    3. En el diálogo Agrega una cuenta de usuario a la instancia, en "Autenticación integrada", haz lo siguiente:
    4. Ingresa el nombre de usuario DATABASE_USERNAME.
    5. Ingresa la contraseña DATABASE_PASSWORD
    6. Haga clic en Add.

    gcloud

    • Crea el usuario en 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 los servicios de copia de seguridad están configurados, Django necesita información sobre estos servicios. En lugar de ingresar 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.

El estándar de App Engine interactúa con los secretos mediante su cuenta de servicio.

Cree un archivo de entorno de Django como un secreto del Secret Manager

Almacena la configuración necesaria para iniciar Django en un archivo de entorno seguro. La app de muestra usa la API de Secret Manager para recuperar el valor del secreto y el paquete django-environ a fin de cargar los valores en el entorno de Django. El secreto está configurado para que sea accesible en el estándar de App Engine.

  1. Crea un archivo llamado .env que defina la string de conexión de la base de datos, el nombre del bucket multimedia y un nuevo valor de SECRET_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
    
  2. Almacena el secreto en Secret Manager:

    Console

    1. En Cloud Console, ve a la página Administrador de secretos.

      Ir a la página de Secret Manager

    2. Haz clic en Crear Secreto.

    3. En el campo Nombre, ingresa django_settings.

    4. En el cuadro de diálogo Valor del secreto, pega el contenido de tu archivo .env.

    5. Haz clic en Crear secreto.

    6. Borra el archivo local para evitar anulaciones de configuración locales.

    gcloud

    1. Crea un secreto nuevo, django_settings, con el valor del archivo .env:

      gcloud secrets create django_settings --data-file .env
      
    2. Para confirmar la creación del secreto, verifica lo siguiente:

      gcloud secrets describe django_settings
      
      gcloud secrets versions access latest --secret django_settings
      
    3. Borra el archivo local para evitar las anulaciones de configuración local:

      rm .env
      
  3. Configura el acceso al secreto:

    Console

    1. Haz clic en la pestaña Permisos.
    2. Haga clic en Add.
    3. En el campo Miembros nuevos, ingresa PROJECT_ID@appspot.gserviceaccount.com y, luego, presiona Enter.
    4. En el menú desplegable Función, selecciona Administrador de acceso a secretos.
    5. Haz clic en Guardar.

    gcloud

    1. 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
      

Cómo ejecutar la app en una computadora local

Con los servicios de copia de seguridad configurados, ahora puedes ejecutar la app en tu computadora. Esta configuración permite el desarrollo local, crea un superusuario y aplica migraciones de bases de datos.

  1. En una terminal diferente, inicia el proxy de autenticación de Cloud SQL:

    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
    

    En este paso, se establece una conexión desde tu computadora local a tu instancia de Cloud SQL para realizar pruebas locales. Mantén el proxy de autenticación de Cloud SQL en ejecución durante todo el tiempo que pruebes la app de forma local. Ejecutar este proceso en una terminal separada te permite seguir trabajando mientras se ejecuta. Asegúrate de que los siguientes pasos se completen en una terminal separada

  2. En una terminal nueva, configura el ID del proyecto de forma local :

    Linux/macOS

      export GOOGLE_CLOUD_PROJECT=PROJECT_ID
    

    Windows

      set GOOGLE_CLOUD_PROJECT=PROJECT_ID
    
  3. Configure una variable de entorno para indicar que utiliza 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
    
  4. Ejecuta las migraciones de Django para configurar tus modelos y elementos:

    python manage.py makemigrations
    python manage.py makemigrations polls
    python manage.py migrate
    python manage.py collectstatic
    
  5. Inicia el servidor web de Django:

    python manage.py runserver
    
  6. En tu navegador, ve a http://localhost:8000.

    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.

  7. Presiona Control+C para detener el servidor web local.

Usar la Consola del administrador de Django

Para acceder a la Consola del administrador de Django, debes crear un superusuario. Dado que tienes una conexión a la base de datos con acceso local, puedes ejecutar comandos de administración:

  1. Crea un superusuario. Se le solicitará que ingrese un nombre de usuario, un correo electrónico y una contraseña.

    python manage.py createsuperuser
    
  2. Inicia un servidor web local:

    python manage.py runserver
    
  3. En tu navegador, ve a http://localhost:8000/admin.

  4. 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 copia de seguridad configurados y la aplicación probada localmente, ahora puede implementar la aplicación en el entorno estándar de App Engine:

  1. 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, para que entregue todo el tráfico nuevo:
    gcloud app deploy
  2. Para confirmar la configuración, escriba "yes" cuando se le solicite.
  3. Espera a que aparezca el mensaje que informa que la actualización se completó.

Ejecuta la aplicación implementada

Se implementó la app y ya se puede acceder a ella:

  • Abre el sitio web implementado:

    gcloud app browse
    
  • También puedes mostrar la URL y abrirla 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.

Actualiza la aplicación

Para actualizar tu aplicación, realiza cambios en el código y vuelve a ejecutar el comando gcloud app deploy.

La implementación crea una versión nueva de tu app y la asciende a 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.

Configura para producción

Ahora tienes una implementación de Django en funcionamiento, pero puedes tomar otras medidas para asegurarte de que tu aplicación esté lista para la producción.

Asegúrate de que la depuración esté inhabilitada

Confirma que la variable DEBUG de mysite/settings.py esté configurada como False. Esto evitará que se muestren al usuario páginas de error detalladas, las cuales pueden filtrar información sobre las configuraciones.

Limita los privilegios de usuario de la base de datos

Todos los usuarios que se crean mediante Cloud SQL tienen los privilegios asociados a la función cloudsqlsuperuser: CREATEROLE, CREATEDB y LOGIN.

Para evitar que el usuario de la base de datos de Django tenga estos permisos, crea el usuario manualmente en PostgreSQL. Debes tener instalada la terminal interactiva psql o usar Cloud Shell, que tiene esta herramienta preinstalada.

Console

  1. En Cloud Console, activa Cloud Shell.

    Activar Cloud Shell

  2. En Cloud Shell, usa la terminal integrada para conectarte a la instancia INSTANCE_NAME:

    gcloud sql connect INSTANCE_NAME --user postgres
    
  3. Ingresa la contraseña de usuario de postgres.

    Ahora estás usando psql. Deberías ver el mensaje de postgres=>.

  4. Crear un usuario

    CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
    

    Reemplaza PASSWORD por una contraseña única y aleatoria.

  5. Otorga todos los derechos sobre la base de datos nueva al usuario nuevo:

    GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
    
  6. Salga de psql:

    \q
    

gcloud

  1. 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.

  2. Ingresa la contraseña de usuario de postgres.

    Ahora estás usando psql. Deberías ver el mensaje de postgres=>.

  3. Crear un usuario

    CREATE USER DATABASE_USERNAME WITH PASSWORD 'DATABASE_PASSWORD';
    
  4. Otorga todos los derechos sobre la base de datos nueva al usuario nuevo:

    GRANT ALL PRIVILEGES ON DATABASE DATABASE_NAME TO DATABASE_USERNAME;
    
  5. 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

Se copiaron las vistas base, los modelos y las configuraciones de ruta deEscribe tu primera app de Django (Parte 1 yParte 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 nombrado y extraerlo en el entorno (mediante django-environ):

env = environ.Env(DEBUG=(bool, False))
env_file = os.path.join(BASE_DIR, ".env")

if os.path.isfile(env_file):
    # Use a local secret file, if provided

    env.read_env(env_file)
# ...
elif os.environ.get("GOOGLE_CLOUD_PROJECT", None):
    # Pull secrets from Secret Manager
    project_id = os.environ.get("GOOGLE_CLOUD_PROJECT")

    client = secretmanager.SecretManagerServiceClient()
    settings_name = os.environ.get("SETTINGS_NAME", "django_settings")
    name = f"projects/{project_id}/secrets/{settings_name}/versions/latest"
    payload = client.access_secret_version(name=name).payload.data.decode("UTF-8")

    env.read_env(io.StringIO(payload))
else:
    raise Exception("No local .env or GOOGLE_CLOUD_PROJECT detected. No secrets found.")

El secreto se utiliza para almacenar varios valores de secreto a fin de reducir la cantidad de secretos diferentes que se deben configurar.

Anulaciones de secretos locales

Si se encuentra un archivo .env en el sistema de archivos local, se usa en lugar del valor del administrador de secretos. Crear un archivo .env de forma local puede ayudar con las pruebas locales (p.ej., desarrollo local en una base de datos SQLite o con 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: Si configuras USE_CLOUD_SQL_AUTH_PROXY, la configuración DATABASES se cambia para inferir el uso del proxy de autenticación de Cloud SQL.

# Use django-environ to parse the connection string
DATABASES = {"default": env.db()}

# If the flag as been set, configure to use proxy
if os.getenv("USE_CLOUD_SQL_AUTH_PROXY", None):
    DATABASES["default"]["HOST"] = "127.0.0.1"
    DATABASES["default"]["PORT"] = 5432

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/:

runtime: python39

handlers:
# This configures Google App Engine to serve the files in the app's static
# directory.
- url: /static
  static_dir: static/

# This handler routes all requests not caught above to your main app. It is
# required when static routes are defined, but can be omitted (along with
# the entire handlers section) when there are no static files defined.
- url: /.*
  script: auto

Cuando se ejecuta la app de manera local con DEBUG habilitado, Django entrega estos archivos de forma local:

from django.conf import settings
from django.conf.urls.static import static
from django.contrib import admin
from django.urls import include, path

urlpatterns = [
    path("", include("polls.urls")),
    path("admin/", admin.site.urls),
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)

Realice 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

  1. En Cloud Console, ve a la página Administrar recursos.

    Ir a Administrar recursos

  2. En la lista de proyectos, elige el proyecto que quieres borrar y haz clic en Borrar.
  3. En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

¿Qué sigue?