xalt/backup

Docker Compose应用的备份容器

镜像概述

该镜像作为边车容器，用于备份Docker Compose应用中的持久化数据文件夹，通过定时任务实现数据同步，确保数据在目标服务器上的一致性。

核心功能与特性

• 条件触发备份：当BACKUP_HOST变量设置为非"false"值时触发备份，否则不执行
• 定时任务配置：通过CRON_DATE环境变量定义备份执行时间（cron表达式格式）
• 服务管理：备份前自动关闭其他服务，完成后重启服务
• SSH连接：使用SSH连接目标服务器，支持自定义密钥文件路径（通过BACKUP_KEY_FILE）和登录用户（通过BACKUP_USER）
• 智能同步：采用rsync命令执行备份，保留文件的用户/组、权限、扩展属性、硬链接/软链接及修改时间，递归同步并删除目标端不存在的文件
• 排除机制：支持通过服务目录顶层的"exclude"文件定义需排除的文件/目录列表
• 镜像更新：若设置DOCKER_COMPOSE_PULL变量，可在备份后检查并拉取服务镜像更新，同时检查自身镜像更新

先决条件

文件结构要求

所有持久化数据需存储在与docker-compose.yml同目录下，示例结构：

bash
$ tree -AL 1 /opt/docker/jira.domain.com
.
├── docker-compose.yml
├── .exclusions
├── jira
└── jira-mysql
2 directories, 1 file

docker-compose.yml配置示例

需包含参数化的备份容器及待备份容器定义：

yaml
version: '3'
services:
  backup:
    image: docker.xuanyuan.run/xalt/backup
    environment:
      - BACKUP_HOST=10.0.0.1
      - BACKUP_SUFFIX=-live
      - CRON_DATE=20 1 * * *
      - DOCKER_COMPOSE_PULL=true
      - TIME_ZONE=Europe/Berlin
    restart: always
    volumes:
      - /home/dummy/.ssh/id_rsa:/tmp/id_rsa:ro
      - /opt/docker:/opt/docker
      - .:/path
      - /var/run/docker.sock:/var/run/docker.sock:rw
      - /var/run/docker:/var/run/docker
  jira-mysql:
    image: docker.xuanyuan.run/xalt/mysql:5.7
    environment:
      - MYSQL_ROOT_PASSWORD=dummy
      - MYSQL_DATABASE=jira
      - MYSQL_USER=jira
      - MYSQL_PASSWORD=dummy
    networks:
      jira:
        aliases:
          - db
    restart: always
    volumes:
      - ./jira-mysql:/var/lib/mysql
  jira:
    image: docker.xuanyuan.run/xalt/jira
    depends_on:
      - jira-mysql
    environment:
      - VIRTUAL_HOST=jira.domain.com
      - VIRTUAL_PORT=8080
      - RAM_MIN=768M
      - RAM_MAX=4096M
      - JAVA_OPTS=-Dfile.encoding=utf-8 -Dsun.jnu.encoding=UTF-8
      - HTTPS=true
      - PROXY_NAME=jira.domain.com
    networks:
      jira:
      reverse-proxy:
    restart: always
    volumes:
      - ./jira:/var/atlassian/jira
networks:
  jira:
  reverse-proxy:
    external: true

排除文件示例

在服务目录顶层创建"exclude"文件定义需排除的文件/目录：

bash
$ cat .exclusions
jira/export
jira/log

参数说明

环境变量配置

使用方法

基本部署步骤

1. 准备文件结构：按先决条件要求组织项目目录，包含docker-compose.yml及持久化数据目录
2. 配置排除文件：（可选）在项目根目录创建"exclude"文件定义排除规则
3. 编写docker-compose.yml：配置备份服务，包含必要环境变量和卷挂载
4. 启动服务：执行docker-compose up -d启动服务，备份将按CRON_DATE定时执行

备份流程说明

1. 服务停止：备份容器关闭当前Docker Compose项目中的其他服务
2. SSH连接：使用BACKUP_USER和BACKUP_KEY_FILE连接BACKUP_HOST
3. 目录准备：在目标服务器创建备份目录（若不存在）
4. 数据同步：通过rsync执行同步，保留文件属性、链接及修改时间，删除目标端冗余文件
5. 镜像更新：若启用DOCKER_COMPOSE_PULL，拉取服务镜像及自身镜像更新
6. 服务重启：重启所有服务完成备份流程

注意事项

• 目标服务器备份策略：本镜像仅确保数据在目标服务器的实时同步，需配合目标服务器的系统级备份策略实现完整数据保护
• SSH密钥权限：挂载的密钥文件需确保权限正确（建议600），否则可能导致连接失败
• cron表达式格式：遵循Ubuntu 18.04兼容的cron表达式格式，格式为"分 时 日 月 周"

适用场景

适用于需要定期备份持久化数据的Docker Compose应用，尤其适合中小型项目的数据保护需求，可作为完整备份策略的一部分（需配合目标服务器的备份方案）。