ArgoCD部署应用出现metadata.annotations过大问题

　　使用 Argo CD 部署 kube-prometheus-stack 的时候，出现 the metadata.annotations is invalid: Too long: must have at most 262144 bytes 的问题，导致整个 Application 出现 Sync Error。 这是由于Kubernetes 对于 metadata.annotations 字段总长度有限制，通常不能超过262144字节（256KB），而执行 kubectl apply 时会在 annotation 中加入 last-applied-configuration, 从而导致 annotation 过大无法 apply。

解决方法

　　最简单的就是使用 replace 代替 apply， 在 Argo CD 中可以在点击 Sync 时勾选 Replace。

　　不过需要注意的是，replace 会导致资源被硬替换，因此操作时需要小心谨慎判断资源对象。

　　对于经常出现这种情况的资源，可以在 Argo CD 中指定 sync options:

1
2
3
4
5
6
7
8
9
10
11

apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
    ...
spec:
  ...
  syncPolicy:
    ...
    syncOptions:
      - CreateNamespace=true
      - Replace=true

或者指定 Server-side Apply | Argo CD:

1
2
3

syncPolicy:
  syncOptions:
  - ServerSideApply=true 

Server-side Apply 是 Kubernetes 1.18+ 推出的资源声明和变更机制，通过 API 服务器直接对资源做合并（而不是 kubectl 客户端先比对现状再上传补丁），并由集群服务器追踪每个字段的“所有权（field manager）”。

附:

1. 资源首次上线时都可用 create。
2. 日常配置变更推荐 apply，避免参数丢失，支持声明式管理。
3. replace 适合某些全字段强制替换的场合（如清除字段、重建），用错会丢配置。