使用 Kubectl Patch 命令更新资源

news2024/12/28 2:16:01

Kubectl patch 命令允许用户对运行在 Kubernetes 集群中的资源进行局部更新。相较于我们经常使用的 kubectl apply 命令，kubectl patch 命令在更新时无需提供完整的资源文件，只需要提供要更新的内容即可。

Kubectl patch 支持以下 3 种 patch 类型：

  • strategic patch（默认）：根据不同字段 patchStrategy 决定具体的合并 patch 策略。 Strategic merge patch 并非通用的 RFC 标准，而是 Kubernetes 特有的一种更新 Kubernetes 资源对象的方式。与 JSON merge patch 和 JSON patch 相比，strategic merge patch 更为强大。
  • JSON merge patch：遵循 JSON Merge Patch, RFC 7386[1] 规范，根据 patch 中提供的期望更改的字段及其对应的值，更新到目标中。
  • JSON patch：遵循 JSON Patch, RFC 6902[2] 规范，通过明确的指令表示具体的操作。

接下来对 Kubectl patch 的 3 种类型进行介绍。

1 使用 strategic merge patch 更新资源

下面是具有 2 个副本的 Deployment 的配置文件。

# deployment-patch.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: patch-demo
spec:
  replicas: 2
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: patch-demo-ctr
        image: nginx
      tolerations:
      - effect: NoSchedule
        key: dedicated
        value: test-team

创建 Deployment。

kubectl apply -f deployment-patch.yaml

此时，每个 Pod 都有一个运行 nginx 镜像的容器。

> kubectl get pod -l app=nginx
NAME                          READY   STATUS    RESTARTS   AGE
patch-demo-54975b655f-csk9g   1/1     Running   0          50s
patch-demo-54975b655f-qvv59   1/1     Running   0          50s

现在假设你希望每个 Pod 有两个容器：一个运行 nginx，另一个运行 redis。可以执行以下命令更新，不通过 --type 参数指定 patch 类型时，默认使用 strategic 策略进行更新。

kubectl patch deployment patch-demo --patch '
{
  "spec": {
    "template": {
      "spec": {
        "containers": [
          {
            "name": "patch-demo-ctr-2",
            "image": "redis"
          }
        ]
      }
    }
  }
}'

除了通过 --patch(-p) 参数在命令中指定更新的 JSON 内容，也可以使用 --patch-file 参数指定更新的 patch 文件。创建一个名为 patch-file.yaml 的文件，内容如下：

# patch/strategic-patch-file.yaml
spec:
  template:
    spec:
      containers:
      - name: patch-demo-ctr-2
        image: redis

然后执行以下命令更新。

kubectl patch deployment patch-demo --patch-file patch-file.yaml

查看 patch-demo Deployment，输出显示 Pod 有两个容器：一个运行 nginx，一个运行 redis。

kubectl get deployment patch-demo -o yaml

前面提到默认的 strategic patch 类型是根据不同字段 patchStrategy 决定具体的合并 patch 策略。patch 策略由 Kubernetes 源代码中字段标记中的 patchStrategy 键的值指定。patchStrategy 总共有以下 3 种：

  • 1.replace（默认）: 如果 list 类型字段未设置 patchStrategy，则整个 list 会被替换掉。
  • 2.merge: 将 patch 的 list 中的元素合并到原 list 中。
  • 3.retainKeys：仅保留 object 对象中指定的字段。

例如，PodSpec 结构体[3] 的 Containers 字段的 patchStrategy 为 merge：

