kuberhost/kube-backup

Kube-backup

镜像概述和主要用途

Kube-backup是一款将Kubernetes集群资源状态备份到Git仓库的工具。它能够自动拉取远程Git仓库，保存Kubernetes资源状态，生成结构化的备份文件，并提交、推送变更至远程仓库，实现集群资源的版本控制与历史追踪，便于灾难恢复和配置审计。

核心功能和特性

• 结构化Git存储：按资源类型和命名空间组织备份文件，包含全局资源、Grafana配置及命名空间资源
• 灵活的资源过滤：支持按命名空间、资源类型或单个对象包含/排除备份范围
• 自定义资源支持：可添加自定义资源定义(CRD)到备份范围
• Grafana配置备份：集成Grafana API，支持备份Grafana配置（需启用相关参数）
• 环境变量配置：通过环境变量灵活配置备份行为，如Git仓库地址、提交信息、时区等
• 定期执行：推荐配合Kubernetes CronJob实现定期自动备份

Git结构

备份文件在Git仓库中按以下结构组织：

_global_ - 全局资源，如Node、ClusterRole、StorageClass等
_grafana_ - Grafana配置（启用Grafana时）
<namespace> - 命名空间，如kube-system、default等
  <ResourceType> - 资源类型文件夹
    <resource-name.yaml> - 单个资源文件

部署指南

部署文件

部署所需的YAML清单位于https://github.com/kuberhost/kube-backup/tree/master/deploy%E3%80%82

创建部署密钥

GitHub和GitLab支持为单个仓库添加访问密钥：

1. 创建目标Git仓库
2. 生成SSH密钥：ssh-keygen -f ./new_key
3. 将新生成的SSH密钥添加到仓库，赋予写权限
4. 将密钥保存到https://github.com/kuberhost/kube-backup/blob/master/deploy/2_config_map.yaml%EF%BC%88%E5%8F%82%E8%80%83%E6%96%87%E4%BB%B6%E5%86%85%E6%B3%A8%E9%87%8A%EF%BC%89

测试部署

推荐通过Kubernetes CronJob定期执行备份。如需立即测试，可修改CronJob调度时间或使用相同参数创建临时Pod。

使用命令

• kube_backup backup：拉取远程Git仓库，保存Kubernetes资源状态，在本地仓库创建提交
• kube_backup push：将本地提交推送到远程仓库
• kube_backup help：显示帮助信息

默认行为：Docker镜像默认执行kube_backup backup && kube_backup push

配置参数

通过环境变量配置备份行为：

安全注意事项

为避免中间人***，建议提供known_hosts文件。默认known_hosts包含github.com、gitlab.com和bitbucket.org的密钥。

自定义资源配置

若集群包含自定义资源（如Prometheus、CertManager相关CRD），可通过环境变量添加到备份范围：

1. 获取自定义资源定义

bash
# 列出所有CRD
kubectl get crd

# 获取更详细的CRD信息（需jq工具）
kubectl get crd -o json | jq -r '.items | (.[] | [.spec.names.singular, .spec.group, .spec.scope]) | @tsv'

2. 配置环境变量

在容器规格中添加环境变量：

yaml
env:
  - name: EXTRA_GLOBAL_RESOURCES
    value: "clusterissuer"  # 集群级CRD（scope=Cluster）
  - name: EXTRA_RESOURCES
    value: "alertmanager, prometheus, prometheusrule, servicemonitor, certificate, issuer"  # 命名空间级CRD（scope=Namespaced）

致谢

特别感谢Pieter Lange提供的https://github.com/pieterlange/kube-backup/%E3%80%82