modules

package
v1.76.2 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2026 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	Path         string            // Path to package dir
	StaticValues addonutils.Values // Static values from values.yaml files

	Definition Definition // Module definition

	Digests    map[string]string // Package images digests(images_digests.json)
	Repository registry.Remote   // Package repository options

	ConfigSchema []byte // OpenAPI config schema (YAML)
	ValuesSchema []byte // OpenAPI values schema (YAML)

	Hooks []hooks.Hook // Discovered hooks

	SettingsCheck *kind.SettingsCheck

	Patcher           *objectpatch.ObjectPatcher
	ScheduleManager   schedulemanager.ScheduleManager
	KubeEventsManager kubeeventsmanager.KubeEventsManager

	GlobalValuesGetter GlobalValuesGetter
}

Config holds configuration for creating a new Module instance.

type Definition 

type Definition struct {
	Name     string `json:"name" yaml:"name"`
	Version  string `json:"version" yaml:"version"`
	Stage    string `json:"stage" yaml:"stage"`
	Critical bool   `json:"critical,omitempty" yaml:"critical,omitempty"`
	Weight   uint32 `json:"weight,omitempty" yaml:"weight,omitempty"`

	Requirements   Requirements   `json:"requirements" yaml:"requirements"`
	DisableOptions DisableOptions `json:"disableOptions" yaml:"disableOptions"`
}

Definition represents module metadata.

func (Definition) Constraints added in v1.76.0 

func (d Definition) Constraints() schedule.Constraints

Constraints projects the module definition onto the scheduler input shape, flattening mandatory and conditional module requirements into a single dependency map and projecting AnyOf groups onto schedule.AnyOfGroup. Mandatory entries win over conditional entries when both reference the same module.

type DisableOptions 

type DisableOptions struct {
	Confirmation bool   `json:"confirmation" yaml:"confirmation"` // Whether confirmation is required to disable
	Message      string `json:"message" yaml:"message"`           // Message to display when disabling
}

DisableOptions configures application disablement behavior.

type GlobalValuesGetter 

type GlobalValuesGetter func(prefix bool) addonutils.Values

type Info 

type Info struct {
	Name       string            `json:"name" yaml:"name"`
	Running    bool              `json:"running" yaml:"running"`
	Path       string            `json:"path" yaml:"path"`
	Definition Definition        `json:"definition" yaml:"definition"`
	Repository registry.Remote   `json:"repository" yaml:"repository"`
	Digests    map[string]string `json:"digests" yaml:"digests"`
	Values     addonutils.Values `json:"values,omitempty" yaml:"values,omitempty"`
	Hooks      []string          `json:"hooks,omitempty" yaml:"hooks,omitempty"`
}

type Module 

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

Module represents a running instance of a package. It contains hooks, values storage, and configuration for execution.

Thread Safety: The Module itself is not thread-safe, but its hooks and values storage components use internal synchronization.

func NewModuleByConfig 

func NewModuleByConfig(name string, cfg *Config, logger *log.Logger) (*Module, error)

NewModuleByConfig creates a new Module instance with the specified configuration. It initializes hook storage, adds all discovered hooks, and creates values storage.

Returns error if hook initialization or values storage creation fails.

func (*Module) ApplySettings 

func (m *Module) ApplySettings(settings addonutils.Values) error

ApplySettings applies settings values

func (*Module) DisableHooks added in v1.76.0 

func (m *Module) DisableHooks()

DisableHooks tears down all active hook bindings and clears the hook registry. Called by the Disable task when a package is being stopped or upgraded.

Cleanup order: schedule bindings are disabled first (stops cron triggers), then Kubernetes monitors are stopped (stops informer watches), and finally the hook registry is cleared so a subsequent InitializeHooks starts fresh.

func (*Module) GetConstraints added in v1.76.0 

func (m *Module) GetConstraints() schedule.Constraints

GetConstraints returns scheduler checks, their determine if an module should be enabled/disabled

func (*Module) GetHookSnapshotsDump added in v1.76.0 

func (m *Module) GetHookSnapshotsDump(include ...string) []byte

GetHookSnapshotsDump returns a YAML snapshot of hook controller snapshots. If include is provided, only hooks matching those names are included.

func (*Module) GetHooks 

func (m *Module) GetHooks() []hooks.Hook

GetHooks returns all hooks for this module in arbitrary order.

func (*Module) GetHooksByBinding 

func (m *Module) GetHooksByBinding(binding shtypes.BindingType) []hooks.Hook

GetHooksByBinding returns all hooks for the specified binding type, sorted by order.

func (*Module) GetHooksQueues added in v1.76.0 

func (m *Module) GetHooksQueues() []string

GetHooksQueues returns package queues from all hooks

func (*Module) GetInfo 

func (m *Module) GetInfo() Info

func (*Module) GetName 

func (m *Module) GetName() string

GetName returns the full module identifier.

func (*Module) GetPath 

