backoff

Documentation

Index

• func ComposeResourceKey(o k8s.Resource) string
• func GetComputeResourceAndQuantityRequested(err error) v1.ResourceList
• func IsBackoffError(err error) bool
• func IsResourceQuotaExceeded(err error) bool
• type AtomicTime
  • func NewAtomicTime(t time.Time) AtomicTime
  • func (a *AtomicTime) Load() time.Time
  • func (a *AtomicTime) Store(t time.Time)
• type ComputeResourceAwareBackOffHandler
  • func (h *ComputeResourceAwareBackOffHandler) Handle(ctx context.Context, operation func() error, ...) error
  • func (h *ComputeResourceAwareBackOffHandler) IsActive() bool
• type ComputeResourceCeilings
• type Controller
  • func NewController(ctx context.Context) *Controller
  • func (m *Controller) GetBackOffHandler(key string) (*ComputeResourceAwareBackOffHandler, bool)
  • func (m *Controller) GetOrCreateHandler(ctx context.Context, key string, backOffBaseSecond int, ...) *ComputeResourceAwareBackOffHandler
• type HandlerMap
  • func (m *HandlerMap) Get(key string) (*ComputeResourceAwareBackOffHandler, bool)
  • func (m *HandlerMap) Set(key string, value *ComputeResourceAwareBackOffHandler)
• type SimpleBackOffBlocker

Functions

func ComposeResourceKey

func ComposeResourceKey(o k8s.Resource) string

func GetComputeResourceAndQuantityRequested

func GetComputeResourceAndQuantityRequested(err error) v1.ResourceList

func IsBackoffError

func IsBackoffError(err error) bool

func IsResourceQuotaExceeded

func IsResourceQuotaExceeded(err error) bool

Types

type AtomicTime

type AtomicTime struct {
	// contains filtered or unexported fields
}

AtomicTime represents an atomic.Value that stores time.Time.

func NewAtomicTime

func NewAtomicTime(t time.Time) AtomicTime

Creates a new Atomic time.Time

func (*AtomicTime) Load

func (a *AtomicTime) Load() time.Time

Loads the underlying time.Time.

func (*AtomicTime) Store

func (a *AtomicTime) Store(t time.Time)

Stores time.Time to the underlying atomic.Value

type ComputeResourceAwareBackOffHandler

type ComputeResourceAwareBackOffHandler struct {
	*SimpleBackOffBlocker
	*ComputeResourceCeilings
}

ComputeResourceAwareBackOffHandler is an exponential back-off handler that also keeps track of the resource ceilings of the operations that are blocked or failed due to resource insufficiency

func (*ComputeResourceAwareBackOffHandler) Handle

func (h *ComputeResourceAwareBackOffHandler) Handle(ctx context.Context, operation func() error, requestedResourceList v1.ResourceList) error

Act based on current backoff interval and set the next one accordingly

func (*ComputeResourceAwareBackOffHandler) IsActive

func (h *ComputeResourceAwareBackOffHandler) IsActive() bool

type ComputeResourceCeilings

type ComputeResourceCeilings struct {
	// contains filtered or unexported fields
}

type Controller

type Controller struct {
	// Controller.Clock allows the use of fake clock when testing
	Clock clock.Clock
	// contains filtered or unexported fields
}

Controller is a name-spaced collection of back-off handlers

func NewController

func NewController(ctx context.Context) *Controller

func (*Controller) GetBackOffHandler

func (m *Controller) GetBackOffHandler(key string) (*ComputeResourceAwareBackOffHandler, bool)

func (*Controller) GetOrCreateHandler

func (m *Controller) GetOrCreateHandler(ctx context.Context, key string, backOffBaseSecond int, maxBackOffDuration time.Duration) *ComputeResourceAwareBackOffHandler

type HandlerMap

type HandlerMap struct {
	sync.Map
}

func (*HandlerMap) Get

func (m *HandlerMap) Get(key string) (*ComputeResourceAwareBackOffHandler, bool)

func (*HandlerMap) Set

func (m *HandlerMap) Set(key string, value *ComputeResourceAwareBackOffHandler)

type SimpleBackOffBlocker

type SimpleBackOffBlocker struct {
	Clock              clock.Clock
	BackOffBaseSecond  int
	MaxBackOffDuration time.Duration

	// Mutable fields
	BackOffExponent  stdAtomic.Uint32
	NextEligibleTime AtomicTime
}

SimpleBackOffBlocker is a simple exponential back-off timer that keeps track of the back-off period