camptocamp/conplicity

Bivac

Website: https://camptocamp.github.io/bivac

![Build Status]([] ![Coverage Status]([] ![Go Report Card]([] ![By Camptocamp]([]

镜像概述

Bivac是一款用于自动备份Docker命名卷的工具，支持Duplicity和RClone两种备份引擎，能够自动检测卷中存储的数据类型（如PostgreSQL、MySQL等）并调整备份策略，同时提供灵活的配置方式和指标推送功能。

核心功能

• 多引擎支持：兼容Duplicity（适用于常规数据）和RClone（适用于大文件）；
• 智能适配：自动识别数据类型（PostgreSQL/MySQL/OpenLDAP等），执行针对性备份（如pg_dumpall）；
• 灵活配置：通过卷标签、环境变量或配置文件定制备份参数；
• 指标集成：支持向Prometheus Push Gateway推送备份指标；
• 过期清理：可设置自动删除旧备份的时间阈值。

使用场景

1. 容器化环境中Docker卷的定期自动备份；
2. 将备份数据存储到S3、Swift等云存储后端；
3. 对不同类型数据库（PostgreSQL/MySQL）的卷进行针对性备份；
4. 批量管理多个Docker卷的备份策略。

配置说明

环境变量

• BIVAC_TARGET_URL：备份目标存储地址（如S3路径）；
• BIVAC_ENGINE：指定备份引擎（duplicity/rclone）；
• BIVAC_FULL_IF_OLDER_THAN：全量备份间隔（默认15天）；
• 云存储凭证（如AWS_ACCESS_KEY_ID、SWIFT_USERNAME等）。

卷标签

• io.bivac.ignore=true：忽略该卷；
• io.bivac.no_verify=true：跳过备份验证；
• io.bivac.engine=rclone：指定该卷使用的引擎。

配置文件

在卷根目录放置.bivac.overrides文件（INI格式），示例：

ini
engine = "rclone"
no_verify = true
target_url = "s3+http://s3-us-east-1.amazonaws.com/foo/bar"

[duplicity]
full_if_older_than = "3D"
remove_older_than = "5D"

部署示例

备份所有卷到S3（Docker容器方式）

shell
docker run -v /var/run/docker.sock:/var/run/docker.sock:ro --rm -ti \
  -e BIVAC_TARGET_URL=s3+http://s3-eu-west-1.amazonaws.com/<我的桶>/<我的目录> \
  -e AWS_ACCESS_KEY_ID=<我的密钥ID> \
  -e AWS_SECRET_ACCESS_KEY=<我的密钥> \
  camptocamp/bivac

启用数据类型检测

需挂载Docker卷目录：

shell
docker run -v /var/run/docker.sock:/var/run/docker.sock:ro \
  -v /var/lib/docker/volumes:/var/lib/docker/volumes:ro --rm -ti \
  -e BIVAC_TARGET_URL=<存储地址> \
  camptocamp/bivac

返回码说明

• 0：所有备份成功；
• 1：至少一个备份失败；
• 2：指标推送失败。