参考文档

APIs 和 CLIs 的设计文档,概念定义以及引用

编辑这个页面

kubectl annotate

更新某个资源的注解

摘要

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

注解是一个键值对,它可以包含比label更多的信息,并且可能是机读数据。 注解用来存储那些辅助的,非区分性的信息,特别是那些为外部工具或系统扩展插件使用的数据。 如果--overwrite设为true,将会覆盖现有的注解,否则试图修改一个注解的值将会抛出错误。 如果设置了--resource-version,那么将会使用指定的这个版本,否则将使用当前版本。

支持的资源包括但不限于(大小写不限): pod (po), service (svc), replicationcontroller (rc), node (no), event (ev), componentstatuse (cs), limitrange (limits), persistentvolume (pv), persistentvolumeclaim (pvc), horizontalpodautoscaler (hpa), resourcequota (quota), secret

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

示例

# 更新pod “foo”,设置其注解'description'的值为'my frontend'。
# 如果同一个注解被赋值了多次,只保存最后一次设置的值。
kubectl annotate pods foo description='my frontend'

# 更新“pod.json”文件中 type 和 name 字段指定的 pod 的注解。
kubectl annotate -f pod.json description='my frontend'

# 更新pod “foo”,设置其注解'description'的值为'my frontend running nginx',已有的值将被覆盖。
kubectl annotate --overwrite pods foo description='my frontend running nginx'

# 更新同一'namespace'下所有的pod。
kubectl annotate pods --all description='my frontend running nginx'

# 仅当pod “foo”当前版本为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.
# 更新pod “foo”,如果存在的话将删除其注解'description'。
# 不需要`--override`选项。
kubectl annotate pods foo description-

选项

      --all[=false]: 选择namespace中所有指定类型的资源。
  -f, --filename=[]: 用来指定待升级资源的文件名,目录名或者URL。
      --include-extended-apis[=true]: If true, include definitions of new APIs via calls to the API server. [default true]
      --no-headers[=false]: 当使用默认输出格式时不打印标题栏。
  -o, --output="": 输出格式。一下任意一种:json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... 参见 golang template [http://golang.org/pkg/text/template/#pkg-overview] 和 jsonpath template [http://releases.k8s.io/release-1.2/docs/user-guide/jsonpath.md].
      --output-version="": 输出指定版本格式的对象 (例如: 'extensions/v1beta1').
      --overwrite[=false]: 如果设置为true,允许覆盖更新注解,否则拒绝更新已存在的注解。
      --record[=false]: 在资源注释中记录当前 kubectl 命令。
  -R, --recursive[=false]: Process the directory used in -f, --filename recursively. Useful when you want to manage related manifests organized within the same directory.
      --resource-version="": 如果不为空,仅当资源当前版本和指定版本相同时才能更新注解。仅当更新单个资源时有效。
  -l, --selector="": 刷选标签。
  -a, --show-all[=false]: 打印时,显示所有资源(默认隐藏已终止的 Pod)
      --show-labels[=false]: 打印时,在最后一列显示所有标签(默认隐藏标签栏)
      --sort-by="": 非空时,按照这个字段的规定排序。该字段需要设置为 JSONPath 表达式 (例如:'{.metadata.name}'),在 JSONPath 表达式中指定 API 资源领域时,必须使用整数或者字符串。
      --template="": 当 -o=go-template, -o=go-template-file 时需要设置为模板字符串或者模板文件路径, 模板格式是 golang templates [http://golang.org/pkg/text/template/#pkg-overview].

继承自父命令的选项

      --alsologtostderr[=false]: 同时输出日志到标准错误控制台和文件。
      --certificate-authority="": 用以进行认证授权的.cert文件路径。
      --client-certificate="": TLS使用的客户端证书路径。
      --client-key="": TLS使用的客户端密钥路径。
      --cluster="": 指定使用的kubeconfig配置文件中的集群名。
      --context="": 指定使用的kubeconfig配置文件中的环境名。
      --insecure-skip-tls-verify[=false]: 如果为true,将不会检查服务器凭证的有效性,这会导致你的HTTPS链接变得不安全。
      --kubeconfig="": 命令行请求使用的配置文件路径。
      --log-backtrace-at=:0: 当日志长度超过定义的行数时,忽略堆栈信息。
      --log-dir="": 如果不为空,将日志文件写入此目录。
      --log-flush-frequency=5s: 刷新日志的最大时间间隔。
      --logtostderr[=true]: 输出日志到标准错误控制台,不输出到文件。
      --match-server-version[=false]: 要求服务端和客户端版本匹配。
      --namespace="": 如果不为空,命令将使用此namespace。
      --password="": API Server进行简单认证使用的密码。
  -s, --server="": Kubernetes API Server的地址和端口号。
      --stderrthreshold=2: 高于此级别的日志将被输出到错误控制台。
      --token="": 认证到API Server使用的令牌。
      --user="": 指定使用的kubeconfig配置文件中的用户名。
      --username="": API Server进行简单认证使用的用户名。
      --v=0: 指定输出日志的级别。
      --vmodule=: 指定输出日志的模块,格式如下:pattern=N,使用逗号分隔。

参见

Analytics