1KUBERNETES(1)(kubernetes) KUBERNETES(1)(kubernetes)
2Eric Paris Jan 2015
6
9 kubectl wait - Experimental: Wait for a specific condition on one or
10 many resources.
11
15 kubectl wait [OPTIONS]
16
20 Experimental: Wait for a specific condition on one or many resources.
21 The command takes multiple resources and waits until the specified con‐
24 dition is seen in the Status field of every given resource.
25 Alternatively, the command can wait for the given set of resources to
28 be deleted by providing the "delete" keyword as the value to the --for
29 flag.
30 A successful message will be printed to stdout indicating when the
33 specified condition has been met. One can use -o option to change to
34 output destination.
35
39 --all=false Select all resources in the namespace of the specified
40 resource types
41 -A, --all-namespaces=false If present, list the requested ob‐
44 ject(s) across all namespaces. Namespace in current context is ignored
45 even if specified with --namespace.
46 --allow-missing-template-keys=true If true, ignore any errors in
49 templates when a field or map key is missing in the template. Only ap‐
50 plies to golang and jsonpath output formats.
51 --field-selector="" Selector (field query) to filter on, supports
54 '=', '==', and '!='.(e.g. --field-selector key1=value1,key2=value2).
55 The server only supports a limited number of field queries per type.
56 -f, --filename=[] identifying the resource.
59 --for="" The condition to wait on: [delete|condition=condi‐
62 tion-name].
63 --local=false If true, annotation will NOT contact api-server but
66 run locally.
67 -o, --output="" Output format. One of: json|yaml|name|go-tem‐
70 plate|go-template-file|template|templatefile|jsonpath|json‐
71 path-as-json|jsonpath-file.
72 -R, --recursive=true Process the directory used in -f, --filename
75 recursively. Useful when you want to manage related manifests organized
76 within the same directory.
77 -l, --selector="" Selector (label query) to filter on, supports
80 '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)
81 --template="" Template string or path to template file to use when
84 -o=go-template, -o=go-template-file. The template format is golang tem‐
85 plates [http://golang.org/pkg/text/template/#pkg-overview].
86 --timeout=30s The length of time to wait before giving up. Zero
89 means check once and don't wait, negative means wait for a week.
90
94 --add-dir-header=false If true, adds the file directory to the
95 header of the log messages
96 --alsologtostderr=false log to standard error as well as files
99 --application-metrics-count-limit=100 Max number of application
102 metrics to store (per container)
103 --as="" Username to impersonate for the operation
106 --as-group=[] Group to impersonate for the operation, this flag
109 can be repeated to specify multiple groups.
110 --azure-container-registry-config="" Path to the file containing
113 Azure container registry configuration information.
114 --boot-id-file="/proc/sys/kernel/random/boot_id" Comma-separated
117 list of files to check for boot-id. Use the first one that exists.
118 --cache-dir="/builddir/.kube/cache" Default cache directory
121 --certificate-authority="" Path to a cert file for the certificate
124 authority
125 --client-certificate="" Path to a client certificate file for TLS
128 --client-key="" Path to a client key file for TLS
131 --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
134 CIDRs opened in GCE firewall for L7 LB traffic proxy health
135 checks
136 --cloud-provider-gce-lb-src-cidrs=130.211.0.0/22,209.85.152.0/22,209.85.204.0/22,35.191.0.0/16
139 CIDRs opened in GCE firewall for L4 LB traffic proxy health
140 checks
141 --cluster="" The name of the kubeconfig cluster to use
144 --container-hints="/etc/cadvisor/container_hints.json" location of
147 the container hints file
148 --containerd="/run/containerd/containerd.sock" containerd endpoint
151 --containerd-namespace="k8s.io" containerd namespace
154 --context="" The name of the kubeconfig context to use
157 --default-not-ready-toleration-seconds=300 Indicates the tolera‐
160 tionSeconds of the toleration for notReady:NoExecute that is added by
161 default to every pod that does not already have such a toleration.
162 --default-unreachable-toleration-seconds=300 Indicates the tolera‐
165 tionSeconds of the toleration for unreachable:NoExecute that is added
166 by default to every pod that does not already have such a toleration.
167 --disable-root-cgroup-stats=false Disable collecting root Cgroup
170 stats
171 --docker="unix:///var/run/docker.sock" docker endpoint
174 --docker-env-metadata-whitelist="" a comma-separated list of envi‐
177 ronment variable keys matched with specified prefix that needs to be
178 collected for docker containers
179 --docker-only=false Only report docker containers in addition to
182 root stats
183 --docker-root="/var/lib/docker" DEPRECATED: docker root is read
186 from docker info (this is a fallback, default: /var/lib/docker)
187 --docker-tls=false use TLS to connect to docker
190 --docker-tls-ca="ca.pem" path to trusted CA
193 --docker-tls-cert="cert.pem" path to client certificate
196 --docker-tls-key="key.pem" path to private key
199 --enable-load-reader=false Whether to enable cpu load reader
202 --event-storage-age-limit="default=0" Max length of time for which
205 to store events (per type). Value is a comma separated list of key val‐
206 ues, where the keys are event types (e.g.: creation, oom) or "default"
207 and the value is a duration. Default is applied to all non-specified
208 event types
209 --event-storage-event-limit="default=0" Max number of events to
212 store (per type). Value is a comma separated list of key values, where
213 the keys are event types (e.g.: creation, oom) or "default" and the
214 value is an integer. Default is applied to all non-specified event
215 types
216 --global-housekeeping-interval=1m0s Interval between global house‐
219 keepings
220 --housekeeping-interval=10s Interval between container housekeep‐
223 ings
224 --insecure-skip-tls-verify=false If true, the server's certificate
227 will not be checked for validity. This will make your HTTPS connections
228 insecure
229 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
232 quests.
233 --log-backtrace-at=:0 when logging hits line file:N, emit a stack
236 trace
237 --log-cadvisor-usage=false Whether to log the usage of the cAdvi‐
240 sor container
241 --log-dir="" If non-empty, write log files in this directory
244 --log-file="" If non-empty, use this log file
247 --log-file-max-size=1800 Defines the maximum size a log file can
250 grow to. Unit is megabytes. If the value is 0, the maximum file size is
251 unlimited.
252 --log-flush-frequency=5s Maximum number of seconds between log
255 flushes
256 --logtostderr=true log to standard error instead of files
259 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
262 Comma-separated list of files to check for machine-id. Use the
263 first one that exists.
264 --match-server-version=false Require server version to match
267 client version
268 -n, --namespace="" If present, the namespace scope for this CLI
271 request
272 --one-output=false If true, only write logs to their native sever‐
275 ity level (vs also writing to each lower severity level
276 --password="" Password for basic authentication to the API server
279 --profile="none" Name of profile to capture. One of
282 (none|cpu|heap|goroutine|threadcreate|block|mutex)
283 --profile-output="profile.pprof" Name of the file to write the
286 profile to
287 --referenced-reset-interval=0 Reset interval for referenced bytes
290 (container_referenced_bytes metric), number of measurement cycles after
291 which referenced bytes are cleared, if set to 0 referenced bytes are
292 never cleared (default: 0)
293 --request-timeout="0" The length of time to wait before giving up
296 on a single server request. Non-zero values should contain a corre‐
297 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
298 out requests.
299 -s, --server="" The address and port of the Kubernetes API server
302 --skip-headers=false If true, avoid header prefixes in the log
305 messages
306 --skip-log-headers=false If true, avoid headers when opening log
309 files
310 --stderrthreshold=2 logs at or above this threshold go to stderr
313 --storage-driver-buffer-duration=1m0s Writes in the storage driver
316 will be buffered for this duration, and committed to the non memory
317 backends as a single transaction
318 --storage-driver-db="cadvisor" database name
321 --storage-driver-host="localhost:8086" database host:port
324 --storage-driver-password="root" database password
327 --storage-driver-secure=false use secure connection with database
330 --storage-driver-table="stats" table name
333 --storage-driver-user="root" database username
336 --tls-server-name="" Server name to use for server certificate
339 validation. If it is not provided, the hostname used to contact the
340 server is used
341 --token="" Bearer token for authentication to the API server
344 --update-machine-info-interval=5m0s Interval between machine info
347 updates.
348 --user="" The name of the kubeconfig user to use
351 --username="" Username for basic authentication to the API server
354 -v, --v=0 number for the log level verbosity
357 --version=false Print version information and quit
360 --vmodule= comma-separated list of pattern=N settings for
363 file-filtered logging
364 --warnings-as-errors=false Treat warnings received from the server
367 as errors and exit with a non-zero exit code
368
372 # Wait for the pod "busybox1" to contain the status condition of type "Ready".
373 kubectl wait --for=condition=Ready pod/busybox1
374 # Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command.
376 kubectl delete pod/busybox1
377 kubectl wait --for=delete pod/busybox1 --timeout=60s
378
383 kubectl(1),
384
388 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
389 com) based on the kubernetes source material, but hopefully they have
390 been automatically generated since!
391Manuals User KUBERNETES(1)(kubernetes)