interaction/restic-pg-dump

restic-pg-dump

镜像概述和主要用途

restic-pg-dump是一个Docker镜像，用于为指定PostgreSQL服务器上的每个数据库单独运行pg_dump，并通过restic工具执行增量加密备份。该镜像默认配置了完整的备份策略，适用于需要定期、安全备份PostgreSQL数据库的场景。

核心功能和特性

• 默认备份配置：使用S3作为restic仓库后端；每小时通过定时任务执行备份；自动保留24个最新快照、7个每日快照、4个每周快照和12个每月快照；每周清理旧快照。
• 灵活配置：支持通过环境变量自定义备份计划、清理计划、快照保留数量等参数。
• 多集群支持：可同时备份最多5个不同的PostgreSQL数据库集群，通过特定环境变量配置。
• 安全加密：使用restic对备份数据进行加密，确保数据安全性。

使用场景和适用范围

适用于需要定期备份PostgreSQL数据库并确保数据可恢复性的场景，尤其适合生产环境中对数据库备份有严格时间策略和安全要求的用户。支持单数据库集群或多数据库集群的备份需求。

使用方法和配置说明

基本使用

通过docker run命令启动容器，需提供必要的环境变量配置AWS、PostgreSQL和restic的凭证信息：

bash
$ docker run \
    -d \
    -e AWS_ACCESS_KEY_ID='...' \
    -e AWS_SECRET_ACCESS_KEY='...' \
    -e PGHOST='...' \
    -e PGPASSWORD='...' \
    -e PGUSER='...' \
    -e RESTIC_PASSWORD='...' \
    -e RESTIC_REPOSITORY='s3:s3.amazonaws.com/...' \
    --name restic-pg-dump \
    --restart always \
    interaction/restic-pg-dump

环境变量配置

除上述必填环境变量外，可通过以下变量覆盖默认配置：

多数据库集群备份

支持同时备份最多5个不同的PostgreSQL数据库集群，通过以下环境变量配置（[1..5]表示集群编号，如1-5）：

bash
-e HOSTNAME_2='...'       # 集群2的主机名（若PGHOST不是完全限定域名）
-e PGHOST_2='...'         # 集群2的PostgreSQL主机
-e PGPASSWORD_2='...'     # 集群2的PostgreSQL密码
-e PGPORT_2='5432'        # 集群2的PostgreSQL端口
-e PGUSER_2='...'         # 集群2的PostgreSQL用户名

注：项目提供了docker-compose.yml文件，便于快速部署。

恢复操作（macOS）

准备工作

1. 从示例文件创建.envrc，并更新AWS、PostgreSQL和restic凭证：

   bash
   $ wget https://raw.githubusercontent.com/ixc/restic-pg-dump/master/.envrc.example -O .envrc
   

2. 限制.envrc文件访问权限（包含敏感凭证）：

   bash
   $ chmod 600 .envrc
   

3. 安装direnv（通过Homebrew）并配置自动加载.envrc：

   bash
   $ brew install direnv
   $ eval "$(direnv hook bash)"  # 根据shell类型（zsh/fish/tcsh等）调整，并添加到shell配置文件
   $ direnv allow
   

4. 安装restic（通过Homebrew）：

   bash
   $ brew install restic
   

执行恢复

• 列出快照：

  bash
  $ restic snapshots
  

• 恢复指定服务器的最新快照：

  bash
  $ restic restore --host {HOSTNAME} --target "restore/{HOSTNAME}" latest
  

• 从指定服务器的最新快照中恢复匹配模式的文件：

  bash
  $ restic restore --host "{HOSTNAME}" --target "restore/{HOSTNAME}" --include '*-production.sql' latest
  

• 通过fuse挂载仓库（只读）：

  bash
  $ restic mount mnt
  

  挂载后，可在另一个终端访问最新快照：

  bash
  $ ls -l "mnt/hosts/{HOSTNAME}/latest"
  $ psql -f "mnt/hosts/{HOSTNAME}/latest/pg_dump/{DBNAME}.sql" {DBNAME}
  

警告：通过fuse挂载restic仓库会获取独占锁，在释放锁前会阻止所有定时备份。