platformos/postgres-aws-backup

PostgreSQL备份至S3镜像文档

镜像概述

本Docker镜像集成了pg_dump工具和AWS CLI，旨在提供便捷的PostgreSQL数据库备份解决方案，支持将备份文件直接上传至Amazon S3存储服务，适用于需要自动化数据库备份与云端存储的场景。

核心功能与特性

• 内置pg_dump工具：支持PostgreSQL数据库完整备份、自定义表备份及压缩备份（如gzip格式）
• 集成AWS CLI：提供与Amazon S3的直接交互能力，支持备份文件上传、存储桶管理及访问控制
• 轻量级设计：基于精简基础镜像，最小化镜像体积，降低资源占用
• 灵活配置：支持通过环境变量自定义数据库连接参数、备份策略及S3存储路径

使用场景

• 生产环境PostgreSQL数据库定时自动备份
• 开发/测试环境数据库版本化备份与追溯
• 跨地域数据库备份容灾方案
• 需要将数据库备份文件长期存储在云端的业务场景

使用方法

环境变量配置

Docker Run示例

bash
docker run -d \
  -e DB_HOST=postgres.example.com \
  -e DB_PORT=5432 \
  -e DB_NAME=myappdb \
  -e DB_USER=backupuser \
  -e DB_PASSWORD=securepassword \
  -e AWS_ACCESS_KEY_ID=AKIAEXAMPLE \
  -e AWS_SECRET_ACCESS_KEY=secretkeyexample \
  -e AWS_REGION=us-west-2 \
  -e S3_BUCKET=my-backup-bucket \
  -e S3_KEY=prod_backups/{DB_NAME}_{TIMESTAMP}.sql.gz \
  --name pg-s3-backup \
  [镜像名称]

Docker Compose配置示例

yaml
version: '3'
services:
  pg-backup:
    image: [镜像名称]
    environment:
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=myappdb
      - DB_USER=backupuser
      - DB_PASSWORD=securepassword
      - AWS_ACCESS_KEY_ID=AKIAEXAMPLE
      - AWS_SECRET_ACCESS_KEY=secretkeyexample
      - AWS_REGION=us-west-2
      - S3_BUCKET=my-backup-bucket
      - S3_KEY=prod_backups/{DB_NAME}_{TIMESTAMP}.sql.gz
      - PG_DUMP_OPTIONS=-F c -Z 9  # 自定义格式+最高压缩级别
    depends_on:
      - postgres
    restart: unless-stopped

备份流程说明

1. 容器启动后，通过环境变量获取数据库连接信息及AWS配置
2. 执行pg_dump命令生成数据库备份文件（默认使用gzip压缩）
3. 通过AWS CLI将备份文件上传至指定S3存储桶及路径
4. 备份完成后输出日志（包含S3文件URL），可结合外部工具（如cron）实现定时备份

注意事项

• 确保数据库用户具备pg_dump所需权限（如SELECT、USAGE权限）
• AWS密钥需配置足够权限（至少包含s3:PutObject操作权限）
• 敏感信息（如密码、密钥）建议通过Docker Secrets或外部密钥管理服务注入
• 大数据库备份建议配置适当的超时时间及资源限制