internal

type AnyOfGroup ¶ added in v0.30.11

type AnyOfGroup struct {
	Description string
	Modules     []ModuleRequirement
}

AnyOfGroup represents an "at least one of" group of module requirements. Description is used in user-facing error messages.

type DeckhouseRequirement ¶ added in v0.30.11

type DeckhouseRequirement struct {
	Constraint string
}

DeckhouseRequirement represents a constraint on the Deckhouse cluster version.

type EnvVar ¶

type EnvVar struct {
	Name string
}

EnvVar represents an environment variable required by the plugin

type Flag ¶

type Flag struct {
	Name string
}

Flag represents a command-line flag supported by the plugin

type KubernetesRequirement ¶

type KubernetesRequirement struct {
	Constraint string
}

KubernetesRequirement represents Kubernetes version constraint

type MirrorType ¶ added in v0.22.1

type MirrorType int

const (
	MirrorTypeDeckhouse MirrorType = iota
	MirrorTypeDeckhouseInstall
	MirrorTypeDeckhouseInstallStandalone
	MirrorTypeDeckhouseReleaseChannels
	MirrorTypeModules
	MirrorTypeModulesReleaseChannels
	MirrorTypeSecurity
	MirrorTypeSecurityTrivyDBSegment
	MirrorTypeSecurityTrivyBDUSegment
	MirrorTypeSecurityTrivyJavaDBSegment
	MirrorTypeSecurityTrivyChecksSegment
	MirrorTypePackages
	MirrorTypePackagesVersionChannels
)

type ModuleRequirement ¶

type ModuleRequirement struct {
	Name       string
	Constraint string
}

ModuleRequirement represents a required Deckhouse module

type ModuleRequirementsGroup ¶ added in v0.30.11

type ModuleRequirementsGroup struct {
	Mandatory   []ModuleRequirement
	Conditional []ModuleRequirement
	AnyOf       []AnyOfGroup
}

ModuleRequirementsGroup splits module requirements into Mandatory, Conditional, and AnyOf.

• Mandatory: the module must be in the cluster AND satisfy the constraint.
• Conditional: only enforced if the module is in the cluster.
• AnyOf: at least one module per group must be in the cluster and satisfy its constraint.

type Plugin ¶

type Plugin struct {
	Name         string
	Version      string
	Description  string
	Env          []EnvVar
	Flags        []Flag
	Requirements Requirements
}

Plugin represents a plugin domain entity

type PluginRequirement ¶ added in v0.26.4

type PluginRequirement struct {
	Name       string
	Constraint string
}

PluginRequirement represents a required plugin

type PluginRequirementsGroup ¶ added in v0.30.11

type PluginRequirementsGroup struct {
	Mandatory   []PluginRequirement
	Conditional []PluginRequirement
}

PluginRequirementsGroup splits plugin requirements into Mandatory and Conditional.

• Mandatory: the dependent plugin must be installed AND satisfy the constraint.
• Conditional: only enforced if the dependent plugin is installed; otherwise skipped.

type Requirements ¶

type Requirements struct {
	Kubernetes KubernetesRequirement
	Deckhouse  DeckhouseRequirement
	Modules    ModuleRequirementsGroup
	Plugins    PluginRequirementsGroup
}

Requirements represents plugin dependencies (v2 schema).

v1 schema: flat array of plugin and module requirements v2 schema: structured groups (with matchers anyOf, mandatory, conditional) + deckhouse