shell_operator

package
v1.0.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 15, 2021 License: Apache-2.0 Imports: 33 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultMainKubeClientMetricLabels = map[string]string{"component": "main"}
View Source 
var DefaultObjectPatcherKubeClientMetricLabels = map[string]string{"component": "object_patcher"}
View Source 
var WaitQueuesTimeout = time.Second * 10

Functions

func InitAndStart 

func InitAndStart(operator *ShellOperator) error

func RegisterCommonMetrics 

func RegisterCommonMetrics(metricStorage *metric_storage.MetricStorage)

func RegisterHookMetrics 

func RegisterHookMetrics(metricStorage *metric_storage.MetricStorage)

Shell-operator specific metrics

func RegisterKubeEventsManagerMetrics 

func RegisterKubeEventsManagerMetrics(metricStorage *metric_storage.MetricStorage, labels map[string]string)

metrics for kube_event_manager

func RegisterShellOperatorMetrics 

func RegisterShellOperatorMetrics(metricStorage *metric_storage.MetricStorage)

func RegisterTaskQueueMetrics 

func RegisterTaskQueueMetrics(metricStorage *metric_storage.MetricStorage)

Types

type CombineResult 

type CombineResult struct {
	BindingContexts []BindingContext
	MonitorIDs      []string
}

type ManagerEventsHandler 

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

func NewManagerEventsHandler 

func NewManagerEventsHandler() *ManagerEventsHandler

func (*ManagerEventsHandler) Start 

func (m *ManagerEventsHandler) Start()

func (*ManagerEventsHandler) Stop 

func (m *ManagerEventsHandler) Stop()

func (*ManagerEventsHandler) WithContext 

func (m *ManagerEventsHandler) WithContext(ctx context.Context)

func (*ManagerEventsHandler) WithKubeEventHandler 

func (m *ManagerEventsHandler) WithKubeEventHandler(fn func(kubeEvent KubeEvent) []task.Task)

func (*ManagerEventsHandler) WithKubeEventsManager 

func (m *ManagerEventsHandler) WithKubeEventsManager(mgr kube_events_manager.KubeEventsManager)

func (*ManagerEventsHandler) WithScheduleEventHandler 

func (m *ManagerEventsHandler) WithScheduleEventHandler(fn func(crontab string) []task.Task)

func (*ManagerEventsHandler) WithScheduleManager 

func (m *ManagerEventsHandler) WithScheduleManager(mgr schedule_manager.ScheduleManager)

func (*ManagerEventsHandler) WithTaskQueueSet 

func (m *ManagerEventsHandler) WithTaskQueueSet(tqs *queue.TaskQueueSet)

type ShellOperator 

type ShellOperator struct {
	HooksDir string
	TempDir  string

	MetricStorage *metric_storage.MetricStorage
	// separate metric storage for hook metrics if separate listen port is configured
	HookMetricStorage *metric_storage.MetricStorage
	KubeClient        klient.Client
	ObjectPatcher     *object_patch.ObjectPatcher

	// Labels for kube clients
	MainKubeClientMetricLabels          map[string]string
	ObjectPatcherKubeClientMetricLabels map[string]string

	ScheduleManager   schedule_manager.ScheduleManager
	KubeEventsManager kube_events_manager.KubeEventsManager

	TaskQueues *queue.TaskQueueSet

	ManagerEventsHandler *ManagerEventsHandler

	HookManager hook.HookManager

	ValidatingWebhookManager *validating.WebhookManager
	ConversionWebhookManager *conversion.WebhookManager

	DebugServer *debug.Server
	// contains filtered or unexported fields
}

func DefaultOperator 

func DefaultOperator() *ShellOperator

func NewShellOperator 

func NewShellOperator() *ShellOperator

func (*ShellOperator) CombineBindingContextForHook 

func (op *ShellOperator) CombineBindingContextForHook(q *queue.TaskQueue, t task.Task, stopCombineFn func(tsk task.Task) bool) *CombineResult

CombineBindingContextForHook combines binding contexts from a sequence of task with similar hook name and task type into array of binding context and delete excess tasks from queue.

Also, sequences of binding contexts with similar group are compacted in one binding context.

If input task has no metadata, result will be nil. Metadata should implement HookNameAccessor, BindingContextAccessor and MonitorIDAccessor interfaces. DEV WARNING! Do not use HookMetadataAccessor here. Use only *Accessor interfaces because this method is used from addon-operator.

func (*ShellOperator) ConversionEventHandler 

func (op *ShellOperator) ConversionEventHandler(event conversion.Event) (*conversion.Response, error)

ConversionEventHandler is called when Kubernetes requests a conversion.

func (*ShellOperator) GetMainKubeClientMetricLabels 

func (op *ShellOperator) GetMainKubeClientMetricLabels() map[string]string

