Documentation
¶
Overview ¶
Package lifecycle contains handlers for pod lifecycle events and interfaces to integrate with kubelet admission, synchronization, and eviction of pods.
Index ¶
- func NewHandlerRunner(httpGetter kubetypes.HTTPGetter, commandRunner kubecontainer.CommandRunner, ...) kubecontainer.HandlerRunner
- type AdmissionFailureHandler
- type AdmissionFailureHandlerStub
- type InsufficientResourceError
- type PodAdmitAttributes
- type PodAdmitHandler
- type PodAdmitHandlers
- type PodAdmitResult
- type PodAdmitTarget
- type PodLifecycleTarget
- type PodSyncHandler
- type PodSyncHandlers
- type PodSyncLoopHandler
- type PodSyncLoopHandlers
- type PodSyncLoopTarget
- type PodSyncTarget
- type PredicateFailureError
- type PredicateFailureReason
- type ShouldEvictResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewHandlerRunner ¶
func NewHandlerRunner(httpGetter kubetypes.HTTPGetter, commandRunner kubecontainer.CommandRunner, containerManager podStatusProvider) kubecontainer.HandlerRunner
NewHandlerRunner returns a configured lifecycle handler for a container.
Types ¶
type AdmissionFailureHandler ¶ added in v1.6.0
type AdmissionFailureHandler interface {
HandleAdmissionFailure(admitPod *v1.Pod, failureReasons []PredicateFailureReason) ([]PredicateFailureReason, error)
}
AdmissionFailureHandler is an interface which defines how to deal with a failure to admit a pod. This allows for the graceful handling of pod admission failure.
type AdmissionFailureHandlerStub ¶ added in v1.6.0
type AdmissionFailureHandlerStub struct{}
AdmissionFailureHandlerStub is an AdmissionFailureHandler that does not perform any handling of admission failure. It simply passes the failure on.
func NewAdmissionFailureHandlerStub ¶ added in v1.6.0
func NewAdmissionFailureHandlerStub() *AdmissionFailureHandlerStub
NewAdmissionFailureHandlerStub returns an instance of AdmissionFailureHandlerStub.
func (*AdmissionFailureHandlerStub) HandleAdmissionFailure ¶ added in v1.6.0
func (n *AdmissionFailureHandlerStub) HandleAdmissionFailure(admitPod *v1.Pod, failureReasons []PredicateFailureReason) ([]PredicateFailureReason, error)
HandleAdmissionFailure simply passes admission rejection on, with no special handling.
type InsufficientResourceError ¶ added in v1.18.0
type InsufficientResourceError struct {
ResourceName v1.ResourceName
Requested int64
Used int64
Capacity int64
}
InsufficientResourceError is an error type that indicates what kind of resource limit is hit and caused the unfitting failure.
func (*InsufficientResourceError) Error ¶ added in v1.18.0
func (e *InsufficientResourceError) Error() string
func (*InsufficientResourceError) GetInsufficientAmount ¶ added in v1.18.0
func (e *InsufficientResourceError) GetInsufficientAmount() int64
GetInsufficientAmount returns the amount of the insufficient resource of the error.
func (*InsufficientResourceError) GetReason ¶ added in v1.18.0
func (e *InsufficientResourceError) GetReason() string
GetReason returns the reason of the InsufficientResourceError.
type PodAdmitAttributes ¶ added in v1.3.0
type PodAdmitAttributes struct {
// the pod to evaluate for admission
Pod *v1.Pod
// all pods bound to the kubelet excluding the pod being evaluated
OtherPods []*v1.Pod
}
PodAdmitAttributes is the context for a pod admission decision. The member fields of this struct should never be mutated.
type PodAdmitHandler ¶ added in v1.3.0
type PodAdmitHandler interface {
// Admit evaluates if a pod can be admitted.
Admit(attrs *PodAdmitAttributes) PodAdmitResult
}
PodAdmitHandler is notified during pod admission.
func NewAppArmorAdmitHandler ¶ added in v1.4.0
func NewAppArmorAdmitHandler(validator apparmor.Validator) PodAdmitHandler
NewAppArmorAdmitHandler returns a PodAdmitHandler which is used to evaluate if a pod can be admitted from the perspective of AppArmor.
func NewPredicateAdmitHandler ¶ added in v1.5.0
func NewPredicateAdmitHandler(getNodeAnyWayFunc getNodeAnyWayFuncType, admissionFailureHandler AdmissionFailureHandler, pluginResourceUpdateFunc pluginResourceUpdateFuncType) PodAdmitHandler
NewPredicateAdmitHandler returns a PodAdmitHandler which is used to evaluates if a pod can be admitted from the perspective of predicates.
type PodAdmitHandlers ¶ added in v1.3.0
type PodAdmitHandlers []PodAdmitHandler
PodAdmitHandlers maintains a list of handlers to pod admission.
func (*PodAdmitHandlers) AddPodAdmitHandler ¶ added in v1.3.0
func (handlers *PodAdmitHandlers) AddPodAdmitHandler(a PodAdmitHandler)
AddPodAdmitHandler adds the specified observer.
type PodAdmitResult ¶ added in v1.3.0
type PodAdmitResult struct {
// if true, the pod should be admitted.
Admit bool
// a brief single-word reason why the pod could not be admitted.
Reason string
// a brief message explaining why the pod could not be admitted.
Message string
}
PodAdmitResult provides the result of a pod admission decision.
type PodAdmitTarget ¶ added in v1.3.0
type PodAdmitTarget interface {
// AddPodAdmitHandler adds the specified handler.
AddPodAdmitHandler(a PodAdmitHandler)
}
PodAdmitTarget maintains a list of handlers to invoke.
type PodLifecycleTarget ¶ added in v1.3.0
type PodLifecycleTarget interface {
PodAdmitTarget
PodSyncLoopTarget
PodSyncTarget
}
PodLifecycleTarget groups a set of lifecycle interfaces for convenience.
type PodSyncHandler ¶ added in v1.3.0
type PodSyncHandler interface {
// ShouldEvict is invoked during each sync pod operation to determine
// if the pod should be evicted from the kubelet. If so, the pod status
// is updated to mark its phase as failed with the provided reason and message,
// and the pod is immediately killed.
// This operation must return immediately as its called for each sync pod.
// The provided pod should never be modified.
ShouldEvict(pod *v1.Pod) ShouldEvictResponse
}
PodSyncHandler is invoked during each sync pod operation.
type PodSyncHandlers ¶ added in v1.3.0
type PodSyncHandlers []PodSyncHandler
PodSyncHandlers maintains a list of handlers to pod sync.
func (*PodSyncHandlers) AddPodSyncHandler ¶ added in v1.3.0
func (handlers *PodSyncHandlers) AddPodSyncHandler(a PodSyncHandler)
AddPodSyncHandler adds the specified handler.
type PodSyncLoopHandler ¶ added in v1.3.0
type PodSyncLoopHandler interface {
// ShouldSync returns true if the pod needs to be synced.
// This operation must return immediately as its called for each pod.
// The provided pod should never be modified.
ShouldSync(pod *v1.Pod) bool
}
PodSyncLoopHandler is invoked during each sync loop iteration.
type PodSyncLoopHandlers ¶ added in v1.3.0
type PodSyncLoopHandlers []PodSyncLoopHandler
PodSyncLoopHandlers maintains a list of handlers to pod sync loop.
func (*PodSyncLoopHandlers) AddPodSyncLoopHandler ¶ added in v1.3.0
func (handlers *PodSyncLoopHandlers) AddPodSyncLoopHandler(a PodSyncLoopHandler)
AddPodSyncLoopHandler adds the specified observer.
type PodSyncLoopTarget ¶ added in v1.3.0
type PodSyncLoopTarget interface {
// AddPodSyncLoopHandler adds the specified handler.
AddPodSyncLoopHandler(a PodSyncLoopHandler)
}
PodSyncLoopTarget maintains a list of handlers to pod sync loop.
type PodSyncTarget ¶ added in v1.3.0
type PodSyncTarget interface {
// AddPodSyncHandler adds the specified handler
AddPodSyncHandler(a PodSyncHandler)
}
PodSyncTarget maintains a list of handlers to pod sync.
type PredicateFailureError ¶ added in v1.18.0
PredicateFailureError describes a failure error of predicate.
func (*PredicateFailureError) Error ¶ added in v1.18.0
func (e *PredicateFailureError) Error() string
func (*PredicateFailureError) GetReason ¶ added in v1.18.0
func (e *PredicateFailureError) GetReason() string
GetReason returns the reason of the PredicateFailureError.
type PredicateFailureReason ¶ added in v1.18.0
type PredicateFailureReason interface {
GetReason() string
}
PredicateFailureReason interface represents the failure reason of a predicate.
type ShouldEvictResponse ¶ added in v1.3.0
type ShouldEvictResponse struct {
// if true, the pod should be evicted.
Evict bool
// a brief CamelCase reason why the pod should be evicted.
Reason string
// a brief message why the pod should be evicted.
Message string
}
ShouldEvictResponse provides the result of a should evict request.