activejobstore

Documentation

Index

• Variables
• type EventHandler
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) Name() string
  • func (f *Factory) New(ctrlContext controllercontext.Context) (controllermanager.Store, error)
• type InformerWorker
  • func NewInformerWorker(ctrlContext controllercontext.Context, handler EventHandler) *InformerWorker
  • func (w *InformerWorker) HasSynced() bool
  • func (w *InformerWorker) OnAdd(obj interface{})
  • func (w *InformerWorker) OnDelete(obj interface{})
  • func (w *InformerWorker) OnUpdate(oldObj, newObj interface{})
  • func (w *InformerWorker) Start(stopCh <-chan struct{})
• type Store
  • func NewStore(ctrlContext controllercontext.Context) (*Store, error)
  • func (s *Store) CheckAndAdd(rjc *execution.JobConfig, oldCount int64) bool
  • func (s *Store) CountActiveJobsForConfig(rjc *execution.JobConfig) int64
  • func (s *Store) Delete(rjc *execution.JobConfig)
  • func (s *Store) Name() string
  • func (s *Store) OnDelete(rj *execution.Job)
  • func (s *Store) OnUpdate(oldRj, newRj *execution.Job)
  • func (s *Store) Recover(ctx context.Context) error

Variables

var (
	PanicOnInvariantViolation bool
)

Types

type EventHandler

type EventHandler interface {
	OnUpdate(oldRj, newRj *execution.Job)
	OnDelete(rj *execution.Job)
}

type Factory

type Factory struct{}

func NewFactory

func NewFactory() *Factory

func (*Factory) Name

func (f *Factory) Name() string

func (*Factory) New

func (f *Factory) New(ctrlContext controllercontext.Context) (controllermanager.Store, error)

type InformerWorker

type InformerWorker struct {
	controllercontext.Context
	// contains filtered or unexported fields
}

InformerWorker is used by the store internally to receive updates to the central store.

We only listen to Update and Delete events. This is because any additions are expected to be done explicitly.

It is acceptable for Update and Delete events to be delayed (but not missed).

func NewInformerWorker

func NewInformerWorker(ctrlContext controllercontext.Context, handler EventHandler) *InformerWorker

func (*InformerWorker) HasSynced

func (w *InformerWorker) HasSynced() bool

func (*InformerWorker) OnAdd

func (w *InformerWorker) OnAdd(obj interface{})

func (*InformerWorker) OnDelete

func (w *InformerWorker) OnDelete(obj interface{})

func (*InformerWorker) OnUpdate

func (w *InformerWorker) OnUpdate(oldObj, newObj interface{})

func (*InformerWorker) Start

func (w *InformerWorker) Start(stopCh <-chan struct{})

type Store

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

Store is an in-memory store of active Job counts per JobConfig.

This store is expected to be recovered prior to starting the controller, and helps to guard against multiple concurrent jobs for the same JobConfig from being started in an atomic fashion.

func NewStore

func NewStore(ctrlContext controllercontext.Context) (*Store, error)

func (*Store) CheckAndAdd

func (s *Store) CheckAndAdd(rjc *execution.JobConfig, oldCount int64) bool

CheckAndAdd atomically increments the active count for the given JobConfig.

func (*Store) CountActiveJobsForConfig

func (s *Store) CountActiveJobsForConfig(rjc *execution.JobConfig) int64

CountActiveJobsForConfig returns the count of active Jobs for a JobConfig.

func (*Store) Delete

func (s *Store) Delete(rjc *execution.JobConfig)

Delete the Job from the store.

func (*Store) Name

func (s *Store) Name() string

func (*Store) OnDelete

func (s *Store) OnDelete(rj *execution.Job)

func (*Store) OnUpdate

func (s *Store) OnUpdate(oldRj, newRj *execution.Job)

func (*Store) Recover

func (s *Store) Recover(ctx context.Context) error

Recover should be called after the context is started and should be called only once.