KUBERNETES(1)(kubernetes)

💖 kubectl drain — KUBERNETES(1)(kubernetes) 💖

okay bestie, welcome to the kubernetes manual, section 1. grab a strawberry, sit down, and let's drain a node together 🍓✨

---

✨ NAME ✨

kubectl drain — drain node in preparation for maintenance 🧹👑

---

🦋 SYNOPSIS 🦋

kubectl drain [OPTIONS]

---

🌸 DESCRIPTION 🌸

Drain node in preparation for maintenance. It's giving "please leave the party, we're renovating." 🏠💅

The given node will be marked unschedulable so no new pods can arrive. drain evicts the pods if the API server supports eviction — that's this whole thing right here: https://kubernetes.io/docs/concepts/workloads/pods/disruptions/ eviction https://kubernetes.io/docs/concepts/workloads/pods/disruptions/. Otherwise it just uses a normal DELETE to delete the pods. Either way, no cap.

So drain evicts or deletes all pods except mirror pods — and mirror pods literally cannot be deleted through the API server, so don't even try, it's not happening 🙈.

If there are daemon set-managed pods, drain will not proceed without --ignore-daemonsets. And regardless of that flag, it will not delete any daemon set-managed pods, because those pods would be immediately replaced by the daemon set controller, which straight-up ignores unschedulable markings. It said "unschedulable? never heard of her." 💀

If there are any pods that are neither mirror pods nor managed by a replication controller, replica set, daemon set, stateful set, or job, then drain will not delete any pods unless you use --force. And --force will also allow deletion to proceed if the managing resource of one or more pods is missing. main character flag energy 👑

drain waits for graceful termination. You should not operate on the machine until the command completes. fr fr, just wait.

When you're ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again. welcome back babe 🫶

https://kubernetes.io/images/docs/kubectl_drain.svg Workflow https://kubernetes.io/images/docs/kubectl_drain.svg

---

🎀 OPTIONS 🎀

• --chunk-size=500 — Return large lists in chunks rather than all at once. Pass 0 to disable. tiny bites only 🍰
• --delete-emptydir-data=false — Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained). lowkey this deletes your stuff, just so you know 😭
• --disable-eviction=false — Force drain to use delete, even if eviction is supported. This will bypass checking PodDisruptionBudgets, use with caution. ⚠️
• --dry-run="none" — Must be "none", "server", or "client". If client strategy, only print the object that would be sent, without sending it. If server strategy, submit server-side request without persisting the resource. a little dress rehearsal 🎭
• --force=false — Continue even if there are pods that do not declare a controller. 💪
• --grace-period=-1 — Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used. ⏳
• --ignore-daemonsets=false — Ignore DaemonSet-managed pods. 🙈
• --pod-selector="" — Label selector to filter pods on the node
• -l, --selector="" — Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'. (e.g. -l key1=value1,key2=value2,key3 in (value3)). Matching objects must satisfy all of the specified label constraints. ✨
• --skip-wait-for-delete-timeout=0 — If pod DeletionTimestamp older than N seconds, skip waiting for the pod. Seconds must be greater than 0 to skip.
• --timeout=0s — The length of time to wait before giving up, zero means infinite. time is a construct anyway ⏰

---

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

• --as="" — Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
• --as-group=[] — Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
• --as-uid="" — UID to impersonate for the operation.
• --as-user-extra=[] — User extras to impersonate for the operation, this flag can be repeated to specify multiple values for the same key.
• --cache-dir="/home/username/.kube/cache" — Default cache directory
• --certificate-authority="" — Path to a cert file for the certificate authority
• --client-certificate="" — Path to a client certificate file for TLS
• --client-key="" — Path to a client key file for TLS
• --cluster="" — The name of the kubeconfig cluster to use
• --context="" — The name of the kubeconfig context to use
• --disable-compression=false — If true, opt-out of response compression for all requests to the server
• --insecure-skip-tls-verify=false — If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. 🚨 bestie this is literally the opposite of safe
• --kubeconfig="" — Path to the kubeconfig file to use for CLI requests.
• --kuberc="" — Path to the kuberc file to use for preferences. This can be disabled by exporting KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.
• --match-server-version=false — Require server version to match client version
• -n, --namespace="" — If present, the namespace scope for this CLI request
• --password="" — Password for basic authentication to the API server
• --profile="none" — Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex|trace)
• --profile-output="profile.pprof" — Name of the file to write the profile to
• --proxy-url="" — Proxy URL to use for requests to the API server
• --request-timeout="0" — The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.
• -s, --server="" — The address and port of the Kubernetes API server
• --tls-server-name="" — Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
• --token="" — Bearer token for authentication to the API server
• --user="" — The name of the kubeconfig user to use
• --username="" — Username for basic authentication to the API server
• --version=false — --version, --version=raw prints version information and quits; --version=vX.Y.Z... sets the reported version
• --warnings-as-errors=false — Treat warnings received from the server as errors and exit with a non-zero exit code

---

⭐ EXAMPLE ⭐

  # Drain node "foo", even if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set on it
  kubectl drain foo --force

  # As above, but abort if there are pods not managed by a replication controller, replica set, job, daemon set, or stateful set, and use a grace period of 15 minutes
  kubectl drain foo --grace-period=900

---

🔥 SEE ALSO 🔥

kubectl(1), — go read that one too, it's the parent 🫶

---

💜 HISTORY 💜

January 2015, Originally compiled by Eric Paris (eparis at redhat dot com) based on the kubernetes source material, but hopefully they have been automatically generated since! iconic origin story honestly 👑

---

that's the whole thing bestie, you ate 💅✨ this page came to you from Manuals, version User, KUBERNETES(1)(kubernetes), dated January 2015, originally compiled by Eric Paris. slay, bye 🎀🦋