pod

Documentation

Index

• func FilterPods(podList *corev1.PodList, predicates ...PodPredicate) *corev1.PodList
• func GetPodList(c client.Client, n *corev1.Node, filters []PodPredicate) (*corev1.PodList, error)
• type DeleteResult
  • func DeletePods(c client.Client, logger logr.Logger, pl *corev1.PodList, ...) (*DeleteResult, error)
• type PodPredicate
• type RemoveFinalizersResult
  • func RemoveFinalizersFromPod(c client.Client, logger logr.Logger, pl *corev1.PodList) (*RemoveFinalizersResult, error)

Functions

func FilterPods

func FilterPods(podList *corev1.PodList, predicates ...PodPredicate) *corev1.PodList

FilterPods filters a podList and returns a PodList matching the predicates

func GetPodList

func GetPodList(c client.Client, n *corev1.Node, filters []PodPredicate) (*corev1.PodList, error)

Get pod list on a given node matching pod predicate

Types

type DeleteResult

type DeleteResult struct {
	Message              string
	NumMarkedForDeletion int
}

DeleteResult holds fields describing the result of a pod deletion

func DeletePods

func DeletePods(c client.Client, logger logr.Logger, pl *corev1.PodList, ignoreAlreadyDeleting bool, options ...client.DeleteOption) (*DeleteResult, error)

DeletePods attempts to delete a given PodList and returns a DeleteResult and error

type PodPredicate

type PodPredicate func(corev1.Pod) bool

PodPredicate is a predicate function for a given Pod

type RemoveFinalizersResult

type RemoveFinalizersResult struct {
	Message    string
	NumRemoved int
}

RemoveFinalizersResult is a type that describes the result of removing a finalizer

func RemoveFinalizersFromPod

func RemoveFinalizersFromPod(c client.Client, logger logr.Logger, pl *corev1.PodList) (*RemoveFinalizersResult, error)

RemoveFinalizersFromPod attempts to remove the finalizers from a given PodList and returns a RemoveFinalizersResult and error