JSON Patch

External

• https://tools.ietf.org/html/rfc6902
• https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/

Internal

• JSON
• JSON Merge Patch
• kubectl kustomize
• Kubernetes Strategic Merge Patch
• kubectl patch

Overview

JSON patch is defined in RFC6902.

JSON patch defines a JSON document structure for expressing a sequence of operations to apply to a JSON document, in order to change it. The format is suitable to use with the HTTP PATCH method and an "application/json-patch+json" media type.

PATCH /my/data HTTP/1.1
Host: example.org
Content-Length: 326
Content-Type: application/json-patch+json
If-Match: "abc123"

[
  { "op": "test", "path": "/a/b/c", "value": "foo" },
  { "op": "remove", "path": "/a/b/c" },
  { "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] },
  { "op": "replace", "path": "/a/b/c", "value": 42 },
  { "op": "move", "from": "/a/b/c", "path": "/a/b/d" },
  { "op": "copy", "from": "/a/b/d", "path": "/a/b/e" }
]

Evaluation of a JSON Patch document begins agains a target JSON document. Operations are applied sequentially, in the order in they appear in the array. Evaluation continues until all operations succeed or an error occurs.

Also See

JSON Merge Patch

Kubernetes Strategic Merge Patch