# 介绍一个小工具：Dyff

YAML 工人经常需要对类似的 YAML 进行对比，查看其中的更新或者状态变化，通用的 diff 工具经常是能胜任的，例如：

```bash
$ diff n1.yaml n2.yaml
...
<       - image: dustise/sleep:v0.9.5
---
>       - image: dustise/sleep:v0.9.6
```

但是如果出现了字段的平移，或者新加了一些元素，结果可能就比较难看了，例如移动几个字段的位置：

```bash
$ diff n1.yaml n2.yaml
11,13d11
<   progressDeadlineSeconds: 600
<   replicas: 1
<   revisionHistoryLimit: 10
19d16
<       maxSurge: 25%
20a18
>       maxSurge: 25%
21a20,22
>   progressDeadlineSeconds: 500
>   replicas: 1
>   revisionHistoryLimit: 10
...
```

这几个字段发生变化并移位之后，就比较难用肉眼观测具体的有效变更了。这种情况下，Dyff 就可以派上用场了。

安装很容易，在 macOS 中可以使用 Homebrew 进行安装：`brew install homeport/tap/dyff`，Linux 和 macOS 中也可以使用脚本 `curl --silent --location https://tinyurl.com/y4qvdl4d |bash` 进行安装。

官方文档中展示了它的基本子命令 `between`：

![](https://cdn.hashnode.com/res/hashnode/image/upload/v1745923583674/5251c398-23fa-4117-a216-3b19d27accfc.png align="center")

如果对一个手写的 yaml 和它的线上版本进行对比，可能会有很麻烦的输出，例如 `managedFiled`、`status` 等字段：

```yaml
$ kubectl get deploy sleep -o yaml | dyff bw sleep.yaml  -
...
+ one map entry added:
  status:
...
metadata
  + six map entries added:
    creationTimestamp: 2021-01-24T07:51:40Z
    generation: 1
    managedFields:
...
spec.template.spec
  + one map entry added:
    securityContext: {}

spec.template.spec.containers.sleep
  + one map entry added:
    resources: {}
...
```

这里可以用 `krew` 目录中的 `neat` 插件进行处理，这个插件能将线上运行对象所输出的 YAML 进行清理，能大大地减少状态字段的干扰，同样也支持管道操作，例如：

```bash
kubectl get deploy sleep -o yaml | kubectl neat - |  dyff bw sleep.yaml  -
```

这样处理一下之后，视野就会清楚很多了。

除了对比之外，dyff 还支持 yaml 和 json 的互转，加上 neat 的操作可以是这样：

```bash
$ kubectl get deploy sleep -o yaml | kubectl neat - | dyff json -
{
  "apiVersion": "apps/v1",
  "kind": "Deployment",
  "metadata": {
    "annotations": {
      "deployment.kubernetes.io/revision": "1"
    },
```

## 相关链接

* Dyff：`https://github.com/homeport/dyff`
    
* Neat：`https://github.com/itaysk/kubectl-neat`
    
* Krew：`https://github.com/kubernetes-sigs/krew`