resync

Documentation

Overview

Package resync helps controllers specify custom resync behavior, which is important when they need to check state that lives outside the Kubernetes API server, such as in an app-specific system.

The controller-runtime library supports a form of resync, but you have to use the same setting for all controllers in the controller manager, and it tends to dump everything in the queue at once, which is spiky.

This package allows each controller to set its own resync period, and tries to spread out the requeuing of objects over time.

Index

• type Periodic
  • func NewPeriodic(name string, period time.Duration) *Periodic
  • func (p *Periodic) Enqueue(objKey client.ObjectKey)
  • func (p *Periodic) WatchSource() source.Source

Types

type Periodic

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

Periodic will trigger periodic resyncs of objects.

func NewPeriodic

func NewPeriodic(name string, period time.Duration) *Periodic

NewPeriodic returns a new periodic resync.

func (*Periodic) Enqueue

func (p *Periodic) Enqueue(objKey client.ObjectKey)

Enqueue adds the given object to the periodic resync queue. If the object was already in the queue, this resets the timer on it since it's assumed that this is called after a reconcile pass has just finished.

func (*Periodic) WatchSource

func (p *Periodic) WatchSource() source.Source

WatchSource returns the source.Source that can be passed to Controller.Watch() to plug this resync into the controller.