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]. The default status value of condition-name is true, you can
63 set false with condition=condition-name=false
64 --local=false If true, annotation will NOT contact api-server but
67 run locally.
68 -o, --output="" Output format. One of: json|yaml|name|go-tem‐
71 plate|go-template-file|template|templatefile|jsonpath|json‐
72 path-as-json|jsonpath-file.
73 -R, --recursive=true Process the directory used in -f, --filename
76 recursively. Useful when you want to manage related manifests organized
77 within the same directory.
78 -l, --selector="" Selector (label query) to filter on, supports
81 '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)
82 --show-managed-fields=false If true, keep the managedFields when
85 printing objects in JSON or YAML format.
86 --template="" Template string or path to template file to use when
89 -o=go-template, -o=go-template-file. The template format is golang tem‐
90 plates [http://golang.org/pkg/text/template/#pkg-overview].
91 --timeout=30s The length of time to wait before giving up. Zero
94 means check once and don't wait, negative means wait for a week.
95
99 --add-dir-header=false If true, adds the file directory to the
100 header of the log messages
101 --alsologtostderr=false log to standard error as well as files
104 --application-metrics-count-limit=100 Max number of application
107 metrics to store (per container)
108 --as="" Username to impersonate for the operation
111 --as-group=[] Group to impersonate for the operation, this flag
114 can be repeated to specify multiple groups.
115 --azure-container-registry-config="" Path to the file containing
118 Azure container registry configuration information.
119 --boot-id-file="/proc/sys/kernel/random/boot_id" Comma-separated
122 list of files to check for boot-id. Use the first one that exists.
123 --cache-dir="/builddir/.kube/cache" Default cache directory
126 --certificate-authority="" Path to a cert file for the certificate
129 authority
130 --client-certificate="" Path to a client certificate file for TLS
133 --client-key="" Path to a client key file for TLS
136 --cloud-provider-gce-l7lb-src-cidrs=130.211.0.0/22,35.191.0.0/16
139 CIDRs opened in GCE firewall for L7 LB traffic proxy health
140 checks
141 --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
144 CIDRs opened in GCE firewall for L4 LB traffic proxy health
145 checks
146 --cluster="" The name of the kubeconfig cluster to use
149 --container-hints="/etc/cadvisor/container_hints.json" location of
152 the container hints file
153 --containerd="/run/containerd/containerd.sock" containerd endpoint
156 --containerd-namespace="k8s.io" containerd namespace
159 --context="" The name of the kubeconfig context to use
162 --default-not-ready-toleration-seconds=300 Indicates the tolera‐
165 tionSeconds of the toleration for notReady:NoExecute that is added by
166 default to every pod that does not already have such a toleration.
167 --default-unreachable-toleration-seconds=300 Indicates the tolera‐
170 tionSeconds of the toleration for unreachable:NoExecute that is added
171 by default to every pod that does not already have such a toleration.
172 --disable-root-cgroup-stats=false Disable collecting root Cgroup
175 stats
176 --docker="unix:///var/run/docker.sock" docker endpoint
179 --docker-env-metadata-whitelist="" a comma-separated list of envi‐
182 ronment variable keys matched with specified prefix that needs to be
183 collected for docker containers
184 --docker-only=false Only report docker containers in addition to
187 root stats
188 --docker-root="/var/lib/docker" DEPRECATED: docker root is read
191 from docker info (this is a fallback, default: /var/lib/docker)
192 --docker-tls=false use TLS to connect to docker
195 --docker-tls-ca="ca.pem" path to trusted CA
198 --docker-tls-cert="cert.pem" path to client certificate
201 --docker-tls-key="key.pem" path to private key
204 --enable-load-reader=false Whether to enable cpu load reader
207 --event-storage-age-limit="default=0" Max length of time for which
210 to store events (per type). Value is a comma separated list of key val‐
211 ues, where the keys are event types (e.g.: creation, oom) or "default"
212 and the value is a duration. Default is applied to all non-specified
213 event types
214 --event-storage-event-limit="default=0" Max number of events to
217 store (per type). Value is a comma separated list of key values, where
218 the keys are event types (e.g.: creation, oom) or "default" and the
219 value is an integer. Default is applied to all non-specified event
220 types
221 --global-housekeeping-interval=1m0s Interval between global house‐
224 keepings
225 --housekeeping-interval=10s Interval between container housekeep‐
228 ings
229 --insecure-skip-tls-verify=false If true, the server's certificate
232 will not be checked for validity. This will make your HTTPS connections
233 insecure
234 --kubeconfig="" Path to the kubeconfig file to use for CLI re‐
237 quests.
238 --log-backtrace-at=:0 when logging hits line file:N, emit a stack
241 trace
242 --log-cadvisor-usage=false Whether to log the usage of the cAdvi‐
245 sor container
246 --log-dir="" If non-empty, write log files in this directory
249 --log-file="" If non-empty, use this log file
252 --log-file-max-size=1800 Defines the maximum size a log file can
255 grow to. Unit is megabytes. If the value is 0, the maximum file size is
256 unlimited.
257 --log-flush-frequency=5s Maximum number of seconds between log
260 flushes
261 --logtostderr=true log to standard error instead of files
264 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
267 Comma-separated list of files to check for machine-id. Use the
268 first one that exists.
269 --match-server-version=false Require server version to match
272 client version
273 -n, --namespace="" If present, the namespace scope for this CLI
276 request
277 --one-output=false If true, only write logs to their native sever‐
280 ity level (vs also writing to each lower severity level)
281 --password="" Password for basic authentication to the API server
284 --profile="none" Name of profile to capture. One of
287 (none|cpu|heap|goroutine|threadcreate|block|mutex)
288 --profile-output="profile.pprof" Name of the file to write the
291 profile to
292 --referenced-reset-interval=0 Reset interval for referenced bytes
295 (container_referenced_bytes metric), number of measurement cycles after
296 which referenced bytes are cleared, if set to 0 referenced bytes are
297 never cleared (default: 0)
298 --request-timeout="0" The length of time to wait before giving up
301 on a single server request. Non-zero values should contain a corre‐
302 sponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't time‐
303 out requests.
304 -s, --server="" The address and port of the Kubernetes API server
307 --skip-headers=false If true, avoid header prefixes in the log
310 messages
311 --skip-log-headers=false If true, avoid headers when opening log
314 files
315 --stderrthreshold=2 logs at or above this threshold go to stderr
318 --storage-driver-buffer-duration=1m0s Writes in the storage driver
321 will be buffered for this duration, and committed to the non memory
322 backends as a single transaction
323 --storage-driver-db="cadvisor" database name
326 --storage-driver-host="localhost:8086" database host:port
329 --storage-driver-password="root" database password
332 --storage-driver-secure=false use secure connection with database
335 --storage-driver-table="stats" table name
338 --storage-driver-user="root" database username
341 --tls-server-name="" Server name to use for server certificate
344 validation. If it is not provided, the hostname used to contact the
345 server is used
346 --token="" Bearer token for authentication to the API server
349 --update-machine-info-interval=5m0s Interval between machine info
352 updates.
353 --user="" The name of the kubeconfig user to use
356 --username="" Username for basic authentication to the API server
359 -v, --v=0 number for the log level verbosity
362 --version=false Print version information and quit
365 --vmodule= comma-separated list of pattern=N settings for
368 file-filtered logging
369 --warnings-as-errors=false Treat warnings received from the server
372 as errors and exit with a non-zero exit code
373
377 # Wait for the pod "busybox1" to contain the status condition of type "Ready".
378 kubectl wait --for=condition=Ready pod/busybox1
379 # The default value of status condition is true, you can set false.
381 kubectl wait --for=condition=Ready=false pod/busybox1
382 # Wait for the pod "busybox1" to be deleted, with a timeout of 60s, after having issued the "delete" command.
384 kubectl delete pod/busybox1
385 kubectl wait --for=delete pod/busybox1 --timeout=60s
386
391 kubectl(1),
392
396 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
397 com) based on the kubernetes source material, but hopefully they have
398 been automatically generated since!
399Manuals User KUBERNETES(1)(kubernetes)