justb4/pgbackup

Docker PG Backup

镜像概述和主要用途

Docker PG Backup是一个Docker容器，用于为其网络中所有带有标签"pgbackup.enable=true"的PostgreSQL/PostGIS容器执行自动定时备份。它支持多种PostgreSQL/PostGIS镜像，默认每日23:00创建备份，文件按容器名/年/月的目录结构组织，可自定义备份计划。适用于需要自动备份多个PostgreSQL/PostGIS容器的Docker环境，如开发、测试和生产环境。

核心功能和特性

• 自动发现容器：通过Docker API识别网络中带有"pgbackup.enable=true"标签的PostgreSQL容器
• 多镜像支持：兼容mdillon/postgis、Kartoza docker postgis及标准PostgreSQL官方镜像
• 灵活调度：通过环境变量自定义备份计划，默认每日23:00执行
• 有序存储：备份文件按容器名/年/月/<容器名>-ymd-hm.sql.gz路径组织
• 轻量级基础：基于postgres:<version>-alpine镜像，体积更小
• 完整工具链：包含备份（单容器/全容器）、列出备份、恢复功能

环境变量

使用方法和配置说明

获取镜像

拉取官方镜像（推荐）

bash
docker pull justb4/pgbackup:11

建议使用带标签的镜像，避免latest标签可能带来的兼容性问题，应使用与目标数据库相同或更高版本的镜像。

本地构建

bash
# 克隆仓库
git clone git://github.com/justb4/docker-pgbackup
cd docker-pgbackup
# 构建镜像
docker build -t justb4/pgbackup .

运行备份容器

基础运行命令

bash
docker run --name="pgbackup" \
           -v /path/to/backup:/backup \
           -v /var/run/docker.sock:/var/run/docker.sock \
           -d justb4/pgbackup:11

• -v /path/to/backup:/backup：挂载本地目录用于存储备份文件
• -v /var/run/docker.sock:/var/run/docker.sock：挂载Docker socket以访问Docker API

Docker Compose配置示例

yaml
# docker-compose.yml
version: "3"

services:
  db:
    image: mdillon/postgis:11-alpine
    container_name: pg_db_11
    labels:
      - "pgbackup.enable=true"  # 启用备份标记
    environment:
      - POSTGRES_DB=testdb
      - POSTGRES_USER=testuser
      - POSTGRES_PASSWORD=testpass

  dbbackup:
    image: justb4/pgbackup:11
    container_name: pg_backup_11
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./backup:/backup  # 本地备份目录
    environment:
      - PGB_SCHEDULE=*/1 * * * *  # 每分钟备份一次（测试用）

启动服务：

bash
docker-compose up -d

显式备份操作

备份所有数据库容器

bash
docker exec -it pgbackup /pgbackup/backup-all.sh

备份单个数据库容器

bash
docker exec -it pgbackup /pgbackup/backup.sh <目标容器名> <备份文件路径>

# 示例
docker exec -it pgbackup /pgbackup/backup.sh pg_db_11 /backup/my_custom_backup.sql.gz

列出备份

bash
docker exec -it pgbackup /pgbackup/list-backups.sh

恢复备份

1. 确保备份文件已在pgbackup容器的/backup目录下（通过挂载卷共享）
2. 执行恢复命令：

bash
# 直接执行恢复
docker exec -it pgbackup /pgbackup/restore.sh <目标数据库容器名> <备份文件路径>

# 示例
docker exec -it pgbackup /pgbackup/restore.sh pg_db_11 /backup/2023/10/pg_db_11-231015-0930.sql.gz

设计与kartoza/pg-backup的差异

• 容器发现机制：通过Docker API和标签（pgbackup.enable=true）识别目标容器，无需预先配置所有数据库凭据
• 松耦合架构：单个pgbackup容器可备份多个PostgreSQL容器
• 基础镜像优化：使用更小的postgres:<version>-alpine替代kartoza/postgis
• 备份格式：默认生成SQL gzip格式备份，提高跨版本兼容性
• 功能扩展：内置恢复命令，支持直接从备份文件恢复到指定容器

credits

• Tim Sutton (***)：原项目（https://github.com/kartoza/docker-pg-backup%EF%BC%89%E4%BD%9C%E8%80%85
• Just van den Broecke ([***]