majestik/kube-backup

kube-backup

镜像概述

kube-backup是一个实用工具容器，用于从Kubernetes集群中的容器备份数据库和文件，并将备份文件存储到AWS S3桶。镜像可在https://hub.docker.com/r/whereisaaron/kube-backup/%E8%8E%B7%E5%8F%96%EF%BC%8C%E6%BA%90%E7%A0%81%E6%89%98%E7%AE%A1%E4%BA%8Ehttps://github.com/whereisaaron/kube-backup%EF%BC%8C%E6%AC%A2%E8%BF%8E%E5%9C%A8Github%E4%B8%8A%E6%8F%90%E5%87%BA%E6%84%8F%E8%A7%81%E5%92%8C%E8%B4%A1%E7%8C%AE%E6%94%B9%E8%BF%9B%E3%80%82

核心功能

• 通过kubectl exec在目标容器内执行备份操作（支持MySQL数据库和文件）
• 将备份文件存储到AWS S3桶
• 支持通过Secret管理AWS凭证、S3桶名等配置信息
• 支持手动执行或定时调度备份任务
• 支持通过Pod选择器（selector）指定目标Pod
• 支持同步时间戳，使多备份文件归类到同一S3目录

使用场景

• 手动备份Kubernetes集群中的数据库或关键文件
• 定时自动备份生产环境或测试环境的应用数据
• 多容器状态应用的同步备份（如同时备份数据库和关联文件）
• 验证备份流程的模拟操作（使用--dry-run参数）

配置说明

前提条件

需在运行kube-backup的命名空间中创建名为kube-backup的Secret，包含AWS凭证和S3桶名。示例部署文件可参考https://github.com/whereisaaron/kube-backup/tree/master/deploy%E3%80%82

命令行参数

kube-backup.sh支持以下主要参数（也可通过环境变量配置）：

• --task: 指定备份任务类型（如backup-mysql-exec、backup-files-exec）
• --pod: 目标Pod名称（或使用--selector指定Pod选择器）
• --container: 目标容器名称
• --files-path: 需备份的文件路径（仅backup-files-exec任务）
• --database: 需备份的数据库名称（仅backup-mysql-exec任务）
• --s3-bucket: S3桶名（默认从AWS Secret获取）
• --dry-run: 模拟备份操作，不实际生成备份文件

部署示例

手动备份文件

bash
kubectl run --attach --rm --restart=Never kube-backup --image whereisaaron/kube-backup:0.1.5 -- \
 --task=backup-files-exec --namespace=default --pod=my-pod --container=website --files-path=/var/www

手动备份MySQL数据库

bash
kubectl run --attach --rm --restart=Never kube-backup --image whereisaaron/kube-backup:0.1.5 -- \
 --task=backup-mysql-exec --namespace=default --pod=my-pod --container=mysql

定时每日备份

bash
kubectl run --schedule='@daily' --restart=Never kube-backup --image whereisaaron/kube-backup:0.1.5 -- \
 --task=backup-files-exec --namespace=default --pod=my-pod --container=website --files-path=/var/www

多任务同步备份脚本（Bash）

bash
#!/bin/bash

TIMESTAMP=$(date +%Y%m%d-%H%M)
run_name () { 
  echo "kb-$(cat /dev/urandom | tr -dc 'a-z0-9' | head -c 4)" 
}
#EXTRA_OPTS='--dry-run'

CMD='kubectl run --attach --restart=Never --rm --image=whereisaaron/kube-backup:0.1.5 --namespace=kube-backup'

$CMD $(run_name) -- $EXTRA_OPTS \
  --task=backup-mysql-exec \
  --timestamp=${TIMESTAMP} \
  --namespace=default \
  --selector=app=myapp,env=dev,component=mysql 

$CMD $(run_name) -- $EXTRA_OPTS \
  --task=backup-files-exec \
  --timestamp=${TIMESTAMP} \
  --namespace=default \
  --selector=app=myapp,env=dev,component=website \
  --files-path=/var/www/assets \
  --backup-name=assets

多任务同步备份脚本（Powershell）

powershell
#!/bin/powershell
$ErrorActionPreference = "Stop"
$WarningPreference = "SilentlyContinue"

$Timestamp = $(Get-Date -f yyyyMMdd-hhmm)
function Run-Name () { 
 'kb-task-' + -join (1..4 | %{ [char[]](0..127) -cmatch '[a-z0-9]' | Get-Random })
}
#$ExtraOpts = '--dry-run'

$Command = 'kubectl run --attach --rm --quiet --restart=Never --image=whereisaaron/kube-backup:0.1.5 --namespace=kube-backup'

Invoke-Expression "$Command $(Run-Name) -- $ExtraOpts --task=backup-mysql-exec --timestamp=$Timestamp --namespace=default '--selector=app=myapp,env=dev,component=mysql'"
if ($LASTEXITCODE -ne 0) { Exit $LASTEXITCODE }

Invoke-Expression "$Command $(Run-Name) -- $ExtraOpts --task=backup-files-exec --timestamp=$Timestamp --namespace=default '--selector=app=myapp,env=dev,component=website' --files-path=/var/www/assets --backup-name=assets"
if ($LASTEXITCODE -ne 0) { Exit $LASTEXITCODE }

通过YAML文件创建备份任务

创建backup-website.yaml文件：

yaml
apiVersion: v1
kind: Pod
metadata:
  name: kb-task
  namespace: kube-backup
spec:
  containers:
  - args:
    - --task=backup-files-exec
    - --namespace=default
    - --selector=app=my-app,env=dev,component=website
    - --files-path=/var/www/assets
    - --backup-name=assets
    image: whereisaaron/kube-backup:0.1.5
    name: kb-task
  restartPolicy: Never

执行部署：

bash
kubectl create -f backup-website.yaml