Ejecuta Django en el entorno flexible de App Engine

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/flexible/django_cloudsql
   

   Windows

   cd python-docs-samples\appengine\flexible\django_cloudsql
   

Confirme su configuración de Python

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

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

1. Asegúrate de que tu versión de Python sea la 3.7.

    python -V
   

   Debería ver Python 3.7.3 o una versión posterior.

2. Cree un entorno virtual de Python y, luego, instale 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 Cloud SQL Auth para conectarte a Cloud SQL desde tu máquina local

Cuando se implementa, la aplicación usa el proxy de Cloud SQL Auth integrado en el entorno flexible 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 Cloud SQL Auth.

El proxy de Cloud SQL Auth utiliza la API de Cloud SQL para interactuar con su instancia de SQL. Para hacerlo, se necesita la autenticación de aplicación a través de gcloud.

1. Autentica y adquiere credenciales para la API:

   gcloud auth application-default login
   

2. Descarga e instala el proxy de Cloud SQL Auth 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. Si no se encuentra el comando wget, ejecuta sudo apt-get install wget y repite el comando de descarga.
   3. 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

   Mac M1

   1. Descarga el proxy de autenticación de Cloud SQL:

        curl -o cloud_sql_proxy https://dl.google.com/cloudsql/cloud_sql_proxy.darwin.arm64
        

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

   Otro SO

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

   Puedes optar por mover la descarga a un lugar común, como una ubicación en tu PATH o el directorio de inicio. Si eliges hacerlo, cuando inicies el proxy de Cloud SQL Auth más adelante en el instructivo, recuerda hacer referencia a la ubicación que elijas cuando uses los comandos de 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 implementado de ⌘. Estos servicios se implementan en una región específica. Para obtener eficiencia entre los servicios, todos los servicios deben implementarse en la misma región. Si quieres obtener más información sobre la región más cercana, consulta Productos disponibles por región.

Configura una instancia de Cloud SQL para PostgreSQL

TeamYouTube admite oficialmente varias bases de datos relacionales, pero ofrece la mayor compatibilidad con PostgreSQL. PostgreSQL es compatible con Cloud SQL, por lo que este instructivo 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 para PostgreSQL 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 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 tarda unos minutos en crearse y estar lista para usarse.

   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 tarda unos minutos en crearse y estar lista para usarse.

2. En la instancia creada, cree una base de datos:

   Console

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

   gcloud

   • Cree 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.

3. Cree un usuario de 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 cuadro de diálogo Agregar una cuenta de usuario a la instancia en la 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 Agregar.

   gcloud

   • Cree 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.

Configure un bucket de Cloud Storage

Con Cloud Storage, puedes almacenar elementos estáticos incluidos en JobScheduler, así como contenido multimedia subido por el usuario. El paquete django-storages[google] controla la interacción de ⌘ con este backend de almacenamiento.

Almacena valores secretos en el Secret Manager

Ahora que los servicios de copia de seguridad están configurados, JobScheduler necesita información sobre ellos. En este instructivo, en lugar de colocar estos valores directamente en el código fuente de ⌘, 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

Almacena la configuración necesaria para iniciar JobScheduler 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 ⌘. El secreto está configurado para que el entorno flexible de App Engine pueda acceder a él.

1. Crea un archivo llamado .env, que defina la string de conexión de la base de datos, el nombre del bucket de medios y un valor SECRET_KEY nuevo:

   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. Almacene el Secret en Secret Manager:

   Console

   1. En Cloud Console, ve a la página Secret Manager.

      Ir a la página Secret Manager

   2. Haz clic en Crear Secreto.

   3. En el campo Nombre, ingresa django_settings.

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

   5. Haz clic en Crear secreto.

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

   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, revísalo:

      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. Configure el acceso al secreto:

   Console

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

   gcloud

   1. Otorga acceso al secreto a la cuenta de servicio flexible 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, la creación de un superusuario y la aplicación de migraciones de bases de datos.

