addon_operator

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Jun 26, 2024 License: Apache-2.0 Imports: 45 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultHelmMonitorKubeClientMetricLabels = map[string]string{"component": "helm_monitor"}

DefaultHelmMonitorKubeClientMetricLabels are labels that indicates go client metrics producer. Important! These labels should be consistent with similar labels in ShellOperator!

Functions

func ConvergeModulesInQueue 

func ConvergeModulesInQueue(q *queue.TaskQueue) int

func ConvergeTasksInQueue 

func ConvergeTasksInQueue(q *queue.TaskQueue) int

func DrainNonMainQueue 

func DrainNonMainQueue(q *queue.TaskQueue)

func InitDefaultHelmResourcesManager 

func InitDefaultHelmResourcesManager(ctx context.Context, metricStorage *metric_storage.MetricStorage) (helm_resources_manager.HelmResourcesManager, error)

func ModulesWithPendingModuleRun 

func ModulesWithPendingModuleRun(q *queue.TaskQueue) map[string]struct{}

ModulesWithPendingModuleRun returns names of all modules in pending ModuleRun tasks. First task in queue considered not pending and is ignored.

func QueueHasPendingModuleRunTask 

func QueueHasPendingModuleRunTask(q *queue.TaskQueue, moduleName string) bool

QueueHasPendingModuleRunTask returns true if queue has pending tasks with the type "ModuleRun" related to the module "moduleName".

func RemoveAdjacentConvergeModules 

func RemoveAdjacentConvergeModules(q *queue.TaskQueue, afterId string)

RemoveAdjacentConvergeModules removes ConvergeModules tasks right after the task with the specified ID.

func RemoveCurrentConvergeTasks 

func RemoveCurrentConvergeTasks(q *queue.TaskQueue, afterId string) bool

RemoveCurrentConvergeTasks detects if converge tasks present in the main queue after task which ID equals to 'afterID'. These tasks are drained and the method returns true.

func StartLiveTicksUpdater 

func StartLiveTicksUpdater(metricStorage *metric_storage.MetricStorage)

func StartTasksQueueLengthUpdater 

func StartTasksQueueLengthUpdater(metricStorage *metric_storage.MetricStorage, tqs *queue.TaskQueueSet)

Types

type AddonOperator 

type AddonOperator struct {
	DebugServer *debug.Server

	// KubeConfigManager monitors changes in ConfigMap.
	KubeConfigManager *kube_config_manager.KubeConfigManager

	// ModuleManager is the module manager object, which monitors configuration
	// and variable changes.
	ModuleManager *module_manager.ModuleManager

	Helm *helm.ClientFactory

	// HelmResourcesManager monitors absent resources created for modules.
	HelmResourcesManager helm_resources_manager.HelmResourcesManager

	// converge state
	ConvergeState *converge.ConvergeState

	// Initial KubeConfig to bypass initial loading from the ConfigMap.
	InitialKubeConfig *config.KubeConfig

	// AdmissionServer handles validation and mutation admission webhooks
	AdmissionServer *AdmissionServer

	MetricStorage *metric_storage.MetricStorage

	// LeaderElector represents leaderelection client for HA mode
	LeaderElector *leaderelection.LeaderElector
	// contains filtered or unexported fields
}

AddonOperator extends ShellOperator with modules and global hooks and with a value storage.

func NewAddonOperator 

func NewAddonOperator(ctx context.Context) *AddonOperator

func (*AddonOperator) Assemble 

func (op *AddonOperator) Assemble(debugServer *debug.Server) (err error)

func (*AddonOperator) BootstrapMainQueue 

func (op *AddonOperator) BootstrapMainQueue(tqs *queue.TaskQueueSet)

BootstrapMainQueue adds tasks to initiate Startup sequence:

- Run onStartup hooks. - Enable global schedule bindings. - Enable kubernetes bindings: run Synchronization tasks. - Purge unknown Helm releases. - Start reload all modules.

func (*AddonOperator) CheckConvergeStatus 

func (op *AddonOperator) CheckConvergeStatus(t sh_task.Task)

CheckConvergeStatus detects if converge process is started and updates ConvergeState. It updates metrics on converge finish.

func (*AddonOperator) CreateAfterAllTasks 

