diogopms/postgres-gcs-backup

postgres-gcs-backup

镜像概述和主要用途

postgres-gcs-backup是一个用于PostgreSQL数据库备份的Docker镜像，通过pg_dump工具生成数据库备份，并将备份文件上传至Google Cloud Storage（GCS）。同时支持在备份失败时发送Slack告警，提供Helm chart实现Kubernetes环境下的部署支持。

核心功能和特性

• 数据库备份：使用pg_dump工具执行PostgreSQL数据库备份，支持单库或全库备份
• GCS集成：自动将备份文件上传至指定的Google Cloud Storage bucket
• 告警机制：支持配置Slack告警，在备份失败时发送通知
• Kubernetes支持：提供Helm chart，便于在Kubernetes集群中部署和管理
• 灵活配置：通过环境变量自定义备份路径、数据库连接参数、GCS认证等

使用场景和适用范围

适用于需要定期备份PostgreSQL数据库并存储到Google Cloud Storage的场景，尤其适合：

• 部署在Kubernetes集群中的PostgreSQL实例备份
• 需要集中管理数据库备份的云原生环境
• 对备份失败需要及时告警的生产环境

配置参数

以下是可配置的环境变量参数：

使用方法

Docker运行示例

bash
docker run -it --rm \
  -e GCS_BUCKET=gs://your-backup-bucket \
  -e GCS_KEY_FILE_PATH=/secrets/credentials.json \
  -e POSTGRES_HOST=postgres-host \
  -e POSTGRES_USER=postgres-user \
  -e POSTGRES_PASSWORD=postgres-password \
  -e SLACK_ALERTS=true \
  -e SLACK_WEBHOOK_URL=https://hooks.slack.com/services/XXX \
  -e SLACK_CHANNEL=#database-alerts \
  -v /path/to/your/gcs-key.json:/secrets/credentials.json \
  docker.xuanyuan.run/diogopms/postgres-gcs-backup:latest

本地运行

bash
# 克隆仓库
git clone https://github.com/diogopms/postgres-gcs-backup.git
cd postgres-gcs-backup

# 赋予脚本执行权限
chmod +x backup.sh

# 基本运行（需提前配置gcloud认证）
GCS_BUCKET=gs://your-backup-bucket ./backup.sh

# 启用Slack告警的运行示例
SLACK_ALERTS=true \
SLACK_WEBHOOK_URL=https://hooks.slack.com/services/XXX \
SLACK_CHANNEL=#database-alerts \
SLACK_USERNAME=backup-bot \
GCS_BUCKET=gs://your-backup-bucket \
./backup.sh

Kubernetes部署

安装Helm Chart

bash
# 安装release（默认命名空间）
helm install my-postgres-backup chart/postgres-gcs-backup

# 自定义配置安装
helm install my-postgres-backup chart/postgres-gcs-backup \
  --set env.GCS_BUCKET=gs://your-backup-bucket \
  --set secretName=my-gcs-secret

卸载Helm Chart

bash
helm delete my-postgres-backup

GCS认证方式

本地环境（使用gcloud CLI）

1. 安装gcloud CLI并初始化：

bash
gcloud init --console-only

2. 登录关联GCS的Google账号，完成认证配置

Kubernetes环境（使用服务账号）

1. 创建GCS服务账号并下载JSON密钥文件
2. 创建Kubernetes Secret：

bash
kubectl create secret generic postgres-gcs-backup \
  --from-file=credentials.json=/path/to/your/key.json

3. 部署时通过--set secretName=postgres-gcs-backup指定Secret名称（默认已配置），密钥文件将挂载至/secrets/gcp/credentials.json，需确保GCS_KEY_FILE_PATH指向该路径