configobserver

Documentation

Index

• type ConfigObserver
  • func NewConfigObserver(operatorClient v1helpers.OperatorClient, eventRecorder events.Recorder, ...) *ConfigObserver
  • func (c *ConfigObserver) EventHandler() cache.ResourceEventHandler
  • func (c *ConfigObserver) Run(ctx context.Context, workers int)
• type Listers
• type ObserveConfigFunc

Types

type ConfigObserver

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

func NewConfigObserver

func NewConfigObserver(
	operatorClient v1helpers.OperatorClient,
	eventRecorder events.Recorder,
	listers Listers,
	observers ...ObserveConfigFunc,
) *ConfigObserver

func (*ConfigObserver) EventHandler

func (c *ConfigObserver) EventHandler() cache.ResourceEventHandler

eventHandler queues the operator to check spec and status

func (*ConfigObserver) Run

func (c *ConfigObserver) Run(ctx context.Context, workers int)

type Listers

type Listers interface {
	// ResourceSyncer can be used to copy content from one namespace to another
	ResourceSyncer() resourcesynccontroller.ResourceSyncer
	PreRunHasSynced() []cache.InformerSynced
}

Listers is an interface which will be passed to the config observer funcs. It is expected to be hard-cast to the "correct" type

type ObserveConfigFunc

type ObserveConfigFunc func(listers Listers, recorder events.Recorder, existingConfig map[string]interface{}) (observedConfig map[string]interface{}, errs []error)

ObserveConfigFunc observes configuration and returns the observedConfig. This function should not return an observedConfig that would cause the service being managed by the operator to crash. For example, if a required configuration key cannot be observed, consider reusing the configuration key's previous value. Errors that occur while attempting to generate the observedConfig should be returned in the errs slice.