backuptools/postgres-backup-s3

Postgres S3 备份 Docker/Kubernetes 镜像

镜像概述和主要用途

本Docker镜像用于将Postgres数据库备份至S3存储，通过pg_dump工具导出数据库，并支持多种压缩算法（默认pigz）进行数据压缩。支持自定义S3端点（如MinIO）、PGP加密，可直接在Docker或Kubernetes环境中运行，适用于需要定期备份Postgres数据并存储至S3兼容存储的场景。

核心功能和特性

• 支持自定义S3端点（如MinIO等S3兼容存储）
• 采用管道传输数据，避免使用临时文件
• 默认使用pigz（并行gzip）进行压缩，提升效率
• 自动创建S3桶（若桶不存在）
• 兼容Docker和Kubernetes环境运行
• 默认将所有数据库备份为单独文件（除非通过PG_URI指定单个数据库）
• 支持PGP加密（配置GPG密钥后自动加密备份文件）
• 提供多种压缩方式：pigz、xz、bzip2、lrzip、brotli、zstd
• 备份前自动检查数据库连接状态（ping测试）
• 待办：支持其他数据库（如MySQL等）
• 待办：支持通过独立环境变量（HOST、PORT、USERNAME、PASSWORD）配置数据库连接，作为PG_URI的替代方案

使用场景和适用范围

• Docker环境下的Postgres数据库定期备份
• Kubernetes集群中通过CronJob实现定时自动备份
• 需要将Postgres数据备份至S3或S3兼容存储（如MinIO）的场景
• 对备份文件有加密需求（通过PGP）的场景
• 需要选择不同压缩算法优化备份速度或压缩率的场景

使用方法和配置说明

配置参数说明

通过环境变量配置镜像行为，关键参数如下：

Docker部署示例

可通过docker-compose.yml文件运行容器，示例配置参考项目中的docker-compose.yml文件。基本运行命令需指定上述环境变量，例如：

bash
docker run -e S3_BUCK=postgres-backups -e S3_NAME=prod/backup -e S3_URI=https://access-key:secret-key@minio.example.com -e PG_URI=postgres://user:pass@postgres-host:5432/db -e COMPRESS=pigz backuptools/postgres-backup-s3

Kubernetes定时备份

通过Kubernetes CronJob实现定时备份，配置示例参考项目中的kubernetes-cronjob.yml文件。CronJob将定期执行备份任务，配置中需正确设置环境变量以匹配S3和Postgres连接信息。

作者与贡献者

• Standart AG, LLC
• https://github.com/JargeZ