kubectl label

概要

更新资源的标签。

  • 标签的键和值必须以字母或数字开头，可以包含字母、数字、连字符、点和下划线，每个最多 63 个字符。
  • 键可以选择以 DNS 子域前缀和单个 '/' 开头，例如 example.com/my-app。
  • 如果 --overwrite 为 true，则现有标签可以被覆盖，否则尝试覆盖标签将导致错误。
  • 如果指定了 --resource-version，则更新将使用此资源版本，否则将使用现有资源版本。
kubectl label [--overwrite] (-f FILENAME | TYPE NAME) KEY_1=VAL_1 ... KEY_N=VAL_N [--resource-version=version]

示例

  # Update pod 'foo' with the label 'unhealthy' and the value 'true'
  kubectl label pods foo unhealthy=true
  
  # Update pod 'foo' with the label 'status' and the value 'unhealthy', overwriting any existing value
  kubectl label --overwrite pods foo status=unhealthy
  
  # Update all pods in the namespace
  kubectl label pods --all status=unhealthy
  
  # Update a pod identified by the type and name in "pod.json"
  kubectl label -f pod.json status=unhealthy
  
  # Update pod 'foo' only if the resource is unchanged from version 1
  kubectl label pods foo status=unhealthy --resource-version=1
  
  # Update pod 'foo' by removing a label named 'bar' if it exists
  # Does not require the --overwrite flag
  kubectl label pods foo bar-

选项

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

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

--field-selector string

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

-f, --filename strings

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

-h, --help

label 命令的帮助信息

-k, --kustomize string

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

--list

如果为 true，则显示给定资源的标签。

--local

如果为 true，则 label 命令不会联系 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 中使用的目录。当你想管理组织在同一目录中的相关 manifest 文件时很有用。

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

指示默认添加到每个尚未拥有此类容忍度的 Pod 中的 notReady:NoExecute 容忍度的 tolerationSeconds。

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

指示默认添加到每个尚未拥有此类容忍度的 Pod 中的 unreachable:NoExecute 容忍度的 tolerationSeconds。

--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 项目的其他地方进行。

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