jkaninda/pg-bkup

PG-BKUP

PG-BKUP 是一个Docker容器镜像，专为PostgreSQL数据库的备份、恢复和迁移设计。它支持多种存储选项，并通过GPG加密确保数据安全。

PG-BKUP旨在无缝部署于Docker和Kubernetes平台，简化跨环境的PostgreSQL备份、恢复和迁移流程。作为轻量级多架构解决方案，它兼容Docker、Docker Swarm、Kubernetes及其他容器编排平台。

https://github.com/jkaninda/pg-bkup/actions/workflows/tests.yml/badge.svg](https://github.com/jkaninda/pg-bkup/actions/workflows/tests.yml) https://github.com/jkaninda/pg-bkup/actions/workflows/release.yml/badge.svg](https://github.com/jkaninda/pg-bkup/actions/workflows/release.yml) https://goreportcard.com/badge/github.com/jkaninda/mysql-bkup](https://goreportcard.com/report/github.com/jkaninda/pg-bkup) !Docker镜像大小 !Docker拉取量

核心功能

• 灵活的存储后端：

  • 本地文件系统
  • Amazon S3及S3兼容存储（如MinIO、Wasabi）
  • FTP
  • SSH兼容存储
  • Azure Blob存储

• 数据安全：

  • 备份可通过GPG加密，确保数据机密性。

• 部署灵活性：

  • 提供Docker镜像https://hub.docker.com/r/jkaninda/pg-bkup
  • 可部署于Docker、Docker Swarm和Kubernetes
  • 支持周期性备份：
    • 在Docker上通过自动化备份计划
    • 在Kubernetes上作为Job或CronJob运行

• 通知机制：

  • 通过以下方式获取备份成功或失败的实时更新：

    • ---

    • 电子邮件

💡 使用场景

• 定时备份：通过Docker或Kubernetes实现自动化周期性备份。
• 灾难恢复：快速将备份恢复到干净的PostgreSQL实例。
• 数据库迁移：使用内置的migrate功能无缝跨环境迁移数据。
• 安全归档：将加密备份安全存储在云端或远程服务器。

🚀 为什么选择PG-BKUP？

PG-BKUP不仅仅是另一个PostgreSQL备份工具，它是为现代DevOps工作流打造的 robust、生产级解决方案。

开发者、系统管理员和DevOps工程师选择PG-BKUP的原因：

✅ 一体化备份、恢复与迁移

无论是备份单个数据库、恢复关键数据还是跨环境迁移，PG-BKUP通过单一统一的CLI完成所有操作，无需复杂脚本。

🔄 全环境兼容

专为云原生设计：

• 无缝运行于Docker、Docker Swarm和Kubernetes
• 支持CronJobs实现自动化定时备份
• 兼容GitOps和CI/CD工作流

☁️ 灵活的存储集成

备份可存储至任何位置：

• 本地磁盘
• Amazon S3、MinIO、Wasabi、Azure Blob、FTP、SSH

🔒 企业级安全

• GPG加密：在本地或云端存储前对敏感数据进行可选加密。
• 安全存储选项：支持S3、Azure Blob、SFTP和SSH等加密传输方式，防止未授权访问。

📬 即时通知

通过*******和电子邮件实时掌握备份状态，即时了解成功或失败情况。

🏃‍♂️ 轻量高效

采用Go语言编写，速度快，支持多架构（amd64、arm64、arm/v7），内存和CPU占用低，适用于云端和边缘部署。

🧪 经过测试与验证

持续维护，包含自动化测试、Docker镜像大小优化，并在主流容器平台上验证支持。

---

支持的PostgreSQL版本

PG-BKUP支持PostgreSQL 9.5及以上版本，确保与大多数现代PostgreSQL部署兼容。

✅ 已验证平台

PG-BKUP已在以下平台测试并成功运行：

• Docker
• Docker Swarm
• Kubernetes
• OpenShift

完整文档请访问 https://jkaninda.github.io/pg-bkup

相关链接

• https://hub.docker.com/r/jkaninda/pg-bkup
• https://github.com/jkaninda/pg-bkup

MySQL解决方案：

• https://github.com/jkaninda/mysql-bkup

快速开始

使用Docker CLI进行简单备份

要执行一次性备份，将本地卷挂载到容器的/backup目录并运行backup命令：

shell
docker run --rm --network your_network_name \
  -v $PWD/backup:/backup/ \
  -e "DB_HOST=dbhost" \
  -e "DB_PORT=5432" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
  jkaninda/pg-bkup backup -d database_name

或者，使用环境文件（--env-file）进行配置：