func (m *Module) GetPath() string

GetPath returns path to the package dir

func (*Module) GetRuntimeValues 

func (m *Module) GetRuntimeValues() string

GetRuntimeValues returns runtime values in string format

func (*Module) GetSettings added in v1.76.0 

func (m *Module) GetSettings() addonutils.Values

GetSettings returns the effective settings: user config merged with config-schema defaults. Same payload exposed to templates as .Module.Settings.

func (*Module) GetSettingsChecksum 

func (m *Module) GetSettingsChecksum() string

GetSettingsChecksum returns a checksum of the current config values. Used to detect if settings changed.

func (*Module) GetValues 

func (m *Module) GetValues() addonutils.Values

GetValues returns values with hooks patches

func (*Module) GetValuesChecksum 

func (m *Module) GetValuesChecksum() string

GetValuesChecksum returns a checksum of the current values. Used to detect if values changed after hook execution.

func (*Module) GetVersion 

func (m *Module) GetVersion() *semver.Version

GetVersion return the package version

func (*Module) HooksInitialized added in v1.76.0 

func (m *Module) HooksInitialized() bool

HooksInitialized reports whether the package requires a hook initialize phase. This is true when hooks have not yet been initialized (no controllers attached), meaning the pkg needs to go through the full startup sequence before it can run.

func (*Module) InitializeHooks 

func (m *Module) InitializeHooks()

InitializeHooks initializes hook controllers and bind them to Kubernetes events and schedules

func (*Module) RunHookByName 

func (m *Module) RunHookByName(ctx context.Context, name string, bctx []bctx.BindingContext) error

RunHookByName executes a specific hook by name with the provided binding context. Returns nil if hook is not found (silent no-op).

func (*Module) RunHooksByBinding 

func (m *Module) RunHooksByBinding(ctx context.Context, binding shtypes.BindingType) error

RunHooksByBinding executes all hooks for a specific binding type in order. It creates a binding context with snapshots for BeforeHelm/AfterHelm/AfterDeleteHelm hooks.

func (*Module) UnlockKubernetesMonitors 

func (m *Module) UnlockKubernetesMonitors(hook string, monitors ...string)

UnlockKubernetesMonitors called after sync task is completed to unlock getting events

func (*Module) ValidateSettings 

func (m *Module) ValidateSettings(ctx context.Context, settings addonutils.Values) (settingscheck.Result, error)

ValidateSettings validates settings against openAPI and call setting check if exists

type ModuleGroup added in v1.76.1 

type ModuleGroup struct {
	Name    string                         `json:"name" yaml:"name"`
	Members map[string]*semver.Constraints `json:"members" yaml:"members"`
}

ModuleGroup is a named group of module dependencies shared by the AnyOf and NoneOf buckets; the containing field decides whether members are alternatives (at least one must be installed) or forbidden (none may be installed). Members maps each member's module name to its semver constraint (nil meaning "any version"). Name is the stable identifier used by the scheduler in diagnostics.

type ModulesRequirements added in v1.76.1 

type ModulesRequirements struct {
	// Mandatory lists modules that MUST be present (and satisfy constraint, if any)
	// for the module to start. The map value is nil when no version constraint applies.
	Mandatory map[string]*semver.Constraints `json:"mandatory" yaml:"mandatory"`
	// Conditional lists modules that are not required to be present, but if installed
	// must satisfy the version constraint. The map value is nil when no version constraint applies.
	Conditional map[string]*semver.Constraints `json:"conditional" yaml:"conditional"`
	// AnyOf lists groups of alternative dependencies; at least one member of each
	// group must be present (and satisfy its constraint, if any) for the module to
	// start. AnyOf groups are checker-only — they add no edges to the dependency
	// graph, so fallback chains across packages do not produce cycles.
	AnyOf []ModuleGroup `json:"anyOf,omitempty" yaml:"anyOf,omitempty"`
	// NoneOf lists groups of forbidden dependencies; no member of any group may be
	// present for the module to start. A nil constraint on a member forbids any
	// installed version; a non-nil constraint narrows the forbidden range so
	// versions outside it remain acceptable. Checker-only — adds no graph edges.
	NoneOf []ModuleGroup `json:"noneOf,omitempty" yaml:"noneOf,omitempty"`
}

ModulesRequirements groups module dependencies by how they affect module startup.

type Requirements 

type Requirements struct {
	Kubernetes *semver.Constraints `json:"kubernetes" yaml:"kubernetes"`
	Deckhouse  *semver.Constraints `json:"deckhouse" yaml:"deckhouse"`
	Modules    ModulesRequirements `json:"modules" yaml:"modules"`
}

Requirements specifies dependencies required by the module.

type RuntimeValues 

type RuntimeValues struct {
	Package addonutils.Values `json:"Package"`
}

RuntimeValues holds runtime values that are not part of schema. These values are passed to helm templates under .Runtime prefix.

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.