func (*ShellOperator) GetObjectPatcherKubeClientMetricLabels 

func (op *ShellOperator) GetObjectPatcherKubeClientMetricLabels() map[string]string

func (*ShellOperator) HandleRunHook 

func (op *ShellOperator) HandleRunHook(t task.Task, taskHook *hook.Hook, hookMeta HookMetadata, taskLogEntry *log.Entry, hookLogLabels map[string]string, metricLabels map[string]string) error

func (*ShellOperator) Init 

func (op *ShellOperator) Init() (err error)

Init does some basic checks and instantiate dependencies

- check directories - start debug server - initialize dependencies:

  • metric storage
  • kubernetes client config
  • empty set of task queues
  • hook manager
  • kubernetes events manager
  • schedule manager

func (*ShellOperator) InitAndStartHookQueues 

func (op *ShellOperator) InitAndStartHookQueues()

CreateQueues create all queues defined in hooks

func (*ShellOperator) InitConversionWebhookManager 

func (op *ShellOperator) InitConversionWebhookManager() (err error)

InitConversionWebhookManager sets a conversions webhook manager.

func (*ShellOperator) InitHookManager 

func (op *ShellOperator) InitHookManager() (err error)

InitHookManager load hooks from HooksDir and defines event handlers that emit tasks.

func (*ShellOperator) InitHookMetricStorage 

func (op *ShellOperator) InitHookMetricStorage()

InitHookMetricStorage creates MetricStorage object with new registry to scrape hook metrics on separate port.

func (*ShellOperator) InitMainKubeClient 

func (op *ShellOperator) InitMainKubeClient() (klient.Client, error)

InitMainKubeClient initializes a Kubernetes client for hooks. No timeout specified, because timeout will reset connections for Watchers.

func (*ShellOperator) InitMetricStorage 

func (op *ShellOperator) InitMetricStorage()

InitMetricStorage creates default MetricStorage object if not set earlier.

func (*ShellOperator) InitObjectPatcherKubeClient 

func (op *ShellOperator) InitObjectPatcherKubeClient() (klient.Client, error)

InitObjectPatcherKubeClient initializes a Kubernetes client for ObjectPatcher. Timeout is specified here.

func (*ShellOperator) InitValidatingWebhookManager 

func (op *ShellOperator) InitValidatingWebhookManager() (err error)

InitWebhookManagers adds kubernetesValidating hooks to a WebhookManager and set a validating event handler.

func (*ShellOperator) PrepopulateMainQueue 

func (op *ShellOperator) PrepopulateMainQueue(tqs *queue.TaskQueueSet)

PrepopulateMainQueue adds tasks to run hooks with OnStartup bindings and tasks to enable kubernetes bindings.

func (*ShellOperator) RunMetrics 

func (op *ShellOperator) RunMetrics()

func (*ShellOperator) SetupDebugServerHandles 

func (op *ShellOperator) SetupDebugServerHandles()

func (*ShellOperator) SetupHookMetricStorageAndServer 

func (op *ShellOperator) SetupHookMetricStorageAndServer() error

func (*ShellOperator) SetupHttpServerHandles 

func (op *ShellOperator) SetupHttpServerHandles()

func (*ShellOperator) Shutdown 

func (op *ShellOperator) Shutdown()

Shutdown pause kubernetes events handling and stop queues. Wait for queues to stop.

func (*ShellOperator) Start 

func (op *ShellOperator) Start()

Start

func (*ShellOperator) StartHttpServer 

func (op *ShellOperator) StartHttpServer(ip string, port string, mux *http.ServeMux) error

func (*ShellOperator) Stop 

func (op *ShellOperator) Stop()

func (*ShellOperator) TaskHandleEnableKubernetesBindings 

func (op *ShellOperator) TaskHandleEnableKubernetesBindings(t task.Task) queue.TaskResult

TaskHandleEnableKubernetesBindings creates task for each Kubernetes binding in the hook and queues them.

func (*ShellOperator) TaskHandleHookRun 

func (op *ShellOperator) TaskHandleHookRun(t task.Task) queue.TaskResult

TODO use Context to pass labels and a queue name

func (*ShellOperator) TaskHandler 

func (op *ShellOperator) TaskHandler(t task.Task) queue.TaskResult

TaskHandler

func (*ShellOperator) WithContext 

func (op *ShellOperator) WithContext(ctx context.Context) *ShellOperator

func (*ShellOperator) WithHooksDir 

func (op *ShellOperator) WithHooksDir(dir string)

func (*ShellOperator) WithKubernetesClient 

func (op *ShellOperator) WithKubernetesClient(klient klient.Client)

func (*ShellOperator) WithMetricStorage 

func (op *ShellOperator) WithMetricStorage(metricStorage *metric_storage.MetricStorage)

func (*ShellOperator) WithTempDir 

func (op *ShellOperator) WithTempDir(dir string)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.