martlark/pg_dump

martlark/pg_dump

运行pg_dump作为定时任务的Docker镜像。镜像地址：https://hub.docker.com/repository/docker/martlark/pg_dump

镜像概述

martlark/pg_dump是一个专为PostgreSQL数据库设计的备份工具镜像，通过cron任务定时执行pg_dump命令生成数据库备份，并支持自动清理旧备份文件。此外，该镜像还集成了s3cmd工具，可将备份文件同步至AWS S3或其他S3兼容存储服务，适用于需要定期备份PostgreSQL数据并确保数据安全的场景。

核心功能与特性

• 定时备份：通过cron任务按自定义时间计划执行pg_dump
• 自动清理：可配置保留指定数量的备份文件，自动删除旧备份
• S3同步：支持将备份文件同步至AWS S3或其他S3兼容存储服务
• 灵活配置：通过环境变量自定义数据库连接参数、备份路径、文件名前缀等
• 安全选项：支持通过密码文件（Docker Secrets）管理数据库密码，提高安全性

使用场景

• 生产环境PostgreSQL数据库的定期自动备份
• 需要保留指定数量备份文件的场景
• 需将备份文件异地存储（如S3）以提高数据安全性的场景
• 容器化部署环境中与PostgreSQL服务配合使用的备份方案

环境变量配置

使用方法

基本使用

1. 将PostgreSQL数据库连接信息通过环境变量传入容器
2. 挂载本地目录至容器的/dump文件夹，备份文件将存储于此
3. 配置CRON_SCHEDULE指定备份时间计划

Docker Run示例

bash
docker run -d \
  --name postgres-backup \
  -e POSTGRES_PASSWORD=SumPassw0rdHere \
  -e POSTGRES_DB=postgres \
  -e PGHOST=database \
  -e CRON_SCHEDULE="0 3 * * *" \
  -e RETAIN_COUNT=4 \
  -v ./persistent/dump:/dump \
  --link database:db \
  martlark/pg_dump:15.4

Docker Compose配置

推荐与PostgreSQL服务一起部署，作为独立服务运行。

基础配置示例

yaml
version: "3.9"
services:
  database:
    image: postgres:12.16
    volumes:
      - ./persistent/data:/var/lib/postgresql/data
    environment:
      - POSTGRES_PASSWORD=SumPassw0rdHere
      - POSTGRES_DB=postgres
    restart: unless-stopped

  postgres-backup:
    image: martlark/pg_dump:12.16
    container_name: postgres-backup
    links:
      - database:db  # 将数据库服务映射为"db"
    environment:
      - PGPASSWORD=SumPassw0rdHere
      - CRON_SCHEDULE=0 3 * * *  # 每天凌晨3点执行备份
      - RETAIN_COUNT=4  # 保留4个备份文件
    volumes:
      - ./persistent/dump:/dump
    restart: unless-stopped

带S3同步的配置示例

yaml
version: "3.9"
services:
  backup:
    image: martlark/pg_dump:15.4
    environment:
      - POSTGRES_PASSWORD=SumPassw0rdHere
      - POSTGRES_DB=postgres
      - PGHOST=database  # PostgreSQL数据库主机名
      - CRON_SCHEDULE=*/15 * * * *  # 每15分钟执行一次备份
      - RETAIN_COUNT=3  # 保留3个备份文件
      - S3_BUCKET_PATH=s3://${S3_BUCKET_NAME}/
      - S3_SECRET_KEY=${S3_SECRET_KEY}
      - S3_ACCESS_KEY=${S3_ACCESS_KEY}
    volumes:
      - ./persistent/dump:/dump
    restart: unless-stopped

S3同步配置

基本同步

默认情况下，容器会将/dump目录中的备份文件同步至S3存储桶，并使用以下选项：

• --delete-removed：删除存储桶中不存在于本地的文件
• --delete-after：先上传新文件，再删除旧文件

如需保留存储桶中的所有备份文件（不删除），可设置：

yaml
environment:
  - S3_SYNC_OPTION="--no-delete-removed"

非AWS S3服务配置

对于非AWS的S3兼容服务，需配置S3_HOSTNAME和S3_HOST_BUCKET：

yaml
environment:
  - S3_HOSTNAME=mys3server.local
  - S3_HOST_BUCKET=mys3server.local/%(bucket)

安全注意事项

• 密码管理：推荐使用POSTGRES_PASSWORD_FILE通过Docker Secrets管理密码，而非直接设置环境变量。示例密码文件内容：

  text
  POSTGRES_PASSWORD=SumPassw0rdHere
  

• 用户权限：容器默认以postgres用户运行，建议保持非root用户以提高安全性。
• 端口配置：PGPORT为容器内暴露的端口，建议不要修改默认值5432。

可用标签版本

镜像通常会提供PostgreSQL最新主要和次要版本的标签，历史版本也会被维护。Docker Hub上可用的版本标签：

11.19 11.21 12.12 12.16 13.12 14.7 14.9 15.2 15.4

latest标签对应版本为15.4。