在AWS App Runner上部署Django应用时，开发者常会遇到数据库迁移（migrations）执行失败的问题。这通常发生在代码部署后，应用尝试启动服务之前。传统的做法可能是在apprunner.yaml的post-build阶段执行迁移，或者直接在startup.sh中简单地运行python manage.py migrate，但这些方法在实际操作中可能因环境配置、依赖加载时机或执行顺序问题而导致部署失败并回滚。本教程将提供一套优化方案，确保Django应用在App Runner上的顺利部署，包括静态文件收集、数据库迁移和应用启动。
核心问题分析与解决方案
Django应用在App Runner上部署时，需要完成以下几个关键步骤：
- 安装依赖：安装requirements.txt中列出的所有Python包。
- 收集静态文件：运行python manage.py collectstatic将所有静态文件收集到指定目录，供Web服务器（如Gunicorn）服务。
- 数据库迁移：运行python manage.py migrate应用数据库模型变更。
- 启动应用：使用Gunicorn等WSGI服务器启动Django应用。
当这些步骤的顺序或环境配置不正确时，部署就会失败。尤其是在App Runner的构建和运行生命周期中，如何精确控制这些操作至关重要。
优化 startup.sh 脚本
解决问题的关键在于创建一个健壮的startup.sh脚本，将上述所有操作串联起来，并确保它们在正确的Python环境下执行。使用&&操作符可以保证前一个命令成功执行后，后一个命令才会继续，从而避免因某个步骤失败而导致整个部署流程中断。
以下是一个推荐的startup.sh脚本示例：
#!/bin/bash # 确保使用正确的Python版本执行命令 python3.11 manage.py collectstatic --noinput && \ python3.11 manage.py migrate --noinput && \ gunicorn config.wsgi:application -b 0.0.0.0:8000
脚本说明：
- #!/bin/bash：指定使用Bash shell执行脚本。
- python3.11：明确指定Python版本。在App Runner环境中，可能存在多个Python版本，使用python3.11可以避免混淆，确保命令在正确的虚拟环境中执行。
- manage.py collectstatic --noinput：收集Django应用的静态文件。--noinput参数用于在非交互模式下执行，避免在部署过程中等待用户确认。
- manage.py migrate --noinput：执行数据库迁移。同样，--noinput参数确保非交互式执行。
- gunicorn config.wsgi:application -b 0.0.0.0:8000：使用Gunicorn启动Django应用。-b 0.0.0.0:8000指定Gunicorn监听所有网络接口的8000端口，App Runner会代理外部请求到此端口。
优化 apprunner.yaml 配置
apprunner.yaml文件是App Runner服务配置的核心。它定义了构建、运行环境、依赖安装、环境变量和秘密信息等。以下是一个针对Django应用的优化配置示例：
version: 1.0
runtime: python311 # 指定App Runner使用的Python运行时版本
build:
commands:
build:
- pip3 install --upgrade pip # 升级pip
- pip3 install -r requirements.txt # 安装项目依赖
run:
runtime-version: 3.11 # 确保运行时也使用Python 3.11
pre-run:
# 这一部分可以用于确保一些关键工具或依赖在应用启动前就位
# 虽然build阶段已安装大部分依赖，但pre-run可用于特殊情况或验证
- pip3 install --upgrade pip
- pip3 install gunicorn # 确保Gunicorn已安装
- pip3 install -r requirements.txt # 再次安装依赖，确保所有依赖在运行环境中可用
- which gunicorn # 验证gunicorn是否在PATH中
command: sh startup.sh # 执行自定义的启动脚本
network:
port: 8000 # Django应用监听的端口
env: # 定义环境变量
- name: RUN_SELECTOR
value: dev # 示例：用于区分不同环境的配置
- name: DJANGO_SETTINGS_MODULE
value: config.settings.production # 指定Django的设置模块
- name: DJANGO_READ_DOT_ENV_FILE
value: False # 控制Django是否读取.env文件
secrets: # 从AWS Secrets Manager加载秘密信息
- name: APP_KEY
value-from: "arn:aws:secretsmanager:REGION:ACCOUNT_ID:secret:your_secret_name:key_in_secret::" # 替换为实际的ARN
- name: CELERY_BROKER_URL
value-from: "arn:aws:secretsmanager:REGION:ACCOUNT_ID:secret:your_secret_name:key_in_secret::"
- name: CSRF_COOKIE_SECURE
value-from: "arn:aws:secretsmanager:REGION:ACCOUNT_ID:secret:your_secret_name:key_in_secret::"配置说明：
- runtime: python311：在构建阶段指定Python 3.11作为运行时。
-
build.commands.build：定义构建命令。这里主要用于安装项目所需的Python依赖。
- pip3 install --upgrade pip：确保pip是最新版本。
- pip3 install -r requirements.txt：安装所有生产环境依赖。
- run.runtime-version: 3.11：明确指定应用运行时的Python版本，与构建阶段保持一致。
- run.pre-run：在主命令执行前运行的命令。这里再次安装gunicorn和requirements.txt是为了确保在运行环境中，所有必要的工具和依赖都已准备就绪。which gunicorn可用于调试，确认gunicorn的路径。
- run.command: sh startup.sh：指定App Runner服务启动时执行的命令，即我们之前创建的startup.sh脚本。
- run.network.port: 8000：指定Django应用监听的端口，App Runner会将外部流量路由到此端口。
- run.env：定义环境变量。这些变量会在App Runner服务运行时注入到环境中。例如，DJANGO_SETTINGS_MODULE用于指定Django使用的设置文件。
- run.secrets：从AWS Secrets Manager加载敏感信息。value-from字段需要提供Secrets Manager中秘密的完整ARN，并可选地指定秘密中的键。这是一种安全管理敏感数据的最佳实践。
注意事项与最佳实践
- 明确指定Python版本：在startup.sh和apprunner.yaml中都明确使用python3.11（或您使用的具体版本），避免因默认Python版本不符而导致的错误。
- 非交互式命令：在部署脚本中，对于collectstatic和migrate等命令，务必使用--noinput参数，防止部署过程因等待用户输入而挂起。
- 错误处理：&&操作符确保了命令的顺序执行和错误传递。如果任何一个命令失败，后续命令将不会执行，并且App Runner会标记部署失败，这有助于快速定位问题。
- 环境隔离与配置：虽然可以在apprunner.yaml中定义环境变量，但对于不同环境（开发、测试、生产）的特定配置（如数据库连接字符串），可能需要通过修改RUN_SELECTOR等变量，或利用Django的设置文件逻辑来动态加载。
- Secrets Manager集成：将敏感信息（如数据库密码、API密钥）存储在AWS Secrets Manager中，并通过apprunner.yaml的secrets字段加载，是安全管理凭证的最佳实践。
- 日志审查：部署失败时，务必仔细查看App Runner的服务日志。日志会提供详细的错误信息，帮助您诊断问题。
- requirements.txt管理：保持requirements.txt文件的整洁和准确，只包含生产环境所需的依赖。
总结
通过精心构造startup.sh脚本，将collectstatic、migrate和Gunicorn启动命令串联起来，并结合优化后的apprunner.yaml配置，我们可以确保Django应用在AWS App Runner上的稳定、高效部署。这种方法不仅解决了数据库迁移失败的常见问题，还通过环境变量和Secrets Manager的集成，提升了应用配置的灵活性和安全性。遵循这些最佳实践，将有助于您在云原生环境中更顺畅地管理和运行Django应用。
