将 JSON 补丁应用到 Kubernetes 自定义资源时出错答案

【问题标题】：Error while applying JSON Patch to Kubernetes Custom Resource将 JSON 补丁应用到 Kubernetes 自定义资源时出错
【发布时间】：2019-08-14 02:56:46
【问题描述】：

我有一个 Kubernetes Custom Resource 实例，我想使用 JSON 补丁通过 Kubernetes API 对其进行修补。

这是我的 PATCH 请求：

PATCH /apis/example.com/v1alpha1/namespaces/default/mycrd/test HTTP/1.1
Accept: application/json
Content-Type: application/json-patch+json
[other headers omitted for brevity...]

[
  {"op": "replace", "path": "/status/foo", value: "bar"}
]

我相当确定我的请求正文是有效的JSON patch，并且我之前已经使用类似的 API 调用成功更新了核心（非 CRD）API 资源。 CRD 定义了一个openAPIV3Schema，它明确允许.status.foo 存在并且属于string 类型。

上面的请求被 Kubernetes API 服务器拒绝，响应如下：

HTTP/1.1 422 Unprocessable Entity
Conent-Type: application/json
[other headers omitted for brevity...]

{
  "kind": "Status",
  "apiVersion": "v1",
  "metadata": {},
  "status": "Failure",
  "message": "the server rejected our request due to an error in our request",
  "reason": "Invalid",
  "details": {},
  "code": 422
}

根据CRD documentation，CRD 应该支持具有application/json-patch+json 内容类型的PATCH 请求。但由于某种原因，请求似乎是无效的，而 Kubernetes 没有费心告诉我为什么。 API 服务器 pod 在其日志流中也没有任何相关消息。

在命令行使用kubectl patch也会出现同样的错误：

$ kubectl patch mycrd.example.com test --type=json -p '[{"op": "replace", "path": "/status/foo", "value": "bar"}]'   
The  "" is invalid

发生此错误的可能原因有哪些？我有哪些选项可以进一步调试？

【问题讨论】：

标签： kubernetes kubectl kubernetes-custom-resources

【解决方案1】：

在输入问题的同时找到（或至少是部分）答案...

Kubernetes API 服务器不会为 JSON 补丁输入递归创建嵌套对象。此行为与 JSON Patch specification in RFC 6902, section A.12 一致：

A.12。添加到不存在的目标

目标 JSON 文档示例：
{ "foo": "bar" }
一个 JSON 补丁文件：
[
  { "op": "add", "path": "/baz/bat", "value": "qux" }
]
这个 JSON Patch 文档，应用于上面的目标 JSON 文档，会导致错误（因此，它不会被应用），因为“添加”操作的目标位置既不引用文档的根，也不是现有对象的成员，也不是现有数组的成员。

这就是当自定义资源没有.status 属性开始时原始请求失败的原因。以下两个后续调用（第二个是原始调用）将成功完成：

$ kubectl patch mycrd.example.com test --type=json \
    -p '[{"op": "replace", "path": "/status", "value": {}}]'
mycrd.example.com/test patched
$ kubectl patch mycrd.example.com test --type=json \
    -p '[{"op": "replace", "path": "/status/foo", "value": "bar"}]'
mycrd.example.com/test patched

显然，replace 将整个 .status 属性与 {} 一起使用不是一个好主意，如果该属性已经包含您想要保留的数据。

在这种情况下，JSON 补丁的合适替代方案是 JSON Merge Patch：

PATCH /apis/example.com/v1alpha1/namespaces/default/mycrd/test HTTP/1.1
Accept: application/json
Content-Type: application/merge-patch+json
[other headers omitted for brevity...]

{
  "status": {
    "foo": "bar"
  }
}

或者，或者，使用kubectl：

$ kubectl patch mycrd.example.com test --type=merge \
    -p '{"status": {"foo": "bar"}}'
mycrd.example.com/test patched

【讨论】：