projectsyn/k8s-object-dumper

K8s Object Dumper

镜像概述

K8s Object Dumper是一个用于从Kubernetes集群收集所有对象并将其写入文件的工具。该工具专为K8up（Kubernetes备份解决方案）设计，主要作为其预备份命令使用，确保在执行备份前完成Kubernetes对象的数据收集。

核心功能与特性

• 对象收集：能够从Kubernetes集群中收集所有类型的对象
• 文件写入：将收集到的Kubernetes对象数据写入文件系统
• K8up集成：专为K8up备份流程设计，可直接作为预备份命令运行

使用场景与适用范围

适用于采用K8up进行Kubernetes集群备份的场景。在执行K8up备份操作前，通过运行该工具可完成Kubernetes对象的收集与存储，为后续备份流程提供完整的集群对象数据。

使用方法与配置说明

基本使用要求

• 需具备访问Kubernetes集群的权限（通常通过kubeconfig配置）
• 需指定输出目录，用于存储收集到的对象文件

Docker Run示例

bash
docker run -v /path/to/local/kubeconfig:/kubeconfig \
           -v /path/to/output/directory:/output \
           projectsyn/k8s-object-dumper \
           --kubeconfig /kubeconfig \
           --output /output

参数说明：

• -v /path/to/local/kubeconfig:/kubeconfig：挂载本地kubeconfig文件到容器内，提供Kubernetes集群访问权限
• -v /path/to/output/directory:/output：挂载本地目录作为输出路径，用于保存收集到的对象文件
• --kubeconfig /kubeconfig：指定容器内kubeconfig文件路径
• --output /output：指定对象数据的输出目录路径

作为K8up预备份命令使用

在K8up备份配置中，可将该工具配置为preBackupCommand，示例如下（以K8up Backup资源为例）：

yaml
apiVersion: k8up.io/v1
kind: Backup
metadata:
  name: example-backup
spec:
  backend:
    # 配置K8up后端存储（如S3、PVC等）
  preBackupCommand:
    - /k8s-object-dumper
    - --kubeconfig
    - /var/run/secrets/kubernetes.io/serviceaccount/kubeconfig
    - --output
    - /backup/objects
  # 其他备份配置...

更多信息

项目详细文档及配置选项请参见GitHub仓库：https://github.com/projectsyn/k8s-object-dumper/