1KUBERNETES(1) Jan 2015 KUBERNETES(1)
2
6 kubectl drain - Drain node in preparation for maintenance
7
11 kubectl drain [OPTIONS]
12
16 Drain node in preparation for maintenance.
17 The given node will be marked unschedulable to prevent new pods from
20 arriving. 'drain' evicts the pods if the APIServer support‐
21 shttp://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 When you are ready to put the node back into service, use kubectl
36 uncordon, which will make the node schedulable again.
37 ⟨http://kubernetes.io/images/docs/kubectl_drain.svg⟩
40
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 --dry-run=false
50 If true, only print the object that would be sent, without sending
51 it.
52 --force=false
55 Continue even if there are pods not managed by a ReplicationCon‐
56 troller, ReplicaSet, Job, DaemonSet or StatefulSet.
57 --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 --ignore-daemonsets=false
66 Ignore DaemonSet-managed pods.
67 --pod-selector=""
70 Label selector to filter pods on the node
71 -l, --selector=""
74 Selector (label query) to filter on
75 --timeout=0s
78 The length of time to wait before giving up, zero means infinite
79
83 --alsologtostderr=false
84 log to standard error as well as files
85 --application-metrics-count-limit=100
88 Max number of application metrics to store (per container)
89 --as=""
92 Username to impersonate for the operation
93 --as-group=[]
96 Group to impersonate for the operation, this flag can be repeated
97 to specify multiple groups.
98 --azure-container-registry-config=""
101 Path to the file containing Azure container registry configuration
102 information.
103 --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 --cache-dir="/builddir/.kube/http-cache"
111 Default HTTP cache directory
112 --certificate-authority=""
115 Path to a cert file for the certificate authority
116 --client-certificate=""
119 Path to a client certificate file for TLS
120 --client-key=""
123 Path to a client key file for TLS
124 --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 --cluster=""
131 The name of the kubeconfig cluster to use
132 --container-hints="/etc/cadvisor/container_hints.json"
135 location of the container hints file
136 --containerd="/run/containerd/containerd.sock"
139 containerd endpoint
140 --containerd-namespace="k8s.io"
143 containerd namespace
144 --context=""
147 The name of the kubeconfig context to use
148 --default-not-ready-toleration-seconds=300
151 Indicates the tolerationSeconds of the toleration for
152 notReady:NoExecute that is added by default to every pod that does not
153 already have such a toleration.
154 --default-unreachable-toleration-seconds=300
157 Indicates the tolerationSeconds of the toleration for unreach‐
158 able:NoExecute that is added by default to every pod that does not
159 already have such a toleration.
160 --docker="unix:///var/run/docker.sock"
163 docker endpoint
164 --docker-env-metadata-whitelist=""
167 a comma-separated list of environment variable keys that needs to
168 be collected for docker containers
169 --docker-only=false
172 Only report docker containers in addition to root stats
173 --docker-root="/var/lib/docker"
176 DEPRECATED: docker root is read from docker info (this is a fall‐
177 back, default: /var/lib/docker)
178 --docker-tls=false
181 use TLS to connect to docker
182 --docker-tls-ca="ca.pem"
185 path to trusted CA
186 --docker-tls-cert="cert.pem"
189 path to client certificate
190 --docker-tls-key="key.pem"
193 path to private key
194 --enable-load-reader=false
197 Whether to enable cpu load reader
198 --event-storage-age-limit="default=0"
201 Max length of time for which to store events (per type). Value is a
202 comma separated list of key values, where the keys are event types
203 (e.g.: creation, oom) or "default" and the value is a duration. Default
204 is applied to all non-specified event types
205 --event-storage-event-limit="default=0"
208 Max number of events to store (per type). Value is a comma sepa‐
209 rated list of key values, where the keys are event types (e.g.: cre‐
210 ation, oom) or "default" and the value is an integer. Default is
211 applied to all non-specified event types
212 --global-housekeeping-interval=1m0s
215 Interval between global housekeepings
216 --housekeeping-interval=10s
219 Interval between container housekeepings
220 --insecure-skip-tls-verify=false
223 If true, the server's certificate will not be checked for validity.
224 This will make your HTTPS connections insecure
225 --kubeconfig=""
228 Path to the kubeconfig file to use for CLI requests.
229 --log-backtrace-at=:0
232 when logging hits line file:N, emit a stack trace
233 --log-cadvisor-usage=false
236 Whether to log the usage of the cAdvisor container
237 --log-dir=""
240 If non-empty, write log files in this directory
241 --log-file=""
244 If non-empty, use this log file
245 --log-file-max-size=1800
248 Defines the maximum size a log file can grow to. Unit is megabytes.
249 If the value is 0, the maximum file size is unlimited.
250 --log-flush-frequency=5s
253 Maximum number of seconds between log flushes
254 --logtostderr=true
257 log to standard error instead of files
258 --machine-id-file="/etc/machine-id,/var/lib/dbus/machine-id"
261 Comma-separated list of files to check for machine-id. Use the
262 first one that exists.
263 --match-server-version=false
266 Require server version to match client version
267 -n, --namespace=""
270 If present, the namespace scope for this CLI request
271 --password=""
274 Password for basic authentication to the API server
275 --profile="none"
278 Name of profile to capture. One of (none|cpu|heap|goroutine|thread‐
279 create|block|mutex)
280 --profile-output="profile.pprof"
283 Name of the file to write the profile to
284 --request-timeout="0"
287 The length of time to wait before giving up on a single server
288 request. Non-zero values should contain a corresponding time unit (e.g.
289 1s, 2m, 3h). A value of zero means don't timeout requests.
290 -s, --server=""
293 The address and port of the Kubernetes API server
294 --skip-headers=false
297 If true, avoid header prefixes in the log messages
298 --skip-log-headers=false
301 If true, avoid headers when opening log files
302 --stderrthreshold=2
305 logs at or above this threshold go to stderr
306 --storage-driver-buffer-duration=1m0s
309 Writes in the storage driver will be buffered for this duration,
310 and committed to the non memory backends as a single transaction
311 --storage-driver-db="cadvisor"
314 database name
315 --storage-driver-host="localhost:8086"
318 database host:port
319 --storage-driver-password="root"
322 database password
323 --storage-driver-secure=false
326 use secure connection with database
327 --storage-driver-table="stats"
330 table name
331 --storage-driver-user="root"
334 database username
335 --token=""
338 Bearer token for authentication to the API server
339 --update-machine-info-interval=5m0s
342 Interval between machine info updates.
343 --user=""
346 The name of the kubeconfig user to use
347 --username=""
350 Username for basic authentication to the API server
351 -v, --v=0
354 number for the log level verbosity
355 --version=false
358 Print version information and quit
359 --vmodule=
362 comma-separated list of pattern=N settings for file-filtered log‐
363 ging
364
368 # Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.
369 $ kubectl drain foo --force
370 # 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.
372 $ kubectl drain foo --grace-period=900
373
378 kubectl(1),
379
383 January 2015, Originally compiled by Eric Paris (eparis at redhat dot
384 com) based on the kubernetes source material, but hopefully they have
385 been automatically generated since!
386Eric Paris kubernetes User Manuals KUBERNETES(1)
