hmsdbmitc/dbmisvc

DBMI Service Container 镜像文档

镜像概述和主要用途

DBMI Service Container是一个用于引导DBMI技术核心服务的Docker镜像。它通过环境变量、AWS Parameter Store或AWS Secrets Manager（开发中）进行配置，集成Nginx和Gunicorn作为Web服务器和应用服务器，支持SSL配置、健康检查、静态文件服务及S3文件代理等功能，适用于部署需要与AWS服务集成的Web应用。

核心功能和特性

• 灵活配置：支持通过Docker环境变量或AWS Parameter Store/Secrets Manager加载配置
• Web服务集成：内置Nginx和Gunicorn，提供完整的Web服务栈
• 安全支持：可配置SSL，支持自签名证书或手动提供证书
• 健康检查：内置健康检查端点配置，适配ECS/ELB环境
• 静态文件服务：支持Nginx直接提供静态文件服务
• S3文件代理：提供从S3无缝代理文件下载的功能

使用场景和适用范围

• DBMI技术核心服务的标准化部署
• 需要与AWS服务（如Parameter Store、S3、ALB）集成的Web应用
• 开发、测试和生产环境的统一部署流程
• 需要健康检查、SSL加密和静态文件服务的Django等WSGI应用

详细配置说明

必需应用变量

Nginx和Gunicorn配置

密钥配置

说明：密钥默认从AWS Parameter Store加载。初始化时，脚本会获取指定路径/前缀下的所有密钥并添加到环境变量中，供Django等应用从环境变量读取。DBMI_PARAMETER_STORE_PRIORITY设为true时，Parameter Store的值会覆盖本地定义的变量；设为false时，可在运行时覆盖配置，适用于开发/测试环境。

SSL配置

说明：自签名证书通常用于ELB后端，实现内部流量加密。若手动提供证书，需将证书和密钥文件放置在DBMI_SSL_PATH，并命名为{DBMI_APP_DOMAIN}.crt和{DBMI_APP_DOMAIN}.key。

健康检查配置

说明：在ECS/ELB环境中，应用需响应Docker守护进程和ELB的健康检查。Nginx会自动配置允许localhost、ECS实例内部IP及应用实际主机的请求，并将健康检查请求与应用请求分开处理，避免日志污染。

应用负载均衡器(ALB)配置

说明：当前配置仅支持AWS Application Load ***，包括健康检查端点配置和确保使用原始请求头进行日志记录。

静态文件配置

说明：启用静态文件服务时，Nginx会直接提供DBMI_APP_STATIC_ROOT目录下的文件，通过DBMI_APP_STATIC_URL_PATH路径访问。

文件代理配置

说明：文件代理功能允许应用通过Nginx无缝代理S3存储的文件下载，无需在容器中存储文件。应用需设置X-Accel响应头为：

https://{DBMI_APP_DOMAIN}/{DBMI_FILE_PROXY_PATH}/{S3 bucket name}/{S3 signed URL's path and query}

示例：

1. 用户请求https://app.domain.com/download/my_file.txt
2. 应用验证权限后生成S3签名URL：
   https://my-bucket.s3.amazonaws.com/34bde615-2861-4f70-816a-6c5f7304a824/my_file.txt?Signature=A8DIf5FUUZsv1sxACTi0Q%2B7H4VI%3D&Expires=1545316868&AWSAccessKeyId=AKIFAPCDZOQ77R9EL9DO
3. 应用设置X-Accel头为：
   /proxy/https/my-bucket.s3.amazonaws.com/34bde615-2861-4f70-816a-6c5f7304a824/my_file.txt?Signature=A8DIf5FUUZsv1sxACTi0Q%2B7H4VI%3D&Expires=1545316868&AWSAccessKeyId=AKIFAPCDZOQ77R9EL9DO
4. Nginx解析该URL并代理请求到S3，将响应返回给用户。

部署示例

Docker Run命令

bash
docker run -d \
  -p 80:80 \
  -e DBMI_APP_WSGI=my_project \
  -e DBMI_APP_DOMAIN=app.example.com \
  -e DBMI_STATIC_FILES=true \
  -e DBMI_APP_STATIC_ROOT=/app/static \
  -e DBMI_PARAMETER_STORE_PATH=/com/example/app/prod \
  --name dbmi-service \
  docker.xuanyuan.run/dbmi/service-container

Docker Compose配置

yaml
version: '3'
services:
  dbmi-service:
    image: dbmi/service-container
    ports:
      - "80:80"
    environment:
      - DBMI_APP_WSGI=my_project
      - DBMI_APP_DOMAIN=app.example.com
      - DBMI_SSL=true
      - DBMI_CREATE_SSL=true
      - DBMI_STATIC_FILES=true
      - DBMI_APP_STATIC_ROOT=/app/static
      - DBMI_APP_STATIC_URL_PATH=/static
      - DBMI_PARAMETER_STORE_PATH=/com/example/app/dev
      - DBMI_PARAMETER_STORE_PRIORITY=false
      - DBMI_HEALTHCHECK=true
      - DBMI_APP_HEALTHCHECK_PATH=/health
    volumes:
      - ./static:/app/static