task

Documentation

Index

• Constants
• type HookMetadata
  • func HookMetadataAccessor(t task.Task) (meta HookMetadata)
  • func (hm HookMetadata) GetBindingContext() []binding_context.BindingContext
  • func (hm HookMetadata) GetDescription() string
  • func (hm HookMetadata) GetHookName() string
  • func (hm HookMetadata) GetMonitorIDs() []string
  • func (hm HookMetadata) IsSynchronization() bool
• type ParallelRunMetadata
  • func (pm *ParallelRunMetadata) DeleteModuleMetadata(moduleName string)
  • func (pm *ParallelRunMetadata) GetModulesMetadata() map[string]ParallelRunModuleMetadata
  • func (pm *ParallelRunMetadata) ListModules() []string
  • func (pm *ParallelRunMetadata) SetModuleMetadata(moduleName string, metadata ParallelRunModuleMetadata)
• type ParallelRunModuleMetadata

Constants

const (
	// GlobalHookRun runs a global hook.
	GlobalHookRun task.TaskType = "GlobalHookRun"
	// ModuleHookRun runs schedule or kubernetes hook.
	ModuleHookRun task.TaskType = "ModuleHookRun"
	// ModuleDelete runs helm delete/afterHelmDelete sequence.
	ModuleDelete task.TaskType = "ModuleDelete"
	// ModuleRun runs beforeHelm/helm upgrade/afterHelm sequence.
	ModuleRun task.TaskType = "ModuleRun"
	// ParallelModuleRun runs beforeHelm/helm upgrade/afterHelm sequence for a bunch of modules in parallel.
	ParallelModuleRun task.TaskType = "ParallelModuleRun"
	// ModulePurge - delete unknown helm release (no module in ModulesDir)
	ModulePurge task.TaskType = "ModulePurge"
	// ModuleEnsureCRDs runs ensureCRDs task for enabled module
	ModuleEnsureCRDs task.TaskType = "ModuleEnsureCRDs"

	// DiscoverHelmReleases lists helm releases to detect unknown modules and initiate enabled modules list.
	DiscoverHelmReleases task.TaskType = "DiscoverHelmReleases"

	// ConvergeModules runs beforeAll/run modules/afterAll sequence for all enabled modules.
	ConvergeModules task.TaskType = "ConvergeModules"

	// ApplyKubeConfigValues validates and updates modules' values
	ApplyKubeConfigValues task.TaskType = "ApplyKubeConfigValues"

	GlobalHookEnableKubernetesBindings      task.TaskType = "GlobalHookEnableKubernetesBindings"
	GlobalHookWaitKubernetesSynchronization task.TaskType = "GlobalHookWaitKubernetesSynchronization"
	GlobalHookEnableScheduleBindings        task.TaskType = "GlobalHookEnableScheduleBindings"
)

Addon-operator specific task types

Types

type HookMetadata

type HookMetadata struct {
	EventDescription    string // event name for informative queue dump
	HookName            string
	ModuleName          string
	ParallelRunMetadata *ParallelRunMetadata
	Binding             string // binding name from configuration
	BindingType         types.BindingType
	BindingContext      []binding_context.BindingContext
	AllowFailure        bool // Task considered as 'ok' if hook failed. False by default. Can be true for some schedule hooks.

	DoModuleStartup bool // Execute onStartup and kubernetes@Synchronization hooks for module
	IsReloadAll     bool // ModuleRun task is a part of 'Reload all modules' process.

	ValuesChecksum           string // checksum of global values before first afterAll hook execution
	GlobalValuesChanged      bool   // global values changed flag
	LastAfterAllHook         bool   // true if task is a last afterAll hook in sequence
	ReloadAllOnValuesChanges bool   // whether to run DiscoverModules process if hook change global values

	KubernetesBindingId      string   // Unique id for kubernetes bindings
	WaitForSynchronization   bool     // kubernetes.Synchronization task should be waited
	MonitorIDs               []string // an array of monitor IDs to unlock Kubernetes events after Synchronization.
	ExecuteOnSynchronization bool     // A flag to skip hook execution in Synchronization tasks.
}

HookMetadata is a metadata for addon-operator tasks

func HookMetadataAccessor

func HookMetadataAccessor(t task.Task) (meta HookMetadata)

func (HookMetadata) GetBindingContext

func (hm HookMetadata) GetBindingContext() []binding_context.BindingContext

func (HookMetadata) GetDescription

func (hm HookMetadata) GetDescription() string

func (HookMetadata) GetHookName

func (hm HookMetadata) GetHookName() string

func (HookMetadata) GetMonitorIDs

func (hm HookMetadata) GetMonitorIDs() []string

func (HookMetadata) IsSynchronization

func (hm HookMetadata) IsSynchronization() bool

type ParallelRunMetadata

type ParallelRunMetadata struct {
	// the order the modules are grouped by
	Order node.NodeWeight
	// channelId of the parallelTaskChannel to communicate between parallel ModuleRun and ParallelModuleRun tasks
	ChannelId string
	// context with cancel to stop ParallelModuleRun task
	Context context.Context
	CancelF func()
	// contains filtered or unexported fields
}

ParallelRunMetadata is metadata for a parallel task

func (*ParallelRunMetadata) DeleteModuleMetadata

func (pm *ParallelRunMetadata) DeleteModuleMetadata(moduleName string)

func (*ParallelRunMetadata) GetModulesMetadata

func (pm *ParallelRunMetadata) GetModulesMetadata() map[string]ParallelRunModuleMetadata

func (*ParallelRunMetadata) ListModules

func (pm *ParallelRunMetadata) ListModules() []string

func (*ParallelRunMetadata) SetModuleMetadata

func (pm *ParallelRunMetadata) SetModuleMetadata(moduleName string, metadata ParallelRunModuleMetadata)

type ParallelRunModuleMetadata

type ParallelRunModuleMetadata struct {
	DoModuleStartup bool
}

ParallelRunModuleMetadata is metadata for a parallel module