giovannicandido/consul-backup-s3

consul-backup-s3

Docker容器，用于备份Consul数据并上传至Amazon S3。

镜像概述

consul-backup-s3是一款轻量级工具，专注于Consul数据的备份与恢复，支持将备份文件存储到Amazon S3，适用于Docker和Kubernetes环境，帮助用户保障Consul数据的安全性与可恢复性。

核心功能

• 支持Consul数据的备份（backup）与恢复（restore）操作
• 与Amazon S3深度集成，将备份文件存储至指定S3桶
• 支持Docker直接运行及Kubernetes Job/CronJob部署
• 可通过AWS凭证文件或环境变量配置S3访问权限

使用场景

• Consul集群数据的定期自动备份（如每小时/每日备份）
• 灾难恢复场景下的Consul数据快速恢复
• 跨环境的Consul数据迁移（通过S3传输备份文件）

配置说明

参数说明

AWS凭证配置

• 本地运行：挂载.aws目录（包含config和credentials文件）至容器/root/.aws路径
• Kubernetes环境：创建包含AWS凭证的Secret，挂载至容器对应路径
• EC2实例：若实例拥有S3访问权限，无需额外配置凭证

部署示例

Docker运行示例

备份操作

bash
docker run giovannicandido/consul-backup-s3 -m backup -h http://consul.server:8500 -p my-consul -b s3://my-bucket/consul-backups/

带AWS凭证的备份操作

bash
docker run -v ~/.aws:/root/.aws giovannicandido/consul-backup-s3 -m backup -h http://consul.server:8500 -p my-consul -b s3://my-bucket/consul-backups/

Kubernetes部署示例

创建AWS凭证Secret

bash
kubectl create secret generic consul-backup-aws --from-file=./.aws/config --from-file=./.aws/credentials

恢复Job示例

yaml
apiVersion: batch/v1
kind: Job
metadata:
  name: consul-restore
spec:
  template:
    spec:
      containers:
      - name: consul-backup
        image: giovannicandido/consul-backup-s3
        args: ["-m", "restore", "-h", "http://consul-service:8500", "-f", "my-consul-2024-05-20_10:00.snap", "-b", "s3://my-bucket/consul-backups/"]
        volumeMounts:
        - name: aws-credentials
          mountPath: /root/.aws
          readOnly: true
      volumes:
      - name: aws-credentials
        secret:
          secretName: consul-backup-aws
      restartPolicy: OnFailure
  backoffLimit: 4

定期备份CronJob示例

yaml
apiVersion: batch/v1beta1
kind: CronJob
metadata:
  name: consul-backup-hourly
spec:
  schedule: "0 * * * *" # 每小时执行一次
  concurrencyPolicy: Forbid
  jobTemplate:
    spec:
      template:
        spec:
          containers:
          - name: consul-backup
            image: giovannicandido/consul-backup-s3
            args: ["-m", "backup", "-h", "[***]", "-p", "my-consul", "-b", "s3://my-bucket/consul-backups/"]
            volumeMounts:
            - name: aws-credentials
              mountPath: /root/.aws
              readOnly: true
          volumes:
          - name: aws-credentials
            secret:
              secretName: consul-backup-aws
          restartPolicy: OnFailure
      backoffLimit: 4