# kube-sync

**Repository Path**: hexug/kube-sync

## Basic Information

- **Project Name**: kube-sync
- **Description**: kube-sync 是一个用于 同步和过滤 Kubernetes 资源 的命令行工具。
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/hexug/kube-sync
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-08
- **Last Updated**: 2026-04-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Kubernetes, Go语言, sync

## README

# kube-sync

[![License](https://img.shields.io/badge/License-Apache_2.0-green?logo=apache&style=flat-square)](LICENSE)
[![Go Report Card](https://img.shields.io/badge/Go%20Report-A+-brightgreen?logo=go&style=flat-square)](https://goreportcard.com/report/gitee.com/hexug/kube-sync)
[![Gitee tag (latest SemVer)](https://img.shields.io/badge/dynamic/json?url=https://gitee.com/api/v5/repos/hexug/kube-sync/releases/latest&label=Version&query=$.name&color=brightgreen&logo=gitee&logoColor=ee1c25&style=flat-square)](https://gitee.com/hexug/kube-sync/releases/latest)
![Go Version](https://img.shields.io/badge/Go-1.24-blue?logo=go&style=flat-square)
![Kubernetes](https://img.shields.io/badge/Kubernetes-v1.21%2B-326CE5?logo=kubernetes&logoColor=white&style=flat-square)

`kube-sync` 是一个用于 **同步、克隆、迁移和查询 Kubernetes 资源** 的命令行工具。  
通过自定义规则（include/exclude），用户可以灵活地指定需要保留或排除的字段，避免无关字段带来的干扰，专注于业务核心配置。

## ✨ 功能特性

- **资源同步**：将 Kubernetes 资源导出为本地 YAML 文件，便于与 GitOps 或配置管理结合
- **资源迁移**：支持同集群跨命名空间、跨集群的资源克隆与迁移
- **资源查询**：提供类 `kubectl get` 的查询能力，支持多种输出格式和标签过滤
- **字段过滤**：通过 **include/exclude 路径规则** 精准控制同步字段，去除集群自动生成的噪声字段
- **多资源支持**：覆盖 `Deployment`、`StatefulSet`、`DaemonSet`、`Service`、`ConfigMap`、`Secret`、`ServiceAccount`、`Role`、`RoleBinding`、`ClusterRole`、`ClusterRoleBinding`、`PersistentVolumeClaim`、`PersistentVolume` 等常见资源
- **Shell 补全**：支持 Bash、Zsh、Fish、PowerShell 的动态命令补全，包括资源名称、命名空间、标签等
- **多配置来源**：支持从文件、环境变量或默认配置加载规则
- **Debug 模式**：提供详细日志输出，便于问题排查

## 📂 项目结构

```
kube-sync/
├── cmd/              # CLI 命令定义
│   ├── root.go       # 根命令及全局参数
│   ├── sync/         # sync 子命令
│   ├── migrate/      # migrate 子命令
│   ├── get/          # get 子命令及所有资源子命令
│   └── completion/   # Shell 补全辅助函数
├── worker/           # 核心业务逻辑
│   ├── sync/         # 资源同步执行器
│   ├── migrate/      # 资源迁移执行器
│   └── get/          # 资源查询执行器
├── apps/             # 应用层（资源处理、字段清洗、文件输出）
├── conf/             # 配置加载与注册
├── version/          # 版本信息
├── main.go           # 程序入口
├── config.yaml       # 配置文件示例
├── Makefile          # 构建脚本
└── README.md
```

## 📦 安装

### 方式一：从源码编译

```bash
# 克隆项目
git clone https://gitee.com/hexug/kube-sync.git
cd kube-sync

# 编译（当前平台）
go mod tidy
go build -o kube-sync .

# 或使用 Makefile 编译 Linux amd64 二进制
make linux

# 编译并安装到 /bin（Linux，同时配置 bash 补全）
make install
```

### 方式二：下载预编译二进制

前往 [Releases 页面](https://gitee.com/hexug/kube-sync/releases/latest) 下载对应平台的二进制文件，解压后放入 `PATH` 即可。

### 验证安装

```bash
kube-sync -v
# 输出示例：kube-sync version v0.6.21,build a1b2c3d4,go1.24.4

kube-sync -V
# 输出完整版本信息（版本号、构建时间、分支、Commit、Go 版本）
```

## 🎯 快速开始

### 同步资源到本地文件

```bash
# 同步指定命名空间的资源到 ./output 目录
kube-sync sync -n ns1 -n ns2 -o ./output -f config.yaml

# 开启 debug 模式
kube-sync sync -n ns1 -o ./output -f config.yaml -d

# 排除指定工作负载
kube-sync sync -n ns1 -o ./output -e "ns1:Deployment:my-deploy"

# 只同步指定工作负载
kube-sync sync -n ns1 -o ./output -i "ns1:Deployment:my-deploy"
```

### 迁移资源到另一个命名空间或集群

```bash
# 同集群跨命名空间迁移
kube-sync migrate --src.ns ns1 --dst.ns ns2

# 跨集群迁移（指定目标集群 kubeconfig）
kube-sync migrate --src.ns ns1 --dst.ns ns2 --dst.kc ~/.kube/target-config

# 只导出为本地文件（不部署）
kube-sync migrate --src.ns ns1 --dst.ns ns2 --sync
```

### 查询集群资源

```bash
# 查询 Pod
kube-sync get pod -n my-namespace

# 查询节点资源统计
kube-sync get node-resources

# 查询 Service 端口使用情况
kube-sync get service-ports
```

## ⚙️ 全局参数

以下参数对所有子命令（`sync`、`migrate`、`get`）均有效：

| 参数 | 简写 | 类型 | 说明 |
| --- | --- | --- | --- |
| `--version` | `-v` | bool | 打印简短版本信息并退出 |
| `--Version` | `-V` | bool | 打印完整版本信息并退出 |
| `--debug` | `-d` | bool | 开启 debug 模式，输出详细日志 |
| `--config-type` | `-t` | string | 配置加载方式：`file`、`env`、`default`（默认 `default`） |
| `--config-path` | `-f` | string | 指定配置文件路径（指定后自动切换为 `file` 模式） |

## 📋 命令说明

### `sync` — 同步资源到本地文件

将指定命名空间的 Kubernetes 资源按照配置规则导出为本地 YAML 文件。

```bash
kube-sync sync [参数]
```

| 参数 | 简写 | 类型 | 说明 |
| --- | --- | --- | --- |
| `--namespaces` | `-n` | string[] | 指定需要同步的命名空间（可多次传入） |
| `--out` | `-o` | string | 指定输出路径（默认 `./`） |
| `--excludes` | `-e` | string[] | 排除指定工作负载，格式：`<namespace>:<KIND>:<name>`（与 `-i` 互斥） |
| `--includes` | `-i` | string[] | 只同步指定工作负载，格式：`<namespace>:<KIND>:<name>`（与 `-e` 互斥） |
| `--skip-configmap` | `-c` | bool | 跳过 ConfigMap 同步 |
| `--skip-pv-pvc` | `-p` | bool | 跳过 PV/PVC 同步 |
| `--skip-secret` | `-s` | bool | 跳过 Secret 同步 |
| `--kube-config` | `-k` | string | 指定 kubeconfig 文件路径 |

**示例：**

```bash
# 同步多个命名空间，跳过 ConfigMap 和 Secret
kube-sync sync -n ns1 -n ns2 -o ./output -c -s -f config.yaml

# 只同步指定的 Deployment（支持 Tab 补全三段式参数）
kube-sync sync -n ns1 -i "ns1:Deployment:my-app" -o ./output

# 排除多个工作负载
kube-sync sync -n ns1 -e "ns1:Deployment:test-app" -e "ns1:Service:test-svc" -o ./output
```

> **提示**：`--excludes` 和 `--includes` 支持 Tab 补全，格式为 `<namespace>:<KIND>:<name>`，
> 输入 `ns1:` 后按 Tab 可补全该命名空间下的工作负载类型和名称。

---

### `migrate` — 克隆或迁移资源

支持同集群跨命名空间迁移，以及跨集群资源克隆。

```bash
kube-sync migrate [参数]
```

| 参数 | 简写 | 类型 | 说明 |
| --- | --- | --- | --- |
| `--src.ns` | — | string[] | 源命名空间（必填，可多次传入） |
| `--dst.ns` | — | string[] | 目标命名空间（可多次传入；同集群时不填则只导出文件） |
| `--src.kc` | — | string | 源集群 kubeconfig 路径（不填则使用默认集群） |
| `--dst.kc` | — | string | 目标集群 kubeconfig 路径（不填则迁移到同一集群） |
| `--out` | `-o` | string | 指定输出路径（默认 `./`） |
| `--excludes` | `-e` | string[] | 排除指定工作负载，格式：`<namespace>:<KIND>:<name>`（与 `-i` 互斥） |
| `--includes` | `-i` | string[] | 只迁移指定工作负载，格式：`<namespace>:<KIND>:<name>`（与 `-e` 互斥） |
| `--sync` | — | bool | 只导出为本地文件，不部署到目标集群 |
| `--skip-configmap` | `-c` | bool | 跳过 ConfigMap（跳过可能导致工作负载无法正常启动） |
| `--skip-pv-pvc` | `-p` | bool | 跳过 PV/PVC |
| `--skip-secret` | `-s` | bool | 跳过 Secret |

**迁移场景说明：**

| 场景 | 命令示例 |
| --- | --- |
| 同集群、同命名空间（只能导出文件） | `kube-sync migrate --src.ns ns1` |
| 同集群、跨命名空间 | `kube-sync migrate --src.ns ns1 --dst.ns ns2` |
| 跨集群、同名命名空间 | `kube-sync migrate --src.ns ns1 --dst.kc ~/.kube/target` |
| 跨集群、不同命名空间 | `kube-sync migrate --src.ns ns1 --dst.ns ns2 --dst.kc ~/.kube/target` |
| 只导出文件（不部署） | `kube-sync migrate --src.ns ns1 --dst.ns ns2 --sync` |

---

### `get` — 查询 Kubernetes 资源

提供类 `kubectl get` 的查询能力，支持多种资源类型、输出格式和标签过滤。

```bash
kube-sync get <子命令> [NAME...] [参数]
```

#### 子命令列表

**命名空间级别资源**（支持 `-n`、`-A`、`-l`、`-o`、`--show-labels`）：

| 子命令 | 缩写 | 说明 |
| --- | --- | --- |
| `pod` | — | 查询 Pod 信息 |
| `deployment` | `deploy` | 查询 Deployment 信息 |
| `statefulset` | `sts` | 查询 StatefulSet 信息 |
| `daemonset` | `ds` | 查询 DaemonSet 信息 |
| `service` | `svc` | 查询 Service 信息 |
| `service-ports` | `svc-ports` | 分析 Service 端口使用情况（默认查询所有命名空间） |
| `configmap` | `cm` | 查询 ConfigMap 信息 |
| `secret` | — | 查询 Secret 信息 |
| `persistentvolumeclaim` | `pvc` | 查询 PersistentVolumeClaim 信息 |
| `serviceaccount` | `sa` | 查询 ServiceAccount 信息 |
| `cronjob` | — | 查询 CronJob 信息 |
| `job` | — | 查询 Job 信息 |
| `ingress` | `ing` | 查询 Ingress 信息 |

**集群级别资源**（不支持 `-n`/`-A`）：

| 子命令 | 缩写 | 说明 |
| --- | --- | --- |
| `namespace` | `ns` | 查询 Namespace 信息 |
| `node` | `no` | 查询 Node 信息 |
| `persistentvolume` | `pv` | 查询 PersistentVolume 信息 |
| `node-resources` | `nr` | 查询节点资源统计（容量/可分配量/已分配量） |
| `node-pods` | `np` | 查询节点下运行的 Pod 列表及资源信息 |

**工作负载资源配置**（查询容器的 CPU/内存/GPU requests 和 limits）：

| 子命令 | 缩写 | 说明 |
| --- | --- | --- |
| `deployment-resources` | `dpr` | 查询 Deployment 容器资源配置 |
| `daemonset-resources` | `dsr` | 查询 DaemonSet 容器资源配置 |
| `statefulset-resources` | `stsr` | 查询 StatefulSet 容器资源配置 |
| `pod-resources` | `pr` | 查询 Pod 容器资源配置 |
| `cronjob-resources` | `cjr` | 查询 CronJob 容器资源配置 |
| `job-resources` | `jr` | 查询 Job 容器资源配置 |

#### 通用参数

以下参数适用于大多数命名空间级别的子命令：

| 参数 | 简写 | 类型 | 说明 |
| --- | --- | --- | --- |
| `--namespace` | `-n` | string[] | 指定命名空间（可多次使用），默认 `default` |
| `--all-namespaces` | `-A` | bool | 查询所有命名空间（等同于 `kubectl -A`） |
| `--selector` | `-l` | string | 标签选择器，如 `app=nginx`（等同于 `kubectl -l`） |
| `--output` | `-o` | string | 输出格式：`json`、`yaml`、`name`、`wide`、`jsonpath=<template>` |
| `--show-labels` | — | bool | 显示资源标签（默认树状视图；`-o wide` 输出扁平表格；`-o json/yaml` 输出 LabelList 格式） |
| `--kube-config` | `-k` | string | 指定 kubeconfig 文件路径（继承自 `get` 父命令） |

#### `node-resources` 专属参数

| 参数 | 说明 |
| --- | --- |
| `--sort-by` | 排序字段：`cpu`、`memory`、`cpu-usage`、`memory-usage`（按使用量/使用率降序） |

> 已分配量来自节点上所有运行中 Pod 的资源请求（requests）之和，与 `kubectl describe node` 的 "Allocated resources" 一致，**无需 metrics-server**。

#### `node-pods` 专属参数

| 参数 | 说明 |
| --- | --- |
| `--sort-by` | 排序字段：`cpu`、`mem`、`gpu`（按 Pod 请求量降序） |

> 默认以树状结构展示（节点 → 命名空间 → Pod），`-o wide` 输出类似 `kubectl describe node` 的 Non-terminated Pods 表格，包含 CPU、内存、GPU 的请求值/限制值及占节点可分配量的百分比。

#### `service-ports` 专属参数

| 参数 | 说明 |
| --- | --- |
| `--node-port` | 显示 NodePort 使用详情表格（已用端口及对应 Service） |
| `--cluster-port` | 显示 ClusterPort 使用详情表格（所有 Service 端口） |
| `--sort` | 在 `--node-port`/`--cluster-port` 模式下，按端口号升序排列 |
| `--node-port-min` | NodePort 范围最小值（默认自动检测，失败则使用 30000） |
| `--node-port-max` | NodePort 范围最大值（默认自动检测，失败则使用 32767） |

#### `get` 使用示例

```bash
# 查询指定命名空间下的所有 Pod
kube-sync get pod -n my-namespace

# 查询多个命名空间
kube-sync get pod -n ns1 -n ns2

# 查询所有命名空间（等同于 kubectl get pod -A）
kube-sync get pod -A

# 按标签过滤
kube-sync get deploy -n my-namespace -l app=nginx

# 以 YAML 格式输出指定资源
kube-sync get deploy -n my-namespace my-deploy -o yaml

# 使用 JSONPath 显示 Pod 名称和所在节点
kube-sync get pod -n my-namespace -o 'jsonpath={range .items[*]}{.metadata.name}{"\t"}{.spec.nodeName}{"\n"}{end}'

# 查询节点资源统计，按 CPU 使用率降序
kube-sync get node-resources --sort-by cpu-usage

# 查询节点下的 Pod，以表格形式展示资源详情
kube-sync get node-pods -o wide --sort-by cpu

# 分析 Service 端口使用情况
kube-sync get service-ports
kube-sync get service-ports --node-port --sort
kube-sync get service-ports --cluster-port --sort

# 查询 Deployment 的容器资源配置
kube-sync get deployment-resources -n my-namespace
kube-sync get dpr -A
```

## 🔧 命令补全

`kube-sync` 支持 Shell 命令补全，可自动补全子命令、参数名称、资源名称、命名空间、标签等，大幅提升使用效率。

### 支持的 Shell

| Shell | 支持情况 |
| --- | --- |
| Bash | ✅ |
| Zsh | ✅ |
| Fish | ✅ |
| PowerShell | ✅ |

### 配置方法

#### Bash（Linux / macOS）

**临时生效（当前会话）：**

```bash
source <(kube-sync completion bash)
```

**永久生效：**

```bash
# Linux
kube-sync completion bash > /etc/bash_completion.d/kube-sync

# macOS（需要先安装 bash-completion）
brew install bash-completion
kube-sync completion bash > $(brew --prefix)/etc/bash_completion.d/kube-sync
```

#### Zsh（Linux / macOS）

**临时生效（当前会话）：**

```zsh
source <(kube-sync completion zsh)
```

**永久生效：**

```zsh
# 将补全脚本写入 Zsh 补全目录
kube-sync completion zsh > "${fpath[1]}/_kube-sync"

# 或追加到 ~/.zshrc
echo 'source <(kube-sync completion zsh)' >> ~/.zshrc
source ~/.zshrc
```

#### Fish

**临时生效（当前会话）：**

```fish
kube-sync completion fish | source
```

**永久生效：**

```fish
kube-sync completion fish > ~/.config/fish/completions/kube-sync.fish
```

#### PowerShell（Windows）

**临时生效（当前会话）：**

```powershell
kube-sync completion powershell | Out-String | Invoke-Expression
```

**永久生效：**

```powershell
# 将补全脚本追加到 PowerShell 配置文件
kube-sync completion powershell >> $PROFILE
```

### 使用方式

配置完成后，在终端中输入命令时按 `Tab` 键即可触发补全：

```bash
# 补全顶层子命令
kube-sync <TAB>
# → sync  migrate  get  completion

# 补全参数（需要先输入 - 或 -- 再按 Tab）
kube-sync sync -<TAB>
kube-sync sync --<TAB>

# 补全 completion 的 shell 类型
kube-sync completion <TAB>
# → bash  zsh  fish  powershell

# 补全 --config-type 的值
kube-sync --config-type <TAB>
# → default  file  env
```

> **提示**：补全参数时，需要先输入 `-` 或 `--` 再按 `Tab`，例如：`kube-sync sync -<TAB>` 或 `kube-sync sync --<TAB>`。

### `get` 命令补全

`get` 命令支持对所有子命令的名称、参数及参数值进行动态补全，包括资源名称、命名空间、标签选择器和输出格式等。

```bash
# 补全 get 子命令
kube-sync get <TAB>

# 补全命名空间（动态从集群获取）
kube-sync get pod -n <TAB>

# 补全 Pod 名称（动态从集群获取，支持已输入前缀过滤）
kube-sync get pod -n my-namespace <TAB>

# 补全标签选择器（动态从集群获取该命名空间下的标签键值）
kube-sync get deploy -n my-namespace -l <TAB>

# 补全输出格式
kube-sync get pod -n my-namespace -o <TAB>
# → wide  json  yaml  name  jsonpath=

# 补全 node-resources 的 --sort-by 值
kube-sync get node-resources --sort-by <TAB>
# → cpu  memory  cpu-usage  memory-usage

# 补全 node-pods 的 --sort-by 值
kube-sync get node-pods --sort-by <TAB>
# → cpu  mem  gpu

# 补全节点名称（动态从集群获取）
kube-sync get node <TAB>
kube-sync get node-pods <TAB>
```

### `sync` / `migrate` 命令补全

```bash
# 补全 --namespaces（动态从集群获取）
kube-sync sync --namespaces <TAB>

# 补全 --excludes / --includes（三段式：namespace:KIND:name）
kube-sync sync --excludes <TAB>
# 输入前缀后继续补全
kube-sync sync --excludes "my-namespace:" <TAB>
# → my-namespace:Deployment:  my-namespace:Service:  ...

# migrate 补全源/目标命名空间
kube-sync migrate --src.ns <TAB>
kube-sync migrate --dst.ns <TAB>
```

### 常见问题

**Q：配置后补全不生效？**

- 确认已重新加载 Shell 配置（执行 `source ~/.bashrc` 或重新打开终端）。
- Bash 用户请确认已安装 `bash-completion`：`apt install bash-completion` 或 `brew install bash-completion`。
- Zsh 用户请确认 `~/.zshrc` 中已启用 `compinit`，可添加以下内容：
  ```zsh
  autoload -Uz compinit
  compinit
  ```

**Q：Zsh 提示 `command not found: compdef`？**

在 `~/.zshrc` 中添加以下内容后重新加载：

```zsh
autoload -Uz compinit
compinit
```

**Q：macOS 上 Bash 补全不工作？**

macOS 默认的 Bash 版本较旧，建议通过 Homebrew 安装新版 Bash 并配置 `bash-completion@2`：

```bash
brew install bash bash-completion@2
```

**Q：Bash 下标签选择器（`key=value`）或三段式参数（`ns:KIND:name`）补全不正确？**

`kube-sync completion bash` 生成的脚本已自动修复此问题（移除了 `:` 和 `=` 作为 bash 单词分隔符）。
如果仍有问题，请确保使用的是最新版本的补全脚本：

```bash
kube-sync completion bash > /etc/bash_completion.d/kube-sync
source /etc/bash_completion.d/kube-sync
```

---

## 🛠️ 配置规则

`kube-sync` 使用 YAML 配置文件来定义同步/迁移时的字段过滤规则。核心字段是 **rules**，每个资源类型可以通过 **include/exclude 路径规则** 来控制哪些字段参与同步，哪些字段被忽略。

- **include**：白名单，只保留列出的字段路径
- **exclude**：黑名单，忽略列出的字段路径（通常是集群自动生成的动态字段，如 `status`、`uid` 等）
- 两者同时存在时，**include 优先级更高**

### 示例配置

```yaml
rules:
  config:
    deployment:
      include:
        - "metadata/labels/app"
        - "spec/template/metadata/labels/a"
        - "spec/template/metadata/labels/app"
        - "spec/template/metadata/labels/b"
      exclude:
        - "metadata/annotations"
        - "metadata/managedFields"
        - "metadata/creationTimestamp"
        - "metadata/generation"
        - "metadata/resourceVersion"
        - "metadata/uid"
        - "spec/progressDeadlineSeconds"
        - "spec/revisionHistoryLimit"
        - "spec/strategy"
        - "spec/template/metadata/annotations"
        - "spec/template/metadata/creationTimestamp"
        - "spec/template/spec/containers/terminationMessagePath"
        - "spec/template/spec/containers/terminationMessagePolicy"
        - "spec/template/spec/restartPolicy"
        - "spec/template/spec/terminationGracePeriodSeconds"
        - "spec/template/spec/dnsPolicy"
        - "spec/template/spec/securityContext"
        - "spec/template/spec/schedulerName"
        - "status"

    service:
      include: []
      exclude:
        - "metadata/annotations"
        - "metadata/creationTimestamp"
        - "metadata/managedFields"
        - "metadata/resourceVersion"
        - "metadata/uid"
        - "status"
        - "spec/clusterIP"
        - "spec/clusterIPs"
        - "spec/internalTrafficPolicy"
        - "spec/ipFamilies"
        - "spec/ipFamilyPolicy"
        - "spec/sessionAffinity"
        - "spec/externalTrafficPolicy"

    configmap:
      include:
        - "apiVersion"
        - "kind"
        - "metadata/name"
        - "metadata/namespace"
        - "metadata/labels"
        - "data"
      exclude: []

    serviceaccount:
      include:
        - "apiVersion"
        - "kind"
        - "metadata/name"
        - "metadata/namespace"
      exclude:

    role:
      include:
        - "apiVersion"
        - "kind"
        - "metadata/name"
        - "metadata/namespace"
        - "rules"
      exclude:

    rolebindings:
      include:
        - "apiVersion"
        - "kind"
        - "metadata/name"
        - "metadata/namespace"
        - "subjects"
        - "roleRef"
      exclude:

    clusterrole:
      include:
        - "apiVersion"
        - "kind"
        - "metadata/name"
        - "rules"
      exclude:

    clusterrolebindings:
      include:
        - "apiVersion"
        - "kind"
        - "metadata/name"
        - "subjects"
        - "roleRef"
      exclude:

    pv:
      exclude:
        - "metadata/annotations"
        - "metadata/finalizers"
        - "metadata/creationTimestamp"
        - "metadata/managedFields"
        - "metadata/resourceVersion"
        - "metadata/uid"
        - "spec/claimRef/kind"
        - "spec/claimRef/uid"
        - "spec/claimRef/apiVersion"
        - "spec/claimRef/resourceVersion"
        - "status"

    pvc:
      exclude:
        - "metadata/annotations"
        - "metadata/finalizers"
        - "metadata/creationTimestamp"
        - "metadata/managedFields"
        - "metadata/resourceVersion"
        - "metadata/uid"
        - "status"

    secret:
      include:
        - "apiVersion"
        - "kind"
        - "metadata/name"
        - "metadata/namespace"
        - "data"
        - "type"
```

### 字段路径说明

字段路径使用 `/` 分隔，对应 Kubernetes 资源 YAML 的层级结构。例如：

- `metadata/labels/app` → `.metadata.labels.app`
- `spec/template/spec/containers/terminationMessagePath` → `.spec.template.spec.containers[*].terminationMessagePath`
- `status` → 整个 `.status` 字段

---

## 🏗️ 构建说明

```bash
# 安装依赖
make dep

# 编译当前平台
make build

# 编译 Linux amd64
make linux

# 编译 Windows amd64
make windows

# 编译并安装到 /bin（Linux，同时更新 bash 补全脚本）
make install

# 运行单元测试
make test

# 清理构建产物
make clean

# 打 Git Tag 并推送
make tag
```

编译产物输出到 `dist/` 目录，文件名格式为 `kube-sync-<VERSION>-<OS>-<ARCH>`。

---

## 📄 License

本项目基于 [Apache 2.0 License](./LICENSE) 开源。

---

## 🙌 致谢

感谢 Gitee 提供稳定的代码托管平台。

Built with ❤️ by [hexug](https://gitee.com/hexug)

> 如果你觉得这个项目对你有帮助，不妨点个 Star ⭐ 支持一下！