README
¶
NOTE: The types and methods in this directory have been deprecated and will be removed in a future release.
The code in this directory has been copied from: github.com/kubernetes/kubectl/pkg/drain@a17d91f9f5b34c73bed0bfc75b70bd762b725231
Documentation
¶
Index ¶
- Constants
- func CheckEvictionSupport(clientset kubernetes.Interface) (string, error)
- func RunCordonOrUncordon(ctx context.Context, drainer *Helper, node *corev1.Node, desired bool) error
- func RunNodeDrain(ctx context.Context, drainer *Helper, nodeName string) error
- type CordonHelper
- type Helper
- func (d *Helper) DeleteOrEvictPods(ctx context.Context, pods []corev1.Pod) error
- func (d *Helper) DeletePod(ctx context.Context, pod corev1.Pod) error
- func (d *Helper) EvictPod(ctx context.Context, pod corev1.Pod, policyGroupVersion string) error
- func (d *Helper) GetPodsForDeletion(ctx context.Context, nodeName string) (*podDeleteList, []error)
Constants ¶
const ( // EvictionKind represents the kind of evictions object EvictionKind = "Eviction" // EvictionSubresource represents the kind of evictions object as pod's subresource EvictionSubresource = "pods/eviction" )
Variables ¶
This section is empty.
Functions ¶
func CheckEvictionSupport ¶
func CheckEvictionSupport(clientset kubernetes.Interface) (string, error)
CheckEvictionSupport uses Discovery API to find out if the server support eviction subresource If support, it will return its groupVersion; Otherwise, it will return an empty string
func RunCordonOrUncordon ¶
func RunCordonOrUncordon(ctx context.Context, drainer *Helper, node *corev1.Node, desired bool) error
RunCordonOrUncordon demonstrates the canonical way to cordon or uncordon a Node Deprecated: This method has been deprecated in favor of using the same method from the upstream kubectl codebase.
func RunNodeDrain ¶
RunNodeDrain shows the canonical way to drain a node. You should first cordon the node, e.g. using RunCordonOrUncordon Deprecated: This method has been deprecated in favor of using the same method from the upstream kubectl codebase.
Types ¶
type CordonHelper ¶
type CordonHelper struct {
// contains filtered or unexported fields
}
CordonHelper wraps functionality to cordon/uncordon nodes
func NewCordonHelper ¶
func NewCordonHelper(node *corev1.Node) *CordonHelper
NewCordonHelper returns a new CordonHelper
func NewCordonHelperFromRuntimeObject ¶
func NewCordonHelperFromRuntimeObject(nodeObject runtime.Object, scheme *runtime.Scheme, gvk schema.GroupVersionKind) (*CordonHelper, error)
NewCordonHelperFromRuntimeObject returns a new CordonHelper, or an error if given object is not a node or cannot be encoded as JSON.
func (*CordonHelper) PatchOrReplace ¶
func (c *CordonHelper) PatchOrReplace(ctx context.Context, clientset kubernetes.Interface) (error, error)
PatchOrReplace uses given clientset to update the node status, either by patching or updating the given node object; it may return error if the object cannot be encoded as JSON, or if either patch or update calls fail; it will also return a second error whenever creating a patch has failed.
func (*CordonHelper) UpdateIfRequired ¶
func (c *CordonHelper) UpdateIfRequired(desired bool) bool
UpdateIfRequired returns true if c.node.Spec.Unschedulable isn't already set, or false when no change is needed.
type Helper ¶
type Helper struct {
Ctx context.Context
Client kubernetes.Interface
Force bool
GracePeriodSeconds int
IgnoreAllDaemonSets bool
Timeout time.Duration
DeleteLocalData bool
Selector string
PodSelector string
// DisableEviction forces drain to use delete rather than evict
DisableEviction bool
// SkipWaitForDeleteTimeoutSeconds ignores pods that have a
// DeletionTimeStamp > N seconds. It's up to the user to decide when this
// option is appropriate; examples include the Node is unready and the pods
// won't drain otherwise
SkipWaitForDeleteTimeoutSeconds int
Out io.Writer
ErrOut io.Writer
// TODO(justinsb): unnecessary?
DryRun bool
// OnPodDeletedOrEvicted is called when a pod is evicted/deleted; for printing progress output
OnPodDeletedOrEvicted func(pod *corev1.Pod, usingEviction bool)
}
Helper contains the parameters to control the behaviour of drainer Deprecated: This has been deprecated in favor of using the same type from the upstream kubectl codebase.
func (*Helper) DeleteOrEvictPods ¶
DeleteOrEvictPods deletes or evicts the pods on the api server
func (*Helper) GetPodsForDeletion ¶
GetPodsForDeletion receives resource info for a node, and returns those pods as PodDeleteList, or error if it cannot list pods. All pods that are ready to be deleted can be obtained with .Pods(), and string with all warning can be obtained with .Warnings(), and .Errors() for all errors that occurred during deletion.
Source Files