kubectl wait

概要

实验特性: 等待一个或多个资源达到特定条件。

该命令接受多个资源,并等待所有给定资源的 Status 字段中出现指定的条件。

另外,也可以通过为 --for 参数提供 "create" 或 "delete" 关键字,来等待给定资源集被创建或删除。

成功消息将被打印到标准输出,指示何时满足了指定的条件。你可以使用 -o 选项改变输出目的地。

kubectl wait ([-f FILENAME] | resource.group/resource.name | resource.group [(-l label | --all)]) [--for=create|--for=delete|--for condition=available|--for=jsonpath='{}'[=value]]

示例

  # Wait for the pod "busybox1" to contain the status condition of type "Ready"
  kubectl wait --for=condition=Ready pod/busybox1
  
  # The default value of status condition is true; you can wait for other targets after an equal delimiter (compared after Unicode simple case folding, which is a more general form of case-insensitivity)
  kubectl wait --for=condition=Ready=false pod/busybox1
  
  # Wait for the pod "busybox1" to contain the status phase to be "Running"
  kubectl wait --for=jsonpath='{.status.phase}'=Running pod/busybox1
  
  # Wait for pod "busybox1" to be Ready
  kubectl wait --for='jsonpath={.status.conditions[?(@.type=="Ready")].status}=True' pod/busybox1
  
  # Wait for the service "loadbalancer" to have ingress
  kubectl wait --for=jsonpath='{.status.loadBalancer.ingress}' service/loadbalancer
  
  # Wait for the secret "busybox1" to be created, with a timeout of 30s
  kubectl create secret generic busybox1
  kubectl wait --for=create secret/busybox1 --timeout=30s
  
  # Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command
  kubectl delete pod/busybox1
  kubectl wait --for=delete pod/busybox1 --timeout=60s

选项

--all

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

-A, --all-namespaces

如果存在,则列出所有命名空间中的所请求对象。即使使用 --namespace 指定了命名空间,当前上下文中的命名空间也会被忽略。

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

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

--field-selector string

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

-f, --filename strings

用于标识资源。

--for string

等待的条件:[create|delete|condition=condition-name[=condition-value]|jsonpath='{JSONPath 表达式}'=[JSONPath 值]]。默认 condition-value 为 true。条件值在经过 Unicode 简单大小写折叠(一种更通用的不区分大小写形式)后进行比较。

-h, --help

wait 命令的帮助信息

--local

如果为 true,注解(annotation)将不会联系 API 服务器,而是在本地运行。

-o, --output string

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

-R, --recursive     默认值: true

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

-l, --selector string

用于过滤的选择器(标签查询),支持 '=', '==', 和 '!='(例如 -l key1=value1,key2=value2)

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

--timeout duration     默认值: 30s

放弃等待的时间长度。零表示检查一次后不等待,负值表示等待一周。

继承的父选项

--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 的容忍时间(tolerationSeconds),默认添加到所有没有此容忍的 Pod 中。

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

指示对 unreachable:NoExecute 的容忍时间(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 项目的其他地方进行。

最后修改时间:2024 年 12 月 12 日下午 2:44 PST:更新 kubectl 参考 v1.32 (5c2cfa02af)