shell
docker run --rm --network your_network_name \
  --env-file your-env-file \
  -v $PWD/backup:/backup/ \
  jkaninda/pg-bkup backup -d database_name

注意：使用data-only标志仅备份数据而不包含 schema。

仅备份Schema

要仅备份特定数据库的schema，使用--schema-only标志：

shell
docker run --rm --network your_network_name \
  -v $PWD/backup:/backup/ \
  -e "DB_HOST=dbhost" \
  -e "DB_PORT=5432" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
  jkaninda/pg-bkup backup -d database_name --schema-only

备份特定表

要备份数据库中的特定表，使用--tables或-t标志，后跟逗号分隔的表名列表：

shell
docker run --rm --network your_network_name \
  -v $PWD/backup:/backup/ \
  -e "DB_HOST=dbhost" \
  -e "DB_PORT=5432" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
  jkaninda/pg-bkup backup -d database_name --tables table1,table2

备份所有数据库

要备份服务器上的所有数据库，使用--all-databases或-a标志。默认情况下，这会为每个数据库创建单独的备份文件。

shell
docker run --rm --network your_network_name \
  -v $PWD/backup:/backup/ \
  -e "DB_HOST=dbhost" \
  -e "DB_PORT=5432" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
  jkaninda/pg-bkup backup --all-databases --disable-compression

注意： 使用--all-in-one或-A标志可将所有备份合并为单个文件。

数据库迁移

migrate命令允许一步将PostgreSQL数据库从源迁移到目标数据库，结合备份和恢复操作。

bash
docker run --rm --network your_network_name \
  --env-file your-env \
  jkaninda/pg-bkup migrate

注意： 使用--all-databases（-a）标志迁移所有数据库，PG-BKUP支持在目标数据库上创建不存在的数据库。

有关数据库迁移的详细信息，请参阅https://jkaninda.github.io/pg-bkup/how-tos/migrate.html%E3%80%82

---

使用Docker CLI进行简单恢复

要恢复数据库，将本地卷挂载到/backup并运行restore命令：

shell
docker run --rm --network your_network_name \
  -v $PWD/backup:/backup/ \
  -e "DB_HOST=dbhost" \
  -e "DB_PORT=5432" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
  jkaninda/pg-bkup restore -d database_name -f backup_file.sql.gz

---

使用Docker Compose进行备份

以下是用于执行一次性备份的docker-compose.yml示例：

yaml
services:
  pg-bkup:
    # 生产环境中，将镜像标签固定到特定版本而非`latest`
    # 查看可用版本：https://github.com/jkaninda/pg-bkup/releases
    image: jkaninda/pg-bkup
    container_name: pg-bkup
    command: backup
    volumes:
      - ./backup:/backup
    environment:
      - DB_PORT=5432
      - DB_HOST=postgres
      - DB_NAME=foo
      - DB_USERNAME=bar
      - DB_PASSWORD=password
      - TZ=Europe/Paris
    networks:
      - web

networks:
  web:

---

使用Docker进行周期性备份

可以使用--cron-expression或-e标志安排周期性备份：

shell
docker run --rm --network network_name \
  -v $PWD/backup:/backup/ \
  -e "DB_HOST=hostname" \
  -e "DB_USERNAME=user" \
  -e "DB_PASSWORD=password" \
  jkaninda/pg-bkup backup -d dbName --cron-expression "@every 15m"

有关预定义计划，请参阅https://jkaninda.github.io/pg-bkup/reference/#predefined-schedules%E3%80%82

---

在单个容器中运行多个备份

PG-BKUP支持使用配置文件在单次运行中备份多个PostgreSQL数据库。可通过--config或-c标志传递文件，或设置BACKUP_CONFIG_FILE环境变量。

这适用于多个服务或应用各自需要独立数据库备份的场景。

---

配置文件示例

以下是示例config.yaml文件，定义多个数据库及其各自的连接和备份设置：

yaml
# 可选：用于定时备份的全局cron表达式
# 示例："@daily"、"@every 5m"、"0 3 * * *"
cronExpression: ""

databases:
  - host: lldap-db             # 可选：覆盖DB_HOST或使用DB_HOST_LLDAP
    port: 5432                 # 可选：默认5432，覆盖DB_PORT或使用DB_PORT_LLDAP
    name: lldap                # 必填：数据库名称
    user: lldap                # 可选：可通过DB_USERNAME覆盖或使用DB_USERNAME_LLDAP
    password: password         # 可选：可通过DB_PASSWORD覆盖或使用DB_PASSWORD_LLDAP
    path: /s3-path/lldap       # 必填：目标路径（S3、FTP、SSH等）

  - host: keycloak-db
    port: 5432
    name: keycloak
    user: keycloak
    password: password
    path: /s3-path/keycloak

  - host: gitea-db
    port: 5432
    name: gitea
    user: gitea
    password: ""               # 可为空或从DB_PASSWORD_GITEA获取
    path: /s3-path/gitea