```go
type PodSpec struct {
  ...
  Containers []Container `json:"containers" patchStrategy:"merge" patchMergeKey:"name" protobuf:"bytes,2,rep,name=containers"`
  ...
}

你可以在 Kubernetes API 文档[4] 中看到字段的 patch 策略。

可以看到其中有两个关键信息：patchStrategy:"merge" patchMergeKey:"name" 。这就代表了，containers 列表使用 strategic merge patch 策略更新时，会把下面每个元素中的 name 字段看作 key。

简单来说，在我们 patch 更新 containers 不再需要指定下标序号了，而是指定 name 来修改，Kubernetes 会把 name 作为 key 来计算合并。如果 K8s 发现当前 containers 中已经有名字为 nginx 的容器，则只会把 image 更新上去；而如果当前 containers 中没有 nginx 容器，K8s 会把这个容器插入 containers 列表。

从 Kubernetes API 文档中可以看到 PodSpec 的 Tolerations 字段在其字段标签中没有键 patchStrategy，因此 patch 合并策略使用默认的 patch 策略，即 replace，也就是说当更新 Tolerations 字段时，整个 list 会被替换。

接下来我们尝试更新 Tolerations 字段的内容。

kubectl patch deployment patch-demo --patch '
{
  "spec": {
    "template": {
      "spec": {
        "tolerations": [
          {
            "effect": "NoSchedule",
            "key": "disktype",
            "value": "ssd"
          }
        ]
      }
    }
  }
}'

查看 patch 后的 Deployment 资源发现 PodSpec 中只有一个 Toleration，也就是说 Toleration 中原来的内容被覆盖了。

kubectl get deployment patch-demo -o yaml

Deployment strategy 用于定义在升级应用时对 Pod 进行替换的策略，其中有 2 种 策略：

  • 1.RollingUpdate（默认）：滚动更新，用新版本的 Pod 逐步替代旧版本的 Pod。
  • 2.Recreate：先删除所有的旧 Pod，然后创建新 Pod。

我们之前创建的 patch-demo Deployment 使用的是默认的 RollingUpdate 策略。

kubectl get deployment patch-demo -o yaml

如果我们尝试使用 patch 命令将 Deployment strategy 更新为 Recreate ：

kubectl patch deployment patch-demo --patch '
{
  "spec": {
    "strategy": {
      "type": "Recreate"
    }
  }
}'

会看到以下报错：

The Deployment "patch-demo" is invalid: spec.strategy.rollingUpdate: Forbidden: may not be specified when strategy `type` is 'Recreate'

这是由于 spec.strategy.rollingUpdate 字段中已经定义了 rollingUpdate 类型更新策略相关的配置参数，然而 Recreate 类型的策略是不存在这些配置参数的。我们需要再更新 ``spec.strategy.type为 Recreate 的同时，移除spec.strategy.rollingUpdate`。

查看 Kubernetes API 文档可以发现 Deployment strategy 的 patch 策略为retainKeys，我们可以在 spec.strategy 字段下配置 $retainKeys 需要保留的字段 type，未列出的字段 rollingUpdate 将会被移除。

使用新的 patch 命令更新 Deployment。

kubectl patch deployment patch-demo --patch '
{
  "spec": {
    "strategy": {
      "$retainKeys": [
        "type"
      ],
      "type": "Recreate"
    }
  }
}'

检查 Deployment 的内容。

kubectl get deployment patch-demo -o yaml

输出显示 Deployment 中的 strategy 对象不再包含 rollingUpdate 键。

2 使用 JSON merge patch 更新资源

JSON merge patch 遵循 JSON Merge Patch, RFC 7386 规范，根据 patch 中提供的期望更改的字段及其对应的值，更新到目标中。具体规则如下：

  • 1.如果提供的 patch 内容中包含目标中不存在的字段，则添加该字段。
  • 2.如果目标包含 patch 中提供的字段，则替换该字段的值。
  • 3.如果 patch 中将目标中含有的字段设置为 null，则删除该字段。

让我们看一个例子，源文件如下：

{
  "title": "Goodbye!",
  "author": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "tags": [
    "example",
    "sample"
  ],
  "content": "This will be unchanged"
}

如果我们的 patch 内容如下，JSON merge patch 将会对源文件进行以下更改：

  • 1.修改 title 字段的值。
  • 2.删除 author.familyName 字段。
  • 3.添加 phoneNumber 字段。
  • 4.删除 tags 列表中的 example。
{
  "title": "Hello!",
  "author": {
    "familyName": null
  },
  "phoneNumber": "+01-123-456-7890",
  "tags": [
    "example"
  ]
}