func (op *AddonOperator) CreateAfterAllTasks(logLabels map[string]string, eventDescription string) ([]sh_task.Task, error)

CreateAfterAllTasks returns tasks to run AfterAll global hooks.

func (*AddonOperator) CreateAndStartQueue 

func (op *AddonOperator) CreateAndStartQueue(queueName string) bool

CreateAndStartQueue creates a named queue and starts it. It returns false is queue is already created

func (*AddonOperator) CreateAndStartQueuesForAllModuleHooks 

func (op *AddonOperator) CreateAndStartQueuesForAllModuleHooks()

CreateAndStartQueuesForAllModuleHooks creates queues for all registered modules. It is safe to run this method multiple times, as it checks for existing queues.

func (*AddonOperator) CreateAndStartQueuesForGlobalHooks 

func (op *AddonOperator) CreateAndStartQueuesForGlobalHooks()

CreateAndStartQueuesForGlobalHooks creates queues for all registered global hooks. It is safe to run this method multiple times, as it checks for existing queues.

func (*AddonOperator) CreateAndStartQueuesForModuleHooks 

func (op *AddonOperator) CreateAndStartQueuesForModuleHooks(moduleName string)

CreateAndStartQueuesForModuleHooks creates queues for registered module hooks. It is safe to run this method multiple times, as it checks for existing queues.

func (*AddonOperator) CreateBeforeAllTasks 

func (op *AddonOperator) CreateBeforeAllTasks(logLabels map[string]string, eventDescription string) []sh_task.Task

CreateBeforeAllTasks returns tasks to run BeforeAll global hooks.

func (*AddonOperator) CreateBootstrapTasks 

func (op *AddonOperator) CreateBootstrapTasks(logLabels map[string]string) []sh_task.Task

func (*AddonOperator) CreateConvergeModulesTasks 

func (op *AddonOperator) CreateConvergeModulesTasks(state *module_manager.ModulesState, logLabels map[string]string, eventDescription string) []sh_task.Task

CreateConvergeModulesTasks creates ModuleRun/ModuleDelete tasks based on moduleManager state.

func (*AddonOperator) CreatePurgeTasks 

func (op *AddonOperator) CreatePurgeTasks(modulesToPurge []string, t sh_task.Task) []sh_task.Task

CreatePurgeTasks returns ModulePurge tasks for each unknown Helm release.

func (*AddonOperator) CreateReloadModulesTasks 

func (op *AddonOperator) CreateReloadModulesTasks(moduleNames []string, logLabels map[string]string, eventDescription string) []sh_task.Task

func (*AddonOperator) DrainModuleQueues 

func (op *AddonOperator) DrainModuleQueues(modName string)

func (*AddonOperator) HandleConvergeModules 

func (op *AddonOperator) HandleConvergeModules(t sh_task.Task, logLabels map[string]string) (res queue.TaskResult)

HandleConvergeModules is a multi-phase task.

func (*AddonOperator) HandleDiscoverHelmReleases 

func (op *AddonOperator) HandleDiscoverHelmReleases(t sh_task.Task, labels map[string]string) (res queue.TaskResult)

HandleDiscoverHelmReleases runs RefreshStateFromHelmReleases to detect modules state at start.

func (*AddonOperator) HandleGlobalHookEnableKubernetesBindings 

func (op *AddonOperator) HandleGlobalHookEnableKubernetesBindings(t sh_task.Task, labels map[string]string) (res queue.TaskResult)

HandleGlobalHookEnableKubernetesBindings add Synchronization tasks.

func (*AddonOperator) HandleGlobalHookRun 

func (op *AddonOperator) HandleGlobalHookRun(t sh_task.Task, labels map[string]string) (res queue.TaskResult)

func (*AddonOperator) HandleModuleDelete 

func (op *AddonOperator) HandleModuleDelete(t sh_task.Task, labels map[string]string) (status queue.TaskStatus)

HandleModuleDelete deletes helm release for known module.

func (*AddonOperator) HandleModuleHookRun 

func (op *AddonOperator) HandleModuleHookRun(t sh_task.Task, labels map[string]string) (res queue.TaskResult)

func (*AddonOperator) HandleModulePurge 

