controller

Documentation

Index

• Variables
• func ConvertKubeEventToBindingContext(kubeEvent KubeEvent, link *KubernetesBindingToMonitorLink) []BindingContext
• type BindingExecutionInfo
• type HookController
  • func NewHookController() HookController
• type KubernetesBindingToMonitorLink
• type KubernetesBindingsController
• type ScheduleBindingToCrontabLink
• type ScheduleBindingsController

Variables

var NewKubernetesBindingsController = func() *kubernetesBindingsController {
	return &kubernetesBindingsController{
		BindingMonitorLinks: make(map[string]*KubernetesBindingToMonitorLink),
	}
}

NewKubernetesHooksController returns an implementation of KubernetesHooksController

var NewScheduleBindingsController = func() *scheduleBindingsController {
	return &scheduleBindingsController{
		ScheduleLinks: make(map[string]*ScheduleBindingToCrontabLink),
	}
}

NewKubernetesHooksController returns an implementation of KubernetesHooksController

Functions

func ConvertKubeEventToBindingContext

func ConvertKubeEventToBindingContext(kubeEvent KubeEvent, link *KubernetesBindingToMonitorLink) []BindingContext

Types

type BindingExecutionInfo

type BindingExecutionInfo struct {
	BindingContext         []BindingContext
	IncludeSnapshots       []string
	IncludeAllSnapshots    bool
	AllowFailure           bool
	QueueName              string
	Binding                string
	Group                  string
	WaitForSynchronization bool
}

type HookController

type HookController interface {
	InitKubernetesBindings([]OnKubernetesEventConfig, kube_events_manager.KubeEventsManager)
	InitScheduleBindings([]ScheduleConfig, schedule_manager.ScheduleManager)

	CanHandleKubeEvent(kubeEvent KubeEvent) bool
	CanHandleScheduleEvent(crontab string) bool

	// These method should call underlying BindingController to get binding context
	// and then add Snapshots to binding context
	HandleEnableKubernetesBindings(createTasksFn func(BindingExecutionInfo)) error
	HandleKubeEvent(event KubeEvent, createTasksFn func(BindingExecutionInfo))
	HandleScheduleEvent(crontab string, createTasksFn func(BindingExecutionInfo))

	StartMonitors()
	StopMonitors()

	EnableScheduleBindings()
	DisableScheduleBindings()

	KubernetesSnapshots() map[string][]ObjectAndFilterResult
	UpdateSnapshots([]BindingContext) []BindingContext
}

func NewHookController

func NewHookController() HookController

type KubernetesBindingToMonitorLink

type KubernetesBindingToMonitorLink struct {
	BindingName string
	MonitorId   string
	// Useful fields to create a BindingContext
	IncludeSnapshots       []string
	AllowFailure           bool
	JqFilter               string
	QueueName              string
	Group                  string
	WaitForSynchronization bool
}

A link between a hook and a kube monitor TODO replace "Useful fields" with OnKubernetesEventConfig

type KubernetesBindingsController

type KubernetesBindingsController interface {
	WithKubernetesBindings([]OnKubernetesEventConfig)
	WithKubeEventsManager(kube_events_manager.KubeEventsManager)
	EnableKubernetesBindings() ([]BindingExecutionInfo, error)
	StartMonitors()
	StopMonitors()
	CanHandleEvent(kubeEvent KubeEvent) bool
	HandleEvent(kubeEvent KubeEvent) BindingExecutionInfo
	BindingNames() []string
	SnapshotsFrom(bindingNames ...string) map[string][]ObjectAndFilterResult
	Snapshots() map[string][]ObjectAndFilterResult
}

KubernetesBindingsController handles kubernetes bindings for one hook.

type ScheduleBindingToCrontabLink

type ScheduleBindingToCrontabLink struct {
	BindingName string
	Crontab     string
	// Useful fields to create a BindingContext
	IncludeSnapshots []string
	AllowFailure     bool
	QueueName        string
	Group            string
}

A link between a hook and a kube monitor

type ScheduleBindingsController

type ScheduleBindingsController interface {
	WithScheduleBindings([]ScheduleConfig)
	WithScheduleManager(schedule_manager.ScheduleManager)
	EnableScheduleBindings()
	DisableScheduleBindings()
	CanHandleEvent(crontab string) bool
	HandleEvent(crontab string) []BindingExecutionInfo
}

ScheduleBindingsController handles schedule bindings for one hook.