那么最终的文件将会变成：

{
  "title": "Hello!",
  "author": {
    "givenName": "John"
  },
  "tags": [
    "example"
  ],
  "content": "This will be unchanged",
  "phoneNumber": "+01-123-456-7890"
}

我们使用 kubectl patch 时，只需要在 --type 参数设置 merge 就可以通过 JSON merge patch 的方式更新资源了。JSON merge patch 同样支持指定文件的方式更新 patch。例如执行以下命令分别更新 patch-demo Deployment 的 replicas 副本数以及 containers 容器列表。

kubectl patch deployment --type merge patch-demo --patch '
{
  "spec": {
    "replicas": 5
  }
}'

kubectl patch deployment --type merge patch-demo --patch '
{
  "spec": {
    "template": {
      "spec": {
        "containers": [
          {
            "name": "patch-demo-ctr-3",
            "image": "nginx"
          }
        ]
      }
    }
  }
}'

查看更新后的 Deployment 资源。

kubectl get deployment patch-demo -o yaml

可以看到 replicas 字段被改为了 5，而 containers 列表被完全替换成新的了。

JSON merge patch 无法单独更新一个列表中的某个元素，因此不管我们是要在 containers 里新增容器、还是修改已有容器的 image、env 等字段，都要用整个 containers 列表来提交 patch。

kubectl patch deployment --type merge patch-demo --patch '
{
  "spec": {
    "template": {
      "spec": {
        "containers": [
          {
            "name": "patch-demo-ctr-1",
            "image": "nginx"
          },
          {
            "name": "patch-demo-ctr-2",
            "image": "redis"
          },
          {
            "name": "patch-demo-ctr-3",
            "image": "nginx"
          }
        ]
      }
    }
  }
}'

查看更新后的 Deployment 资源。

kubectl get deployment patch-demo -o yaml

3 使用 JSON patch 更新资源

JSON patch 遵循 JSON Patch, RFC 6902 规范，通过明确的指令表示具体的操作，指令在 op 字段中设置，包含：

  • 1.add：添加字段。
  • 2.remove：删除字段。
  • 3.replace：替换字段。
  • 4.move：删除指定字段的值，并将其添加到目标字段。
  • 5.copy：将指定字段的值复制到目标字段。
  • 6.test：测试字段的值是否等于给定值。

还是用上面相同的例子对比使用 JSON patch，源文件如下：

{
  "title": "Goodbye!",
  "author": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "tags": [
    "example",
    "sample"
  ],
  "content": "This will be unchanged"
}

JSON patch 的内容如下，和前面 JSON merge patch 实现的效果一样，将会对源文件进行以下更改：

  • 1.修改 title 字段的值。
  • 2.删除 author.familyName 字段。
  • 3.添加 phoneNumber 字段。
  • 4.删除 tags 列表中的 example。
[  
{ "op": "replace", "path": "/title", "value": "Hello!"},  
{ "op": "remove", "path": "/author/familyName"},  
{ "op": "add", "path": "/phoneNumber", "value": "+01-123-456-7890"},  
{ "op": "replace", "path": "/tags", "value": ["example"]}  
]

为了方便对比我把前面 JSON merge patch 的内容也放在这里。

{
  "title": "Hello!",
  "author": {
    "familyName": null
  },
  "phoneNumber": "+01-123-456-7890",
  "tags": [
    "example"
  ]
}

可以看出 JSON merge patch 和 JSON patch 相比，最大的优势就是简单，但这种简单性同样带来了一些限制：

  • 1.无法将字段的值设置为 null，因为在 JSON merge patch 中通过将字段值设置为 null 来删除该字段。
  • 2.patch 不能直接操作数组。如果你想向数组添加一个元素，或改变其中的任何元素，那么必须将整个数组包含在 patch 内容中，即使实际更改的部分很少。
  • 3.执行永远不会出错，任何错误的 patch 都会被合并。因此它是一种非常自由的格式。它不一定好，因为你可能需要在合并后执行编程检查，或者在合并后运行 JSON 模式验证。

