kubectl-drain man page
kubectl drain — Drain node in preparation for maintenance
Drain node in preparation for maintenance.
The given node will be marked unschedulable to prevent new pods from arriving. 'drain' evicts the pods if the APIServer supports eviciton ( ⟨http://kubernetes.io/docs/admin/disruptions/⟩). Otherwise, it will use normal DELETE to delete the pods. The 'drain' evicts or deletes all pods except mirror pods (which cannot be deleted through the API server). If there are DaemonSet-managed pods, drain will not proceed without --ignore-daemonsets, and regardless it will not delete any DaemonSet-managed pods, because those pods would be immediately replaced by the DaemonSet controller, which ignores unschedulable markings. If there are any pods that are neither mirror pods nor managed by ReplicationController, ReplicaSet, DaemonSet, StatefulSet or Job, then drain will not delete any pods unless you use --force.
'drain' waits for graceful termination. You should not operate on the machine until the command completes.
When you are ready to put the node back into service, use kubectl uncordon, which will make the node schedulable again.
- Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained).
- Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet.
- 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 DaemonSet-managed pods.
- The length of time to wait before giving up, zero means infinite
Options Inherited from Parent Commands
- Allow a SignatureVerifier to use keys which are technically non-compliant with RFC6962.
- log to standard error as well as files
- DEPRECATED: The API version to use when talking to the server
- Max number of application metrics to store (per container)
- Username to impersonate for the operation
- Path to the file container Azure container registry configuration information.
- Comma-separated list of files to check for boot-id. Use the first one that exists.
- Path to a cert. file for the certificate authority
- Path to a client certificate file for TLS
- Path to a client key file for TLS
- The name of the kubeconfig cluster to use
- location of the container hints file
- The name of the kubeconfig context to use
- docker endpoint
- a comma-separated list of environment variable keys that needs to be collected for docker containers
- Only report docker containers in addition to root stats
- DEPRECATED: docker root is read from docker info (this is a fallback, default: /var/lib/docker)
- Whether to enable cpu load reader
- Max length of time for which to store events (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is a duration. Default is applied to all non-specified event types
- Max number of events to store (per type). Value is a comma separated list of key values, where the keys are event types (e.g.: creation, oom) or "default" and the value is an integer. Default is applied to all non-specified event types
- Interval between global housekeepings
- The Google Cloud Platform Service Account JSON Key to use for authentication.
- Interval between container housekeepings
- If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
- Data source used by InitialResources. Supported options: influxdb, gcm.
- InfluxDB database name which contains metrics required by InitialResources
- Hawkular configuration URL
- Address of InfluxDB which contains metrics required by InitialResources
- Whether the estimation should be made only based on data from the same namespace.
- Password used for connecting to InfluxDB
- Which percentile of samples should InitialResources use when estimating resources. For experiment purposes.
- User used for connecting to InfluxDB
- Path to the kubeconfig file to use for CLI requests.
- when logging hits line file:N, emit a stack trace
- Whether to log the usage of the cAdvisor container
- If non-empty, write log files in this directory
- Log level (0 = DEBUG, 5 = FATAL)
- log to standard error instead of files
- Comma-separated list of files to check for machine-id. Use the first one that exists.
- Require server version to match client version
- -n, --namespace=""
- If present, the namespace scope for this CLI request
- Password for basic authentication to the API server
- 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
- logs at or above this threshold go to stderr
- Writes in the storage driver will be buffered for this duration, and committed to the non memory backends as a single transaction
- database name
- database host:port
- database password
- use secure connection with database
- table name
- database username
- Bearer token for authentication to the API server
- The name of the kubeconfig user to use
- Username for basic authentication to the API server
- -v, --v=0
- log level for V logs
- comma-separated list of pattern=N settings for file-filtered logging
# Drain node "foo", even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet on it.
$ kubectl drain foo --force
# 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.
$ kubectl drain foo --grace-period=900
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!