kubectl annotate

概要

更新一个或多个资源的注释。

所有 Kubernetes 对象都支持将额外数据作为注释存储在对象中。注释是键/值对，可以大于标签，并包含任意字符串值，例如结构化的 JSON。工具和系统扩展可以使用注释来存储他们自己的数据。

除非设置了 --overwrite，否则尝试设置已存在的注释将失败。如果指定了 --resource-version 并且与服务器上的当前资源版本不匹配，则命令将失败。

使用“kubectl api-resources”获取支持的资源的完整列表。

kubectl annotate [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

示例

  # Update pod 'foo' with the annotation 'description' and the value 'my frontend'
  # If the same annotation is set multiple times, only the last value will be applied
  kubectl annotate pods foo description='my frontend'
  
  # Update a pod identified by type and name in "pod.json"
  kubectl annotate -f pod.json description='my frontend'
  
  # Update pod 'foo' with the annotation 'description' and the value 'my frontend running nginx', overwriting any existing value
  kubectl annotate --overwrite pods foo description='my frontend running nginx'
  
  # Update all pods in the namespace
  kubectl annotate pods --all description='my frontend running nginx'
  
  # Update pod 'foo' only if the resource is unchanged from version 1
  kubectl annotate pods foo description='my frontend running nginx' --resource-version=1
  
  # Update pod 'foo' by removing an annotation named 'description' if it exists
  # Does not require the --overwrite flag
  kubectl annotate pods foo description-

选项

--all

选择指定资源类型命名空间中的所有资源。

-A, --all-namespaces

如果为 true，则在所有命名空间中检查指定的动作。

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

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

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

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

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

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

--field-selector string

选择器（字段查询）用于过滤，支持 '=', '==', 和 '!='。（例如 --field-selector key1=value1,key2=value2）。服务器仅支持每种类型有限数量的字段查询。

-f, --filename strings

文件名、目录或 URL，指向标识要更新注释的资源的的文件

-h, --help

annotate 的帮助信息

-k, --kustomize string

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

--list

如果为 true，则显示给定资源的注释。

--local

如果为 true，则注释将不会联系 api-server，而是在本地运行。

-o, --output string

输出格式。可以是: (json, yaml, kyaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file)。

--overwrite

如果为 true，则允许覆盖注释，否则拒绝更新覆盖现有注释的注释。

-R, --recursive

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

--resource-version string

如果非空，则只有当这是对象的当前资源版本时，注释更新才会成功。仅在指定单个资源时有效。

-l, --selector string

选择器（标签查询）用于过滤，支持 '=', '==', '!=', 'in', 'notin'。(例如 -l key1=value1,key2=value2,key3 in (value3))。匹配的对象必须满足所有指定的标签约束。

--show-managed-fields

如果为 true，则在 JSON 或 YAML 格式中打印对象时保留 managedFields。

--template string

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

继承的父选项

--as string

用于执行操作的用户名。用户可以是命名空间中的普通用户或服务帐户。

--as-group strings

用于执行操作的组，可以重复此标志以指定多个组。

--as-uid string

用于执行操作的 UID。

--as-user-extra strings

要模拟的操作的用户附加信息，可以重复此标志以指定同一键的多个值。

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

默认缓存目录

--certificate-authority string

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

--client-certificate string

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

--client-key string

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

--cluster string

要使用的 kubeconfig 集群的名称

--context string

要使用的 kubeconfig 上下文的名称

--disable-compression

如果为 true，则选择退出对服务器的所有请求的响应压缩

--insecure-skip-tls-verify

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

--kubeconfig string

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

--kuberc string

要使用的 kuberc 文件的路径。可以通过导出 KUBECTL_KUBERC=false 功能门或关闭 KUBERC=off 功能来禁用此功能。

--match-server-version

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

-n, --namespace string

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

--password string

用于与 API 服务器进行基本身份验证的密码

--profile string     默认值： "none"

要捕获的配置文件的名称。可以是 (none|cpu|heap|goroutine|threadcreate|block|mutex|trace)

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

--user string

要使用的 kubeconfig 用户名

--username string

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

--version version[=true]

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

--warnings-as-errors

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

参见

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

本页面是自动生成的。

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

上次修改时间为 2025 年 12 月 21 日下午 5:18 PST：更新 kubectl 参考至 v1.35 (fd1e78a94a)