kubectl wait

kubectl wait

简介

实验特性：等待一个或多个资源到达特定状态。

此命令接受多个资源作为输入，并等待直到在每个给定资源的状态字段中看到所指定的状况。
此外，这一命令可以通过提供 “delete” 关键字作为 —for 标志的值来等待给定的一组资源被删除。
当指定条件被满足时，命令将向 stdout 打印一条成功消息。你可以使用 -o 选项更改输出目标。

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

示例

# 等待 Pod "busybox1" 包含 "Ready" 类型的状况值
kubectl wait --for=condition=Ready pod/busybox1
# 状态状况的默认值为真；可以在等号分隔符后给出其他等待目标（用 Unicode 大小写折叠形式转换之后执行比较，这是更通用的大小写不敏感形式）
kubectl wait --for=condition=Ready=false pod/busybox1
# 等待 Pod "busybox1" 的状态阶段包含 "Running"
kubectl wait --for=jsonpath='{.status.phase}'=Running pod/busybox1
# 等待 Pod "busybox1" 状况变为 Ready
kubectl wait --for='jsonpath={.status.conditions[?(@.type=="Ready")].status}=True' pod/busybox1
# 等待 Service "loadbalancer" 具备入站规则
kubectl wait --for=jsonpath='{.status.loadBalancer.ingress}' service/loadbalancer
# 发出 "delete" 命令后，等待 Pod "busybox1" 被删除，超时时间为 60 秒
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
	等待的条件：[delete\|condition=condition-name[=condition-value]\|jsonpath=’{JSONPath expression}’=[JSONPath value]]。默认的状况值为 true。在执行 Unicode 大小写折叠之后比较条件值，这是更通用的不区分大小写形式。
-h, —help
	关于 wait 的帮助信息。
—local
	如果为 true，则注解不会与 api-server 通信，而是在本地运行。
-o, —output string
	输出格式。可选值为： json、yaml、name、go-template、go-template-file、template、templatefile、jsonpath、jsonpath-as-json、jsonpath-file。
-R, —recursive
	递归处理在 -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 模板 [http://golang.org/pkg/text/template/#pkg-overview]。
—timeout duration 默认值：30s
	放弃前等待的时间长度。0 表示检查一次，不等待，负数表示等待一周。

—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”
	要记录的性能分析信息。可选值为（none\|cpu\|heap\|goroutine\|threadcreate\|block\|mutex）。
—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”
	数据库 host:port
—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 服务器进行身份验证的持有者令牌。
—user string
	要使用的 kubeconfig 用户的名称。
—username string
	向 API 服务器进行基本身份验证时所用的用户名。
—version version[=true]
	—version, —version=raw 打印版本信息并退出；—version=vX.Y.Z… 设置报告的版本。
—warnings-as-errors
	将从服务器收到的警告视为错误，并以非零退出码退出。

另请参见

kubectl - kubectl 控制 Kubernetes 集群管理器