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

NAME

6       kubectl drain - Drain node in preparation for maintenance
7
8
9

SYNOPSIS

11       kubectl drain [OPTIONS]
12
13
14

DESCRIPTION

16       Drain node in preparation for maintenance.
17
18
19       The  given  node  will be marked unschedulable to prevent new pods from
20       arriving.  'drain'  evicts  the  pods   if   the   APIServer   supports
21http://kubernetes.io/docs/admin/disruptions/⟩.  Otherwise, it will use
22       normal DELETE to delete the pods. The 'drain'  evicts  or  deletes  all
23       pods  except  mirror  pods  (which  cannot  be  deleted through the API
24       server).  If there are DaemonSet-managed pods, drain will  not  proceed
25       without --ignore-daemonsets, and regardless it will not delete any Dae‐
26       monSet-managed pods, because those pods would be  immediately  replaced
27       by  the DaemonSet controller, which ignores unschedulable markings.  If
28       there are any pods that are neither mirror pods nor managed by Replica‐
29       tionController,  ReplicaSet,  DaemonSet, StatefulSet or Job, then drain
30       will not delete any pods unless you use  --force.   --force  will  also
31       allow  deletion to proceed if the managing resource of one or more pods
32       is missing.
33
34
35       When you are ready to put the  node  back  into  service,  use  kubectl
36       uncordon, which will make the node schedulable again.
37
38
39       !  ⟨http://kubernetes.io/images/docs/kubectl_drain.svg
40
41
42

OPTIONS

44       --delete-local-data=false
45           Continue  even  if  there  are pods using emptyDir (local data that
46       will be deleted when the node is drained).
47
48
49       --dry-run=false
50           If true, only print the object that would be sent, without  sending
51       it.
52
53
54       --force=false
55           Continue  even  if  there are pods not managed by a ReplicationCon‐
56       troller, ReplicaSet, Job, DaemonSet or StatefulSet.
57
58
59       --grace-period=-1
60           Period of time in seconds given to each  pod  to  terminate  grace‐
61       fully.  If  negative,  the  default  value specified in the pod will be
62       used.
63
64
65       --ignore-daemonsets=false
66           Ignore DaemonSet-managed pods.
67
68
69       --pod-selector=""
70           Label selector to filter pods on the node
71
72
73       -l, --selector=""
74           Selector (label query) to filter on
75
76
77       --timeout=0s
78           The length of time to wait before giving up, zero means infinite
79
80
81

OPTIONS INHERITED FROM PARENT COMMANDS

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

EXAMPLE

359                # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.
360                $ kubectl drain foo --force
361
362                # As above, but abort if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet, and use a grace period of 15 minutes.
363                $ kubectl drain foo --grace-period=900
364
365
366
367

SEE ALSO

369       kubectl(1),
370
371
372

HISTORY

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