🔹 提示： 可使用环境变量覆盖任何字段。例如，DB_PASSWORD_KEYCLOAK优先于keycloak条目中的password字段。

---

Docker Compose配置

要使用此配置在Docker Compose中运行备份：

1. 将配置文件挂载到容器中
2. 设置BACKUP_CONFIG_FILE环境变量或在命令中使用-c标志

示例docker-compose.yaml

yaml
services:
  pg-bkup:
    image: jkaninda/pg-bkup
    container_name: pg-bkup
    command: backup -c /backup/config.yaml
    volumes:
      - ./backup:/backup                # 备份目标目录
      - ./config.yaml:/backup/config.yaml  # 挂载配置文件
    environment:
      - DB_PASSWORD_GITEA=password
      - BACKUP_CRON_EXPRESSION=@daily   # 可选：覆盖配置文件中的cronExpression
    networks:
      - web

networks:
  web:

⚠️ 确保pg-bkup容器与目标数据库共享网络以保证连接。

---

在Kubernetes上部署

对于Kubernetes，可将pg-bkup部署为Job或CronJob。以下是两者的示例。

Kubernetes备份Job

此示例定义一次性备份任务：

yaml
apiVersion: batch/v1
kind: Job
metadata:
  name: backup-job
spec:
  ttlSecondsAfterFinished: 100
  template:
    spec:
      containers:
        - name: pg-bkup
          # 生产环境中，将镜像标签固定到特定版本
          # 查看可用版本：https://github.com/jkaninda/pg-bkup/releases
          image: jkaninda/pg-bkup
          command: ["backup", "-d", "db_name"]
          resources:
            limits:
              memory: "128Mi"
              cpu: "500m"
          env:
            - name: DB_HOST
              value: "postgres"
            - name: DB_USERNAME
              value: "postgres"
            - name: DB_PASSWORD
              value: "password"
          volumeMounts:
            - mountPath: /backup
              name: backup
      volumes:
        - name: backup
          hostPath:
            path: /home/toto/backup # 主机上的目录位置
            type: Directory # 可选字段
      restartPolicy: Never

Kubernetes定时备份CronJob

对于定时备份，使用CronJob：

yaml
apiVersion: batch/v1
kind: CronJob
metadata:
  name: pg-bkup-cronjob
spec:
  schedule: "0 2 * * *" # 每天凌晨2点运行
  jobTemplate:
    spec:
      template:
        spec:
          containers:
            - name: pg-bkup
              image: jkaninda/pg-bkup
              command: ["backup", "-d", "db_name"]
              env:
                - name: DB_HOST
                  value: "postgres"
                - name: DB_USERNAME
                  value: "postgres"
                - name: DB_PASSWORD
                  value: "password"
              volumeMounts:
                - mountPath: /backup
                  name: backup
          volumes:
            - name: backup
              hostPath:
                path: /home/toto/backup
                type: Directory
          restartPolicy: OnFailure

---

给予星标！⭐

如果这个项目对您有帮助，请不要忘记在https://github.com/jkaninda/pg-bkup%E4%B8%8A%E7%BB%99%E5%AE%83%E4%B8%80%E4%B8%AA%E6%98%9F%E6%A0%87%E3%80%82%E8%B0%A2%E8%B0%A2%EF%BC%81

可用镜像仓库

此Docker镜像同时发布到Docker Hub和GitHub容器 registry。根据您的偏好和需求，可使用jkaninda/pg-bkup或ghcr.io/jkaninda/pg-bkup：

docker pull jkaninda/pg-bkup
docker pull ghcr.io/jkaninda/pg-bkup

文档中引用Docker Hub，但所有示例使用ghcr.io同样有效。

参考

我们创建此镜像作为现有解决方案的更简单、更轻量的替代方案。原因如下：

• 轻量级：使用Go编写，针对性能和资源占用优化。
• 多架构支持：支持arm64和arm/v7架构。
• Docker Swarm支持：完全兼容Docker Swarm模式。
• Kubernetes支持：设计为与Kubernetes无缝协作。

许可证

本项目采用MIT许可证。详情参见LICENSE文件。

作者

Jonas Kaninda

• https://github.com/jkaninda

版权

Copyright (c) [2024] [Jonas Kaninda]