k8sutil

Documentation

Index

• Variables
• func DeleteNodeAnnotations(nc v1core.NodeInterface, node string, ks []string) error
• func DeleteNodeLabels(nc v1core.NodeInterface, node string, ks []string) error
• func GetClient(path string) (*kubernetes.Clientset, error)
• func NodeAnnotationCondition(selector fields.Selector) watch.ConditionFunc
• func RetryOnConflict(backoff wait.Backoff, fn func() error) error
• func SetNodeAnnotations(nc v1core.NodeInterface, node string, m map[string]string) error
• func SetNodeAnnotationsLabels(nc v1core.NodeInterface, node string, a, l map[string]string) error
• func SetNodeLabels(nc v1core.NodeInterface, node string, m map[string]string) error
• func Unschedulable(nc v1core.NodeInterface, node string, sched bool) error
• func UpdateNodeRetry(nc v1core.NodeInterface, node string, f func(*v1api.Node)) error

Variables

var DefaultBackoff = wait.Backoff{
	Steps:    4,
	Duration: 10 * time.Millisecond,
	Factor:   5.0,
	Jitter:   0.1,
}

DefaultBackoff is the recommended backoff for a conflict where a client may be attempting to make an unrelated modification to a resource under active management by one or more controllers.

var DefaultRetry = wait.Backoff{
	Steps:    5,
	Duration: 10 * time.Millisecond,
	Factor:   1.0,
	Jitter:   0.1,
}

DefaultRetry is the recommended retry for a conflict where multiple clients are making changes to the same resource.

Functions

func DeleteNodeAnnotations

func DeleteNodeAnnotations(nc v1core.NodeInterface, node string, ks []string) error

DeleteNodeAnnotations deletes all annotations with keys in ks

func DeleteNodeLabels

func DeleteNodeLabels(nc v1core.NodeInterface, node string, ks []string) error

DeleteNodeLabels deletes all keys in ks

func GetClient

func GetClient(path string) (*kubernetes.Clientset, error)

GetClient returns a Kubernetes client (clientset) from the kubeconfig path or from the in-cluster service account environment.

func NodeAnnotationCondition

func NodeAnnotationCondition(selector fields.Selector) watch.ConditionFunc

NodeAnnotationCondition returns a condition function that succeeds when a node being watched has an annotation of key equal to value.

func RetryOnConflict

func RetryOnConflict(backoff wait.Backoff, fn func() error) error

RetryConflict executes the provided function repeatedly, retrying if the server returns a conflicting write. Callers should preserve previous executions if they wish to retry changes. It performs an exponential backoff.

var pod *api.Pod
err := RetryOnConflict(DefaultBackoff, func() (err error) {
  pod, err = c.Pods("mynamespace").UpdateStatus(podStatus)
  return
})
if err != nil {
  // may be conflict if max retries were hit
  return err
}
...

TODO: Make Backoff an interface?

func SetNodeAnnotations

func SetNodeAnnotations(nc v1core.NodeInterface, node string, m map[string]string) error

SetNodeAnnotations sets all keys in m to their respective values in node's annotations.

func SetNodeAnnotationsLabels

func SetNodeAnnotationsLabels(nc v1core.NodeInterface, node string, a, l map[string]string) error

SetNodeAnnotationsLabels sets all keys in a and l to their values in node's annotations and labels, respectively

func SetNodeLabels

func SetNodeLabels(nc v1core.NodeInterface, node string, m map[string]string) error

SetNodeLabels sets all keys in m to their respective values in node's labels.

func Unschedulable

func Unschedulable(nc v1core.NodeInterface, node string, sched bool) error

Unschedulable marks node as schedulable or unschedulable according to sched.

func UpdateNodeRetry

func UpdateNodeRetry(nc v1core.NodeInterface, node string, f func(*v1api.Node)) error

UpdateNodeRetry calls f to update a node object in Kubernetes. It will attempt to update the node by applying f to it up to DefaultBackoff number of times. f will be called each time since the node object will likely have changed if a retry is necessary.