kubectl patch

概要

使用战略合并补丁 (strategic merge patch)、JSON 合并补丁 (JSON merge patch) 或 JSON 补丁 (JSON patch) 更新资源的字段。

接受 JSON 和 YAML 格式。

注意:自定义资源不支持战略合并补丁。

kubectl patch (-f FILENAME | TYPE NAME) [-p PATCH|--patch-file FILE]

示例

  # Partially update a node using a strategic merge patch, specifying the patch as JSON
  kubectl patch node k8s-node-1 -p '{"spec":{"unschedulable":true}}'
  
  # Partially update a node using a strategic merge patch, specifying the patch as YAML
  kubectl patch node k8s-node-1 -p $'spec:\n unschedulable: true'
  
  # Partially update a node identified by the type and name specified in "node.json" using strategic merge patch
  kubectl patch -f node.json -p '{"spec":{"unschedulable":true}}'
  
  # Update a container's image; spec.containers[*].name is required because it's a merge key
  kubectl patch pod valid-pod -p '{"spec":{"containers":[{"name":"kubernetes-serve-hostname","image":"new image"}]}}'
  
  # Update a container's image using a JSON patch with positional arrays
  kubectl patch pod valid-pod --type='json' -p='[{"op": "replace", "path": "/spec/containers/0/image", "value":"new image"}]'
  
  # Update a deployment's replicas through the 'scale' subresource using a merge patch
  kubectl patch deployment nginx-deployment --subresource='scale' --type='merge' -p '{"spec":{"replicas":2}}'

选项

--allow-missing-template-keys     默认值: true

如果为 true,当模板中字段或映射键缺失时,忽略模板中的任何错误。仅适用于 golang 和 jsonpath 输出格式。

--dry-run string[="unchanged"]     默认值: "none"

必须是 "none", "server", 或 "client"。如果采用客户端策略,仅打印将要发送的对象,而不发送它。如果采用服务器策略,提交服务器端请求但不持久化资源。

--field-manager string     默认值: "kubectl-patch"

用于跟踪字段所有权的管理器名称。

-f, --filename strings

标识要更新的资源的文件的文件名、目录或 URL

-h, --help

patch 命令帮助

-k, --kustomize string

处理 kustomization 目录。此标志不能与 -f 或 -R 一起使用。

--local

如果为 true,patch 将操作文件内容,而非服务器端资源。

-o, --output string

输出格式。取值范围:(json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file)。

-p, --patch string

要应用于资源 JSON 文件的补丁。

--patch-file string

包含要应用于资源的补丁文件。

-R, --recursive

递归地处理 -f, --filename 中使用的目录。当你想管理组织在同一目录下的相关清单文件时很有用。

--show-managed-fields

如果为 true,在以 JSON 或 YAML 格式打印对象时保留 managedFields。

--subresource string

如果指定,patch 将操作所请求对象的子资源。

--template string

当 -o=go-template, -o=go-template-file 时使用的模板字符串或模板文件路径。模板格式为 golang 模板 [https://golang.ac.cn/pkg/text/template/#pkg-overview]。

--type string     默认值: "strategic"

提供的补丁类型;取值范围:[json merge strategic]

继承的父级选项

--as string

操作时要模拟的用户名。用户可以是普通用户或命名空间中的服务帐号。

--as-group strings

操作时要模拟的用户组,此标志可以重复以指定多个用户组。

--as-uid string

操作时要模拟的 UID。

--cache-dir string     默认值: "$HOME/.kube/cache"

默认缓存目录

--certificate-authority string

证书颁发机构的证书文件路径

--client-certificate string

用于 TLS 的客户端证书文件路径

--client-key string

用于 TLS 的客户端密钥文件路径

--cluster string

要使用的 kubeconfig 集群名称

--context string

要使用的 kubeconfig 上下文名称

--default-not-ready-toleration-seconds int     默认值: 300

指示针对 notReady:NoExecute 的容忍度 (tolerationSeconds),默认添加到每个尚无此类容忍度的 Pod 中。

--default-unreachable-toleration-seconds int     默认值: 300

指示针对 unreachable:NoExecute 的容忍度 (tolerationSeconds),默认添加到每个尚无此类容忍度的 Pod 中。

--disable-compression

如果为 true,所有发送到服务器的请求都不使用响应压缩。

--insecure-skip-tls-verify

如果为 true,将不检查服务器证书的有效性。这将使您的 HTTPS 连接不安全。

--kubeconfig string

用于 CLI 请求的 kubeconfig 文件路径。

--match-server-version

要求服务器版本与客户端版本匹配

-n, --namespace string

如果存在,此 CLI 请求的命名空间范围

--password string

用于 API 服务器基本认证的密码

--profile string     默认值: "none"

要捕获的 profile 名称。取值范围:(none|cpu|heap|goroutine|threadcreate|block|mutex)

--profile-output string     默认值: "profile.pprof"

profile 输出文件名称

--request-timeout string     默认值: "0"

等待单个服务器请求的超时时间。非零值应包含相应的时间单位(例如 1s、2m、3h)。值为零表示请求不超时。

-s, --server string

Kubernetes API 服务器的地址和端口

--storage-driver-buffer-duration duration     默认值: 1m0s

在此持续时间内,存储驱动程序中的写入将被缓冲,并作为一个事务提交到非内存后端。

--storage-driver-db string     默认值: "cadvisor"

数据库名称

--storage-driver-host string     默认值: "localhost:8086"

数据库 host:port

--storage-driver-password string     默认值: "root"

数据库密码

--storage-driver-secure

使用安全连接到数据库

--storage-driver-table string     默认值: "stats"

表名称

--storage-driver-user string     默认值: "root"

数据库用户名

--tls-server-name string

用于服务器证书验证的服务器名称。如果未提供,则使用用于连接服务器的主机名。

--token string

用于向 API 服务器认证的持有者令牌 (Bearer token)

--user string

要使用的 kubeconfig 用户名称

--username string

用于向 API 服务器基本认证的用户名

--version version[=true]

--version, --version=raw 打印版本信息并退出;--version=vX.Y.Z... 设置报告的版本

--warnings-as-errors

将从服务器接收到的警告视为错误,并以非零退出码退出。

参见

  • kubectl - kubectl 是控制 Kubernetes 集群管理器的工具

本页面是自动生成的。

如果您打算报告此页面的问题,请在问题描述中提及此页面是自动生成的。修复可能需要在 Kubernetes 项目中的其他地方进行。

最后修改时间:2025年4月24日 上午8:03 (太平洋标准时间): v1.33 的 kubectl 参考 (80481646c3)