JSON Merge Patch 是一种简单的格式，它的应用范围相对有限。当你只需要更新非常简单的 JSON Schema 时，使用 JSON Merge Patch 可能是一个不错的选择。然而，对于更复杂的用例，我会选择使用 JSON Patch，因为它适用于任何 JSON 文档，并且该规范还确保原子执行和可靠的错误报告。

我们使用 kubectl patch 时，只需要在 --type 参数设置 json 就可以通过 JSON patch 的方式更新资源了。JSON patch 同样支持指定文件的方式更新 patch。例如执行以下命令分别更新 patch-demo Deployment 的 replicas 副本数以及 containers 容器列表。

kubectl patch deployment --type json patch-demo --patch '
[
  {
    "op": "replace",
    "path": "/spec/replicas",
    "value": 2
  }
]'

kubectl patch deployment --type json patch-demo --patch '
[
  {
    "op": "add",
    "path": "/spec/template/spec/containers/3",
    "value": {
      "name": "patch-demo-ctr-4",
      "image": "redis"
    }
  }
]'

查看更新后的 Deployment 资源。

kubectl get deployment patch-demo -o yaml

4 总结

本文介绍了使用 kubectl patch 命令更新 Kubernetes 集群中资源对象的方法。Kubectl patch 命令允许用户对资源对象的指定字段进行局部更新，提高了更新操作的灵活性。文章介绍了 kubectl patch 命令的语法和使用方法，包括三种 strategic patch, JSON merge patch, JSON patch 3 种类型，并结合了具体的示例进行说明。

5 参考资料

  • [1] JSON Merge Patch, RFC 7386: https://tools.ietf.org/html/rfc7386
  • [2] JSON Patch, RFC 6902: https://tools.ietf.org/html/rfc6902
  • [3] PodSpec 结构体: https://github.com/kubernetes/api/blob/release-1.27/core/v1/types.go?spm=a2c6h.12873639.article-detail.8.d1813dd5gESTff
  • [4] Kubernetes API 文档: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#podspec-v1-core)
  • [5] Kubernetes Apply vs. Replace vs. Patch: https://blog.atomist.com/kubernetes-apply-replace-patch/
  • [6] 理解 K8s 中的 Client-Side Apply 和 Server-Side Apply: https://mp.weixin.qq.com/s/EYtMO9KGRK_lHS2IW-mZug
  • [7] JSON Patch and JSON Merge Patch: https://erosb.github.io/post/json-patch-vs-merge-patch/?ref=airplane.ghost.io
  • [8] How to use Kubectl Patch: https://www.airplane.dev/blog/kubectl-patch
  • [9] Break Down Kubernetes Server-Side Apply: https://medium.com/swlh/break-down-kubernetes-server-side-apply-5d59f6a14e26
  • [10] Kubernetes中的JSON patch: https://juejin.cn/post/6993618347904466957
  • [11] Kubectl Patch: What You Can Use It for and How to Do It: https://loft.sh/blog/kubectl-patch-what-you-can-use-it-for-and-how-to-do-it/#strategic-patch
  • [12] 你不了解的K8s资源更新机制，从一个OpenKruise用户疑问开始: https://developer.aliyun.com/article/763212#slide-2
  • [13] kubernetes update跟patch区别: https://fafucoder.github.io/2020/09/09/kubernetes-update-patch/

6 欢迎关注

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/453806.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

ROS学习第三十三节——Arbotix使用

ROS学习第三十三节——Arbotix使用

https://download.csdn.net/download/qq_45685327/87718484 1.介绍 通过 URDF 结合 rviz 可以创建并显示机器人模型，不过，当前实现的只是静态模型，如何控制模型的运动呢？在此，可以调用 Arbotix 实现此功能。 Arboti…
阅读更多...
第九章 桥接模式

第九章 桥接模式

文章目录 前言一、桥接模式(Bridge)-基本介绍完整代码Brand 手机接口，定义行为Vivo 实现 Brand 接口XiaoMi 实现 Brand 接口Phone 抽象桥接类FoldedPhone 实现桥接 （折叠样式手机）UpRightPhone 实现桥接（直立样式手机）…
阅读更多...
干货 | 被抑郁情绪所困扰？来了解CBT吧！

