KubectlDrainSettings Class

Summary

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 supportshttp://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. --force will also allow deletion to proceed if the managing resource of one or more pods is missing. '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. http://kubernetes.io/images/docs/kubectl_drain.svg
Assembly
Cake.Kubectl.dll
Namespace
Cake.Kubectl
Base Types
graph BT Type-->Base0["AutoToolSettings"] click Base0 "/api/Cake.Kubectl/AutoToolSettings" Base0-->Base1["ToolSettings"] Type["KubectlDrainSettings"] class Type type-node

Syntax

public sealed class KubectlDrainSettings : AutoToolSettings

Examples

# 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

Attributes

Type Description
CompilerGeneratedAttribute

Constructors

Name Summary
KubectlDrainSettings()

Properties

Name Value Summary
DeleteLocalData Nullable<bool>
--delete-local-data Continue even if there are pods using emptyDir (local data that will be deleted when the node is drained).
DryRun Nullable<bool>
--dry-run If true, only print the object that would be sent, without sending it.
Force Nullable<bool>
--force Continue even if there are pods not managed by a ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet.
GracePeriod Nullable<int>
--grace-period Period of time in seconds given to each pod to terminate gracefully. If negative, the default value specified in the pod will be used.
IgnoreDaemonsets Nullable<bool>
--ignore-daemonsets Ignore DaemonSet-managed pods.
PodSelector string
--pod-selector Label selector to filter pods on the node
Selector string
-l, --selector Selector (label query) to filter on
Timeout string
--timeout The length of time to wait before giving up, zero means infinite

Extension Methods

Name Value Summary
Dump<KubectlDrainSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<KubectlDrainSettings>(KubectlDrainSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<KubectlDrainSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<KubectlDrainSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<KubectlDrainSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<KubectlDrainSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin