oscarsix/rancher-autobackup

rancher-autobackup

镜像概述

rancher-autobackup镜像旨在通过Rancher API连接Rancher环境，将栈数据备份到指定的Git仓库，帮助用户实现Rancher栈配置的自动化备份与版本化管理。

核心功能

1. 通过Rancher API获取目标环境的栈信息
2. 将Rancher环境数据提交到指定的Git仓库
3. 支持通过环境变量灵活配置API密钥、Git仓库地址等参数
4. 可选自定义Git分支、提交信息、用户名等扩展配置

使用场景

1. Rancher环境中栈配置的定期自动备份
2. 需要对Rancher栈配置进行版本化管理的场景
3. 希望将栈备份数据存储到Git仓库的用户需求

配置说明

必选环境变量

• RANCHER_API_ACCESSKEY: Rancher API访问密钥
• RANCHER_API_SECRETKEY: Rancher API secret密钥
• RANCHER_URL: Rancher服务器地址（如[***]
• SSH_PRIVATE_KEY_FILE: SSH私钥文件路径（用于访问Git仓库）
• GIT_REPO_SSH_URL: Git仓库的SSH地址（如ssh://***:xxx/yyy.git）
• GIT_USER_EMAIL: Git提交者***

可选环境变量

• RANCHER_ENVIRONMENT_ID: Rancher环境ID（默认自动获取）
• GIT_REPO_BRANCH: Git仓库分支（默认master）
• GIT_USER_NAME: Git提交者名称（默认Rancher）
• GIT_COMMIT_MESSAGE: Git提交信息（默认autobackup）

部署示例

docker run方式

bash
docker run \
  -e "RANCHER_API_ACCESSKEY=XXXXXXXXXXXXXXXXXXXX" \
  -e "RANCHER_API_SECRETKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -e "RANCHER_URL=https://rancher.server:8080" \
  -e "RANCHER_ENVIRONMENT_ID=1a5" \
  -e "SSH_PRIVATE_KEY_FILE=/run/secrets/id_rancher" \
  -e "GIT_REPO_SSH_URL=ssh://git@github.com:xxx/yyy.git" \
  -e "GIT_USER_EMAIL=autobackup@rancher.com" \
  -v ${PWD}/id_rancher:/run/secrets/id_rancher \
  oscarsix/rancher-autobackup:latest

docker-compose方式

yaml
version: '2'
services:
  autobackup:
    image: oscarsix/rancher-autobackup:latest
    environment:
      RANCHER_API_ACCESSKEY: XXXXXXXXXXXXXXXXXXXX
      RANCHER_API_SECRETKEY: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
      RANCHER_URL: [***]
      SSH_PRIVATE_KEY_FILE: /run/secrets/id_rancher
      GIT_REPO_SSH_URL: ssh://***:xxx/yyy.git
      GIT_USER_*** ***
    secrets:
      - mode: '0400'
        uid: '0'
        gid: '0'
        source: id_rancher
        target: id_rancher
    labels:
      io.rancher.container.start_once: 'true'
      io.rancher.container.pull_image: always
      cron.schedule: 0 * * * * ?
secrets:
  id_rancher:
    external: 'true'