func (op *AddonOperator) HandleModulePurge(t sh_task.Task, labels map[string]string) (status queue.TaskStatus)

HandleModulePurge run helm purge for unknown module.

func (*AddonOperator) HandleModuleRun 

func (op *AddonOperator) HandleModuleRun(t sh_task.Task, labels map[string]string) (res queue.TaskResult)

HandleModuleRun starts a module by executing module hooks and installing a Helm chart.

Execution sequence: - Run onStartup hooks. - Queue kubernetes hooks as Synchronization tasks. - Wait until Synchronization tasks are done to fill all snapshots. - Enable kubernetes events. - Enable schedule events. - Run beforeHelm hooks - Run Helm to install or upgrade a module's chart. - Run afterHelm hooks.

ModuleRun is restarted if hook or chart is failed. After first HandleModuleRun success, no onStartup and kubernetes.Synchronization tasks will run.

func (*AddonOperator) InitModuleManager 

func (op *AddonOperator) InitModuleManager() error

InitModuleManager initialize KubeConfigManager and ModuleManager, reads values from ConfigMap for the first time and sets handlers for kubernetes and schedule events.

func (*AddonOperator) IsStartupConvergeDone 

func (op *AddonOperator) IsStartupConvergeDone() bool

func (*AddonOperator) KubeClient 

func (op *AddonOperator) KubeClient() *client.Client

KubeClient returns default common kubernetes client initialized by shell-operator

func (*AddonOperator) RegisterDebugGlobalRoutes 

func (op *AddonOperator) RegisterDebugGlobalRoutes(dbgSrv *debug.Server)

func (*AddonOperator) RegisterDebugModuleRoutes 

func (op *AddonOperator) RegisterDebugModuleRoutes(dbgSrv *debug.Server)

func (*AddonOperator) RegisterDiscoveryRoute 

func (op *AddonOperator) RegisterDiscoveryRoute(dbgSrv *debug.Server)

func (*AddonOperator) RegisterManagerEventsHandlers 

func (op *AddonOperator) RegisterManagerEventsHandlers()

func (*AddonOperator) Setup 

func (op *AddonOperator) Setup() error

func (*AddonOperator) SetupKubeConfigManager 

func (op *AddonOperator) SetupKubeConfigManager(bk backend.ConfigHandler)

SetupKubeConfigManager sets manager, which reads configuration for Modules from a cluster

func (*AddonOperator) SetupModuleManager 

func (op *AddonOperator) SetupModuleManager(modulesDir string, globalHooksDir string, tempDir string)

func (*AddonOperator) Start 

func (op *AddonOperator) Start(_ context.Context) error

Start runs all managers, event and queue handlers. TODO: implement context in various dependencies (ModuleManager, KubeConfigManaer, etc)

func (*AddonOperator) StartAPIServer 

func (op *AddonOperator) StartAPIServer()

func (*AddonOperator) StartModuleManagerEventHandler 

func (op *AddonOperator) StartModuleManagerEventHandler()

func (*AddonOperator) Stop 

func (op *AddonOperator) Stop()

func (*AddonOperator) TaskHandler 

func (op *AddonOperator) TaskHandler(t sh_task.Task) queue.TaskResult

TaskHandler handles tasks in queue.

func (*AddonOperator) UpdateFirstConvergeStatus 

func (op *AddonOperator) UpdateFirstConvergeStatus(convergeTasks int)

UpdateFirstConvergeStatus checks first converge status and prints log messages if first converge is in progress.

func (*AddonOperator) UpdateWaitInQueueMetric 

func (op *AddonOperator) UpdateWaitInQueueMetric(t sh_task.Task)

UpdateWaitInQueueMetric increases task_wait_in_queue_seconds_total counter for the task type. TODO pass queue name from handler, not from task

func (*AddonOperator) WithLeaderElector 

func (op *AddonOperator) WithLeaderElector(config *leaderelection.LeaderElectionConfig) error

type AdmissionServer 

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

func NewAdmissionServer 

func NewAdmissionServer(listenPort, certsDir string) *AdmissionServer

func (*AdmissionServer) RegisterHandler 

func (as *AdmissionServer) RegisterHandler(route string, handler http.Handler)

Source Files

View all Source files

Directories

Path Synopsis

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.