1KUBERNETES(1)                      Jan 2015                      KUBERNETES(1)
2
3
4

NAME

6       kubectl  wait  -  Experimental: Wait for a specific condition on one or
7       many resources.
8
9
10

SYNOPSIS

12       kubectl wait [OPTIONS]
13
14
15

DESCRIPTION

17       Experimental: Wait for a specific condition on one or many resources.
18
19
20       The command takes multiple resources and waits until the specified con‐
21       dition is seen in the Status field of every given resource.
22
23
24       Alternatively,  the  command can wait for the given set of resources to
25       be deleted by providing the "delete" keyword as the value to the  --for
26       flag.
27
28
29       A  successful  message  will  be  printed to stdout indicating when the
30       specified condition has been met. One can use -o option  to  change  to
31       output destination.
32
33
34

OPTIONS

36       --all-namespaces=false
37           If  present,  list  the  requested object(s) across all namespaces.
38       Namespace in current context is ignored even if specified with --names‐
39       pace.
40
41
42       --allow-missing-template-keys=true
43           If  true, ignore any errors in templates when a field or map key is
44       missing in the template. Only applies to  golang  and  jsonpath  output
45       formats.
46
47
48       -f, --filename=[]
49           identifying the resource.
50
51
52       --for=""
53           The condition to wait on: [delete|condition=condition-name].
54
55
56       -o, --output=""
57           Output    format.    One   of:   json|yaml|name|go-template|go-tem‐
58       plate-file|template|templatefile|jsonpath|jsonpath-file.
59
60
61       -R, --recursive=true
62           Process the directory used in -f,  --filename  recursively.  Useful
63       when  you  want  to  manage related manifests organized within the same
64       directory.
65
66
67       -l, --selector=""
68           Selector (label query)  to  filter  on,  supports  '=',  '==',  and
69       '!='.(e.g. -l key1=value1,key2=value2)
70
71
72       --template=""
73           Template  string  or  path  to template file to use when -o=go-tem‐
74       plate, -o=go-template-file. The template format is golang  templates  [
75http://golang.org/pkg/text/template/#pkg-overview⟩].
76
77
78       --timeout=30s
79           The length of time to wait before giving up.  Zero means check once
80       and don't wait, negative means wait for a week.
81
82
83

OPTIONS INHERITED FROM PARENT COMMANDS

85       --alsologtostderr=false
86           log to standard error as well as files
87
88
89       --application-metrics-count-limit=100
90           Max number of application metrics to store (per container)
91
92
93       --as=""
94           Username to impersonate for the operation
95
96
97       --as-group=[]
98           Group to impersonate for the operation, this flag can  be  repeated
99       to specify multiple groups.
100
101
102       --azure-container-registry-config=""
103           Path  to the file containing Azure container registry configuration
104       information.
105
106
107       --boot-id-file="/proc/sys/kernel/random/boot_id"
108           Comma-separated list of files to check for boot-id. Use  the  first
109       one that exists.
110
111
112       --cache-dir="/builddir/.kube/http-cache"
113           Default HTTP cache directory
114
115
116       --certificate-authority=""
117           Path to a cert file for the certificate authority
118
119
120       --client-certificate=""
121           Path to a client certificate file for TLS
122
123
124       --client-key=""
125           Path to a client key file for TLS
126
127
128       --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
129           CIDRs opened in GCE firewall for LB traffic proxy  health checks
130
131
132       --cluster=""
133           The name of the kubeconfig cluster to use
134
135
136       --container-hints="/etc/cadvisor/container_hints.json"
137           location of the container hints file
138
139
140       --containerd="unix:///var/run/containerd.sock"
141           containerd endpoint
142
143
144       --context=""
145           The name of the kubeconfig context to use
146
147
148       --default-not-ready-toleration-seconds=300
149           Indicates   the   tolerationSeconds   of   the    toleration    for
150       notReady:NoExecute  that is added by default to every pod that does not
151       already have such a toleration.
152
153
154       --default-unreachable-toleration-seconds=300
155           Indicates the tolerationSeconds  of  the  toleration  for  unreach‐
156       able:NoExecute  that  is  added  by  default to every pod that does not
157       already have such a toleration.
158
159
160       --docker="unix:///var/run/docker.sock"
161           docker endpoint
162
163
164       --docker-env-metadata-whitelist=""
165           a comma-separated list of environment variable keys that  needs  to
166       be collected for docker containers
167
168
169       --docker-only=false
170           Only report docker containers in addition to root stats
171
172
173       --docker-root="/var/lib/docker"
174           DEPRECATED:  docker  root is read from docker info (this is a fall‐
175       back, default: /var/lib/docker)
176
177
178       --docker-tls=false
179           use TLS to connect to docker
180
181
182       --docker-tls-ca="ca.pem"
183           path to trusted CA
184
185
186       --docker-tls-cert="cert.pem"
187           path to client certificate
188
189
190       --docker-tls-key="key.pem"
191           path to private key
192
193
194       --enable-load-reader=false
195           Whether to enable cpu load reader
196
197
198       --event-storage-age-limit="default=0"
199           Max length of time for which to store events (per type). Value is a
200       comma  separated  list  of  key  values, where the keys are event types
201       (e.g.: creation, oom) or "default" and the value is a duration. Default
202       is applied to all non-specified event types
203
204
205       --event-storage-event-limit="default=0"
206           Max  number  of  events to store (per type). Value is a comma sepa‐
207       rated list of key values, where the keys are event  types  (e.g.:  cre‐
208       ation,  oom)  or  "default"  and  the  value  is an integer. Default is
209       applied to all non-specified event types
210
211
212       --global-housekeeping-interval=1m0s
213           Interval between global housekeepings
214
215
216       --housekeeping-interval=10s
217           Interval between container housekeepings
218
219
220       --insecure-skip-tls-verify=false
221           If true, the server's certificate will not be checked for validity.
222       This will make your HTTPS connections insecure
223
224
225       --kubeconfig=""
226           Path to the kubeconfig file to use for CLI requests.
227
228
229       --log-backtrace-at=:0
230           when logging hits line file:N, emit a stack trace
231
232
233       --log-cadvisor-usage=false
234           Whether to log the usage of the cAdvisor container
235
236
237       --log-dir=""
238           If non-empty, write log files in this directory
239
240
241       --log-file=""
242           If non-empty, use this log file
243
244
245       --log-flush-frequency=5s
246           Maximum number of seconds between log flushes
247
248
249       --logtostderr=true
250           log to standard error instead of files
251
252
253       --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
254           Comma-separated  list  of  files  to  check for machine-id. Use the
255       first one that exists.
256
257
258       --match-server-version=false
259           Require server version to match client version
260
261
262       --mesos-agent="127.0.0.1:5051"
263           Mesos agent address
264
265
266       --mesos-agent-timeout=10s
267           Mesos agent timeout
268
269
270       -n, --namespace=""
271           If present, the namespace scope for this CLI request
272
273
274       --password=""
275           Password for basic authentication to the API server
276
277
278       --profile="none"
279           Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
280       create|block|mutex)
281
282
283       --profile-output="profile.pprof"
284           Name of the file to write the profile to
285
286
287       --request-timeout="0"
288           The  length  of  time  to  wait before giving up on a single server
289       request. Non-zero values should contain a corresponding time unit (e.g.
290       1s, 2m, 3h). A value of zero means don't timeout requests.
291
292
293       -s, --server=""
294           The address and port of the Kubernetes API server
295
296
297       --skip-headers=false
298           If true, avoid header prefixes in the log messages
299
300
301       --stderrthreshold=2
302           logs at or above this threshold go to stderr
303
304
305       --storage-driver-buffer-duration=1m0s
306           Writes  in  the  storage driver will be buffered for this duration,
307       and committed to the non memory backends as a single transaction
308
309
310       --storage-driver-db="cadvisor"
311           database name
312
313
314       --storage-driver-host="localhost:8086"
315           database host:port
316
317
318       --storage-driver-password="root"
319           database password
320
321
322       --storage-driver-secure=false
323           use secure connection with database
324
325
326       --storage-driver-table="stats"
327           table name
328
329
330       --storage-driver-user="root"
331           database username
332
333
334       --token=""
335           Bearer token for authentication to the API server
336
337
338       --user=""
339           The name of the kubeconfig user to use
340
341
342       --username=""
343           Username for basic authentication to the API server
344
345
346       -v, --v=0
347           log level for V logs
348
349
350       --version=false
351           Print version information and quit
352
353
354       --vmodule=
355           comma-separated list of pattern=N settings for  file-filtered  log‐
356       ging
357
358
359

EXAMPLE

361                # Wait for the pod "busybox1" to contain the status condition of type "Ready".
362                kubectl wait --for=condition=Ready pod/busybox1
363
364                # Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command.
365                kubectl delete pod/busybox1
366                kubectl wait --for=delete pod/busybox1 --timeout=60s
367
368
369
370

SEE ALSO

372       kubectl(1),
373
374
375

HISTORY

377       January  2015,  Originally compiled by Eric Paris (eparis at redhat dot
378       com) based on the kubernetes source material, but hopefully  they  have
379       been automatically generated since!
380
381
382
383Eric Paris                  kubernetes User Manuals              KUBERNETES(1)
Impressum