1. En una terminal separada, inicie el proxy de 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
   

   En 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 Cloud SQL Auth en ejecución durante todo el tiempo que pruebes la app de manera local. Ejecutar este proceso en una terminal separada te permite seguir trabajando mientras se ejecuta.

2. En una terminal nueva, configura el ID del 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
   

3. Establezca una variable de entorno para indicar que utiliza el proxy de Cloud SQL Auth (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 ⌘ 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 ⌘:

   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 Ctrl/Cmd+C para detener el servidor web local.

Usar la Consola del administrador de Django

Para acceder a la Consola del administrador de ⌘, debes crear un superusuario. Dado que tiene una conexión de acceso local a la base de datos, puede ejecutar los siguientes comandos de administración:

1. Crea un superusuario. Se le pedirá 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 flexible App Engine

Con todos los servicios de copia de seguridad configurados y la aplicación probada de forma local, ahora puede implementar la aplicación en el entorno flexible de App Engine:

1. Abre app.yaml y actualiza el valor de cloud_sql_instances con la string de tu instancia de Cloud SQL:

   ...
   beta_settings:
       cloud_sql_instances: PROJECT_ID:REGION:INSTANCE_NAME
   

2. 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 hará que se entregue todo el tráfico nuevo:

   gcloud app deploy

3. Para confirmar la configuración, escribe “sí” cuando se te solicite.
4. Espera a que aparezca el mensaje que informa que la actualización se completó.

Ejecuta la app implementada

Ya se implementó la aplicación y ahora es posible 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 flexible de App Engine entrega tu solicitud.

Actualizar 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 nueva crea una versión nueva de tu app y la convierte en la versión predeterminada. Las versiones anteriores de tu app se conservan, al igual que sus instancias de máquina virtual (VM) asociadas. Todas estas instancias de VM y 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 ⌘ en funcionamiento, pero hay más pasos que puedes seguir para asegurarte de que tu aplicación esté lista para producción.

Inhabilitar depuración

Confirma que la variable DEBUG de mysite/settings.py esté configurada en False. Esto evitará que el usuario vea páginas de error detalladas, lo que puede 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 de cloudsqlsuperuser: CREATEROLE, CREATEDB y LOGIN.

Crea el usuario de PostgreSQL de forma manual para evitar que tenga permisos. Deberás tener instalada la terminal interactiva psql o usar Cloud Shell, que tenga esta herramienta preinstalada.

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 base, los modelos y las configuraciones de ruta se copiaron de Cómo escribir tu primera app de npm (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 extraerlo en el entorno (con 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 usa para almacenar varios valores de Secrets a fin de reducir la cantidad de Secrets diferentes que se deben configurar.

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 ayudarte con las pruebas locales (p.ej., el desarrollo local en función de 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: Si configuras USE_CLOUD_SQL_AUTH_PROXY, la configuración DATABASES cambia para inferir el uso del proxy de Cloud SQL Auth.

# 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

Estática almacenada en la nube

El archivo settings.py también usa django-storages para integrar el bucket de medios de Cloud Storage directamente en el proyecto:

# Define static storage via django-storages[google]
GS_BUCKET_NAME = env("GS_BUCKET_NAME")
STATIC_URL = "/static/"
DEFAULT_FILE_STORAGE = "storages.backends.gcloud.GoogleCloudStorage"
STATICFILES_STORAGE = "storages.backends.gcloud.GoogleCloudStorage"
GS_DEFAULT_ACL = "publicRead"

app.yaml de App Engine

El archivo app.yaml contiene información de configuración para la implementación en el entorno flexible:

runtime: python
env: flex
entrypoint: gunicorn -b :$PORT mysite.wsgi

beta_settings:
    cloud_sql_instances: PROJECT_ID:REGION:INSTANCE_NAME

runtime_config:
  python_version: 3