woozymasta/kube-dump

kube-dump

将Kubernetes集群备份为YAML清单。

!https://raw.githubusercontent.com/WoozyMasta/kube-dump/master/extras/logo-wide.png

!GitHub release (latest by date) !GitHub branch checks state !GitHub !GitHub last commit !Docker Pulls !Docker Cloud Build Status !Docker Image Size (latest semver)

概述

kube-dump是一款将Kubernetes集群资源备份为YAML清单的工具，可去除不必要的元数据。它支持仅备份用户有权限访问的资源，可指定命名空间或使用所有可用命名空间，同时处理命名空间级和集群级资源。工具可在本地、容器或集群中运行，支持归档和轮换备份文件，还能将备份提交至Git仓库并推送到远程。

核心功能

• 仅备份用户有读权限的资源
• 支持指定命名空间或使用所有可用命名空间
• 同时备份命名空间级和集群级资源
• 可在本地、容器或Kubernetes集群中运行
• 支持备份文件归档和自动轮换
• 可将备份提交至Git仓库并推送到远程
• 支持通过命令行参数或环境变量配置
• 可指定需备份的资源列表

计划功能

• 支持将备份发送至S3存储桶
• 通过邮件和Webhook发送通知
• 使用git-crypt加密密钥
• Bash自动补全

https://raw.githubusercontent.com/WoozyMasta/kube-dump/master/extras/kube-dump.gif]([***]

快速启动指南

• 本地运行（需kubectl依赖和配置）
• 容器中运行（需docker/podman及kubectl配置）
• 作为Pod在Kubernetes中运行（需集群访问权限和kubectl配置）
• 作为CronJob使用服务账户在Kubernetes中运行（需集群访问权限及创建角色/集群角色的能力）

容器镜像

bash
docker pull ghcr.io/woozymasta/kube-dump:1.0.7
docker pull quay.io/woozymasta/kube-dump:1.0.7
docker pull docker.io/woozymasta/kube-dump:1.0.7

依赖项

必需依赖

• kubectl - Kubernetes命令行工具
• https://github.com/stedolan/jq - 命令行JSON处理器
• https://github.com/mikefarah/yq - 命令行YAML处理器

可选依赖

• curl - 使用服务账户时检查Kubernetes API livez探针
• git - 用于将备份存储为Git仓库
• tar - 用于创建备份归档，需配合以下压缩工具之一：
  • xz - 基于LZMA算法的无损数据压缩格式
  • gzip - 单文件/流无损数据压缩工具
  • bzip2 - 使用Burrows–Wheeler算法的压缩程序

命令和标志

text
./kube-dump [command] [[flags]]

可用命令:
  all, dump                     备份所有Kubernetes资源
  ns,  dump-namespaces          备份命名空间级Kubernetes资源
  cls, dump-cluster             备份集群级Kubernetes资源

命令也可通过环境变量MODE传递。所有以下标志均有对应的大写、下划线格式环境变量，例如：
  --destination-dir == DESTINATION_DIR 

标志:
  -h, --help                    显示帮助信息
  -s, --silent                  静默执行，抑制所有标准输出消息
  -d, --destination-dir         存储备份的目录路径，默认./data
  -f, --force-remove            启动前删除数据目录中的资源

Kubernetes标志:
  -n, --namespaces              Kubernetes命名空间列表
  -r, --namespaced-resources    命名空间级资源列表
  -k, --cluster-resources       集群级资源列表
      --kube-config             kubeconfig文件路径
      --kube-context            要使用的kubeconfig上下文名称
      --kube-cluster            要使用的kubeconfig集群名称
      --kube-insecure-tls       跳过服务器证书有效性检查

Git提交标志:
  -c, --git-commit              提交更改
  -p, --git-push                提交更改并推送到远程
  -b, --git-branch              分支名称
      --git-commit-user         提交作者用户名
      --git-commit-email        提交作者邮箱
      --git-remote-name         远程仓库名称，默认origin
      --git-remote-url          远程仓库URL

归档标志:
  -a, --archivate               创建数据目录归档
      --archive-rotate-days     轮换超过N天的归档文件
      --archive-type            归档类型，可选xz、gz或bz2，默认tar

使用示例:
  $cmd dump-namespaces -n default,dev -d /mnt/dump -spa --archive-type gz

环境变量

所有环境变量在.env文件中描述，可用于容器启动配置或直接通过.env文件使用，工具启动时会自动读取。

资源默认值

若未通过参数指定，所有资源将自动从API发现：

• 命名空间列表
• 默认命名空间级资源列表
• 默认集群级资源列表