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，当模板中缺少字段或 map 键时，忽略模板中的任何错误。仅适用于 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，annotate 将不联系 api-server，而是在本地运行。 | |
| -o, --output string | |
输出格式。可以是以下之一：(json, yaml, 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。 | |
| --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 的容忍度 (toleration) 的容忍秒数 (tolerationSeconds)，默认添加到每个尚未拥有此类容忍度的 Pod 中。 | |
| --default-unreachable-toleration-seconds int 默认值: 300 | |
指示针对 unreachable:NoExecute 的容忍度 (toleration) 的容忍秒数 (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" | |
数据库主机:端口 | |
| --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 项目的其他地方进行。