kartoza/pg-backup

Docker PG Backup

镜像概述和主要用途

Docker PG Backup是一个轻量级Docker容器，专门用于执行PostgreSQL和PostGIS数据库的备份任务。它设计用于与https://github.com/kartoza/docker-postgis%E9%95%9C%E5%83%8F%E9%85%8D%E5%90%88%E4%BD%BF%E7%94%A8%EF%BC%8C%E9%BB%98%E8%AE%A4%E9%85%8D%E7%BD%AE%E4%B8%BA%E6%AF%8F%E6%99%9A23%E7%82%B9%E8%87%AA%E5%8A%A8%E6%89%A7%E8%A1%8C%E5%A4%87%E4%BB%BD%EF%BC%8C%E5%B9%B6%E5%B0%86%E5%A4%87%E4%BB%BD%E6%96%87%E4%BB%B6%E6%8C%89%E5%B9%B4/%E6%9C%88%E5%B1%82%E7%BA%A7%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84%E7%BB%84%E7%BB%87%E5%AD%98%E5%82%A8%EF%BC%8C%E4%BE%BF%E4%BA%8E%E7%AE%A1%E7%90%86%E5%92%8C%E8%BF%BD%E6%BA%AF%E3%80%82

核心功能和特性

• 灵活备份：支持备份任何PostgreSQL数据库，无需依赖PostGIS
• 定时任务：默认每日23点自动执行备份，支持自定义配置
• 版本匹配：提供特定版本标签，确保与目标PostgreSQL数据库版本兼容
• 备份管理：支持按天数自动清理旧备份文件
• 存储选项：默认本地存储，可选配置S3兼容对象存储备份
• 自定义命名：支持自定义备份文件名格式
• 多库备份：可指定多个数据库进行批量备份
• 恢复功能：提供配套恢复脚本，支持数据库恢复操作

使用场景和适用范围

• 需要定期备份PostgreSQL/PostGIS数据库的环境
• 使用kartoza/postgis镜像部署数据库的场景
• 需按时间维度组织备份文件的需求
• 需要将备份文件存储到S3或兼容对象存储的场景
• 希望通过Docker容器化方式管理备份任务的环境

详细使用方法和配置说明

获取镜像

推荐方式：拉取官方可信构建镜像

bash
docker pull kartoza/pg-backup:latest
docker pull kartoza/pg-backup:${VERSION}  # 例如 VERSION=13.0

重要：强烈建议使用与目标PostgreSQL镜像版本匹配的标签（如使用13.0版本备份kartoza/postgis:13.0数据库）。latest标签可能会变更，可能导致备份失败。

手动构建镜像

若需自行构建（会消耗更多带宽，需每次拉取依赖包）：

bash
git clone https://github.com/kartoza/docker-pg-backup.git
cd docker-pg-backup
./build.sh  # 构建最新版本

运行容器

基本运行命令

bash
docker run --name="backups" --hostname="pg-backups" --link db1:db -v backups:/backups -i -d kartoza/pg-backup:13.0

参数说明：

• --link db1:db：连接到名为db1的数据库容器（别名db）
• -v backups:/backups：挂载本地卷backups到容器内/backups目录，用于存储备份文件
• --name="backups"：指定容器名称
• --hostname="pg-backups"：设置容器主机名

环境变量配置

通过环境变量可自定义数据库连接参数、备份策略等，常用变量如下：

环境变量使用示例

bash
docker run -e POSTGRES_USER=bob -e POSTGRES_PASS=secret -e REMOVE_BEFORE=7 --link db:db -v backups:/backups -d kartoza/pg-backup:13.0

备份文件命名格式

默认命名格式

未指定ARCHIVE_FILENAME时，备份文件路径格式为：

/backups/$(date +%Y)/$(date +%B)/${DUMPPREFIX}_${DB}.$(date +%d-%B-%Y).dmp

示例（DUMPPREFIX=PG，数据库名gis）：

/backups/2019/February/PG_gis.13-February-2019.dmp

自定义命名格式

指定ARCHIVE_FILENAME时，将使用固定前缀命名，示例（ARCHIVE_FILENAME=/backups/latest）：

/backups/latest.gis.dmp

配置S3存储备份

支持将备份文件存储到S3兼容对象存储，需配置以下环境变量：

完整配置示例可参考项目仓库中的docker-compose-s3.yml文件

数据库恢复

恢复准备

使用配套的restore.sh脚本执行恢复操作，需预先设置以下环境变量：

警告：恢复脚本会删除与TARGET_DB同名的现有数据库，请谨慎操作。建议恢复到新数据库（如gis_restore），验证后再手动替换原数据库。

恢复命令示例

通过docker-compose执行恢复：

bash
docker-compose exec dbbackup /backup-scripts/restore.sh

部署示例

docker-compose配置示例

yaml
version: '3'

services:
  dbbackup:
    image: kartoza/pg-backup:13.0
    container_name: backups
    hostname: pg-backups
    links:
      - db:db
    volumes:
      - backups:/backups
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASS=securepassword
      - POSTGRES_DBNAME=gis
      - REMOVE_BEFORE=30
      - DUMPPREFIX=prod_backup
    restart: unless-stopped

  db:
    image: kartoza/postgis:13.0
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASS=securepassword
      - POSTGRES_DB=gis
    volumes:
      - pgdata:/var/lib/postgresql/data

volumes:
  backups:
  pgdata:

credits

Tim Sutton ()
Admire Nyakudya ()
Rizky Maulana (***)

December 2020