Linux 知识库

Appearance

kubectl patch - 部分更新Kubernetes资源字段 ​

命令简介 ​

kubectl patch 是 Kubernetes 中用于对现有资源进行部分更新的命令，允许用户修改资源的特定字段而无需提交完整的资源配置文件。它支持多种合并策略，适用于动态调整资源配置的场景，如更新镜像版本、调整副本数或修改标签等。

语法格式 ​

bash
kubectl patch (-f FILENAME | TYPE NAME) -p PATCH [--type=<策略类型>]
  • -f FILENAME：通过文件指定资源（如YAML/JSON）
  • TYPE NAME：直接指定资源类型和名称（如deployment/nginx）
  • -p PATCH：指定补丁内容（JSON/YAML格式）
  • --type：可选，指定合并策略（默认为strategic）

合并策略 ​

策略类型描述适用场景示例
strategic（默认）Kubernetes特有策略，智能合并列表字段（如通过name匹配容器）原生资源（如Deployment/Pod）kubectl patch deploy/nginx -p '{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.20"}]}}}}'
merge遵循RFC 7386，直接覆盖指定字段简单字段更新（如标签/注解）kubectl patch svc/nginx --type=merge -p '{"metadata":{"labels":{"env":"prod"}}}'
json遵循RFC 6902，通过操作指令（如add/replace）精确修改复杂更新（如数组插入/删除）kubectl patch pod/nginx --type=json -p='[{"op":"replace","path":"/spec/containers/0/image","value":"nginx:alpine"}]'

经典案例 ​

bash
# 1. 更新Deployment的副本数（strategic策略）
kubectl patch deployment/my-app -p '{"spec":{"replicas":3}}'

# 2. 修改Pod的容器镜像（JSON Patch）
kubectl patch pod/nginx --type=json -p='[{"op":"replace","path":"/spec/containers/0/image","value":"nginx:1.19"}]'

# 3. 为Node添加污点（YAML格式）
kubectl patch node/node1 -p $'spec:\n taints:\n - effect: NoSchedule\n key: disk\n value: ssd'

# 4. 通过文件更新ConfigMap
echo '{"data":{"key":"new-value"}}' > patch.json
kubectl patch cm/my-config --patch-file=patch.json

与replace的区别 ​

特性patchreplace
数据量仅传输变更部分需完整资源配置
冲突风险低（仅目标字段冲突时失败）高（依赖resourceVersion）
列表处理支持智能合并直接覆盖
适用场景高效局部更新全量配置同步

注意事项 ​

  1. 自定义资源限制：strategic策略仅支持原生Kubernetes资源，CRD需使用merge或json策略。
  2. 格式校验：JSON/YAML补丁需严格符合语法，否则会报错（如引号缺失或缩进错误）。
  3. 生产环境谨慎操作：直接修改运行中资源可能引发服务中断，建议先通过--dry-run=client测试。
  4. 冲突处理：若多人同时修改同一字段，后提交的patch会覆盖前者的变更，需通过kubectl get确认最新状态。
  5. 子资源支持：可通过--subresource更新特定子资源（如scale）：
    bash
    kubectl patch deployment/nginx --subresource='scale' --type='merge' -p '{"spec":{"replicas":5}}'

调试技巧 ​

bash
# 1. 查看合并后的效果（不实际提交）
kubectl patch deploy/nginx -p '{"spec":{"replicas":3}}' --dry-run=client -o yaml

# 2. 获取字段合并策略
kubectl explain deployment.spec.strategy --recursive | grep patchStrategy

通过灵活选择合并策略，kubectl patch能够高效完成Kubernetes资源的精细化更新，是DevOps日常运维中的利器。