干货 | 被抑郁情绪所困扰？来了解CBT吧！

Hello，大家好！ 这里是 壹脑云科研圈 ，我是 喵君姐姐~ 我们的情绪就像是一组正弦波，有情绪很高涨的时刻，也会有情绪低落的瞬间，也会有情绪平稳的时候。 这种情绪上的变化非常正常，也正是因为这…
阅读更多...
shell的变量功能

shell的变量功能

文章目录 shell的变量功能什么是变量？变量的可变性与方便性影响bash环境操作的变量脚本程序设计(shell script)的好帮手 变量的使用与设置：echo、变量设置规则、unset变量的使用(echo)变量设置的规定使用案例 环境变量的功能用env观察环境变量与常见环境…
阅读更多...
数据结构（五）—— 栈与队列（2）

数据结构（五）—— 栈与队列（2）

一、接上章 栈与队列的中等、困难题。 堆是一块动态内存 栈是先进后出的堆的一种方法 队列是一种先进先出的线性表 二、题 2.5 150 逆波兰表达式求值 很有意思的一道题，将中缀表达式 4 13 / 5，转化为后缀表达式之后：["4", &qu…
阅读更多...
深入理解机器学习——过拟合（Overfitting）与欠拟合（Underfitting）

深入理解机器学习——过拟合（Overfitting）与欠拟合（Underfitting）

分类目录：《深入理解深度学习》总目录 机器学习的主要挑战是我们的算法必须能够在先前未观测的新输入上表现良好，而不只是在训练集上表现良好。在先前未观测到的输入上表现良好的能力被称为泛化（Generalization）。通常情况下&…
阅读更多...
测试需求平台6-数据持久化与PyMySQL使用

测试需求平台6-数据持久化与PyMySQL使用

✍此系列为整理分享已完结入门搭建《TPM提测平台》系列的迭代版，拥抱Vue3.0将前端框架替换成字节最新开源的arco.design，其中约60%重构和20%新增内容，定位为从 0-1手把手实现简单的测试平台开发教程，内容将囊括基础、扩展和实战&a…
阅读更多...
信息安全技术 健康医疗数据安全指南 付下载地址

信息安全技术 健康医疗数据安全指南 付下载地址

声明 本文是学习GB-T 39725-2020 信息安全技术 健康医疗数据安全指南. 而整理的学习笔记,分享出来希望更多人受益,如果存在侵权请及时联系我们 数据使用管理办法示例 第一章 总则 第一条 为规范数据使用流程，根据国家相关法律法规及相关规定，特制定本…
阅读更多...
imgaug Augment Polygons 对标注图片和polygons的数据增强

imgaug Augment Polygons 对标注图片和polygons的数据增强

对于本地化进行图像的增强，大家都是非常好操作的。但是，对于标注信息一起增强，还是稍微有一些难度的，麻烦很多。 我是遇到一个数据集非常少的任务，只有40张图。就直接标记了去训练，发现几乎不拟合&#xf…
阅读更多...
这一篇搞定Spring

这一篇搞定Spring

文章目录 一、引言1.1 原生web开发中存在哪些问题？ 二、Spring框架2.1 概念2.2 访问与下载 三、Spring架构组成四、山寨版的Spring容器4.1准备工作4.2 山寨IOC容器4.3 配置文件告诉容器 管理哪些bean4.4 相关类4.5 测试 容器 五、构建Maven项目5.1 新建项目5.2 选择…
阅读更多...
深度强化学习——AlphaGo实例讲解(5)

深度强化学习——AlphaGo实例讲解(5)

现在我们来分析AlphaGo这个实例，看看深度强化学习是怎么样用来玩围棋游戏的 AlphaGo的主要设计思路： 首先是训练，要分3步来做： 1、behavior cloning：这是一种模仿学习，alphaGo模仿人类玩家，从…
阅读更多...
STM32平衡小车 pid简单学习

STM32平衡小车 pid简单学习

自动控制系统 自动控制系统可分为开环控制系统和闭环控制系统。 1、开环控制系统开环控制系统(open-loop control system)指被控对象的输出(被控制量)对控制器(controller)的输出没有影响。在这种控制系统中，不依赖将被控量反送回来以形成任何闭环回路。 2、闭环控…
阅读更多...
c++入门（下）

c++入门（下）

C入门（下） 对于C的基础语法的讲解，由想要实现多次重复的函数，引出宏函数和inline的内联函数的对比，对于inline的讲解和运用，在后，C语言中的NULL和C中独特的nullptr的相比两者的比较&#xff0c…
阅读更多...
kong（4）：限流配置

kong（4）：限流配置

Kong 提供了 Rate Limiting 插件，实现对请求的限流功能，避免过大的请求量过大，将后端服务打挂。 Rate Limiting 支持秒/分/小时/日/月/年多种时间维度的限流，并且可以组合使用。例如说：限制每秒最 多 100 次请求&…
阅读更多...
Windows Server 2012R2 安装mysql 丢失VCRUNTIME140_1.dll------亲测

Windows Server 2012R2 安装mysql 丢失VCRUNTIME140_1.dll------亲测

无去启动此程序,因为计算机中丢失VCRUNTIME140_1.dll。尝试重新安装该程序以解决此问题。 1.解决思路 说到底还是缺少底层的依赖，先下载依赖然后安装，最后安装vc。要不然vc是安装不成功。 下载安装--一下的插件 安装过程中需要重启一次电脑。 注意:必…
阅读更多...
Android LoaderManager AsyncTaskLoader加载全部图片RecyclerView BigImageView呈现，Java（1）

Android LoaderManager AsyncTaskLoader加载全部图片RecyclerView BigImageView呈现，Java（1）

Android LoaderManager AsyncTaskLoader加载全部图片RecyclerView BigImageView呈现&#xff0c;Java&#xff08;1&#xff09; 权限&#xff1a; <uses-permission android:name"android.permission.READ_EXTERNAL_STORAGE" /><uses-permission android:n…
阅读更多...
VUE3子组件-业务代码优化

VUE3子组件-业务代码优化

Vue3子组件 1.简介 Vue 3组件的主要优势之一就是它们可以帮助你将你的应用程序分解成可维护和可重用的部分。当你在应用程序中多次使用相同的代码时&#xff0c;你可以将它们抽象成一个组件&#xff0c;然后在应用程序中的多个地方使用该组件&#xff0c;而不必每次都编写相同…
阅读更多...
5年了，终于入职阿里测试岗位，直接涨薪30K...

5年了，终于入职阿里测试岗位，直接涨薪30K...

前言 本科毕业后就一直从事软件测试的工作&#xff0c;和多数人一样&#xff0c;最开始从事功能测试的工作&#xff0c;看着自己的同学一步一步往上走&#xff0c;自己还是在原地踏步&#xff0c;说实话这不是自己想要的状态。 一年半后开始沪漂生活&#xff0c;又摸爬滚打了…
阅读更多...
阿里巴巴软件测试面试过了，起薪20k

阿里巴巴软件测试面试过了，起薪20k

普通二本计算机专业毕业&#xff0c;从毕业后&#xff0c;第一份接触测试的工作是在一家通讯小公司&#xff0c;大部分接触的工作是以功能测试为主&#xff0c;一直都是几千块钱工资&#xff0c;还一度被派出差&#xff0c;以及兼职各种产品、运维、运营的活&#xff0c;感觉自…
阅读更多...
Cleer ARC II 音弧

Cleer ARC II 音弧

戴上Cleer ARC II 音弧解放双耳&#xff0c;享受更自由的音符 用惯了各种入耳式耳机&#xff0c;换上开放式耳机&#xff0c;戴着确实更加舒服&#xff0c;特别是我现在用的这款Cleer ARC II 音弧&#xff0c;戴上还不容易掉&#xff0c;很适合运动使用。这款耳机采用一种耳挂佩…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023