internal

Documentation

Index

• Constants
• func ChannelIsValid(c string) bool
• func GetAllDefaultReleaseChannels() []string
• func InstallPathByMirrorType(mirrorType MirrorType) string
• type AnyOfGroup
• type DeckhouseRequirement
• type EnvVar
• type Flag
• type KubernetesRequirement
• type MirrorType
• type ModuleRequirement
• type ModuleRequirementsGroup
• type Plugin
• type PluginRequirement
• type PluginRequirementsGroup
• type Requirements

Constants

const (
	InstallSegment           = "install"
	InstallStandaloneSegment = "install-standalone"
	ReleaseChannelSegment    = "release-channel"

	ModulesSegment        = "modules"
	ModulesReleaseSegment = "release"
	ModulesExtraSegment   = "extra"

	PackagesSegment        = "packages"
	PackagesVersionSegment = "version"
	PackagesExtraSegment   = "extra"

	InstallerSegment = "installer"

	SecuritySegment = "security"

	SecurityTrivyDBSegment     = "trivy-db"
	SecurityTrivyBDUSegment    = "trivy-bdu"
	SecurityTrivyJavaDBSegment = "trivy-java-db"
	SecurityTrivyChecksSegment = "trivy-checks"
)

deckhouse repo structure (relative to root path like registry.deckhouse.io/deckhouse/fe)

Platform:

<root>:<version>                                    - Deckhouse main image
<root>/release-channel:<channel>                    - Release channel metadata
<root>/install:<version>                            - Installer image
<root>/install-standalone:<version>                 - Standalone installer

Security:

<root>/security/<security-name>:<version>           - Security databases (trivy-db, trivy-bdu, etc.)

Modules:

<root>/modules/<module-name>:<version>                    - Module main image
<root>/modules/<module-name>/release:<channel>            - Module release channel metadata
<root>/modules/<module-name>/extra/<extra-name>:<version> - Module extra images

Packages (same shape as modules, but under packages/ with a version/ release segment):

<root>/packages/<package-name>:<version>                    - Package main image
<root>/packages/<package-name>/version:<channel>            - Package version channel metadata
<root>/packages/<package-name>/extra/<extra-name>:<version> - Package extra images

const (
	AlphaChannel       = "alpha"
	BetaChannel        = "beta"
	EarlyAccessChannel = "early-access"
	StableChannel      = "stable"
	RockSolidChannel   = "rock-solid"
	LTSChannel         = "lts"
)

Functions

func ChannelIsValid

func ChannelIsValid(c string) bool

func GetAllDefaultReleaseChannels

func GetAllDefaultReleaseChannels() []string

func InstallPathByMirrorType

func InstallPathByMirrorType(mirrorType MirrorType) string

InstallPathByMirrorType returns the path segment for install based on the mirror type.

Types

type AnyOfGroup

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

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

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

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

type PluginRequirement struct {
	Name       string
	Constraint string
}

PluginRequirement represents a required plugin

type PluginRequirementsGroup

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