kubectl patch

概要

使用策略性合并补丁、JSON 合并补丁或 JSON 补丁更新资源的字段。

接受 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 将操作所请求对象的子资源。必须是以下之一 [status scale]。此标志处于 beta 阶段,将来可能会更改。

--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 的客户端密钥文件的路径

--cloud-provider-gce-l7lb-src-cidrs cidrs     默认值: 130.211.0.0/22,35.191.0.0/16

在 GCE 防火墙中为 L7 LB 流量代理和健康检查打开的 CIDR

--cloud-provider-gce-lb-src-cidrs cidrs     默认值: 130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16

在 GCE 防火墙中为 L4 LB 流量代理和健康检查打开的 CIDR

--cluster string

要使用的 kubeconfig 集群的名称

--context string

要使用的 kubeconfig 上下文的名称

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

指示默认添加到每个没有此类容忍度的 Pod 的 notReady:NoExecute 容忍度的容忍度秒数。

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

指示默认添加到每个没有此类容忍度的 Pod 的 unreachable:NoExecute 容忍度的容忍度秒数。

--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"

要捕获的配置文件名称。以下之一 (none|cpu|heap|goroutine|threadcreate|block|mutex)

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

要写入配置文件的名称

--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"

数据库主机:端口

--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 服务器的身份验证的令牌

--user string

要使用的 kubeconfig 用户的名称

--username string

用于 API 服务器的基本身份验证的用户名

--version version[=true]

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

--warnings-as-errors

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

另请参阅

  • kubectl - kubectl 控制 Kubernetes 集群管理器

此页面是自动生成的。

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

最后修改时间 2024 年 4 月 18 日,下午 6:36 PST:更新 kubectl 参考以匹配 v1.30 (a6ccd20be9)