types

Documentation

Index

• Constants
• type Definition
  • func (d *Definition) Annotations() map[string]string
  • func (d *Definition) IsExperimental() bool
  • func (d *Definition) Labels() map[string]string
  • func (d *Definition) Validate(values addonutils.Values, logger *log.Logger) error
• type Module
  • func NewModule(def *Definition, staticValues utils.Values, configBytes, valuesBytes []byte, ...) (*Module, error)
  • func (m *Module) GetBasicModule() *modules.BasicModule
  • func (m *Module) GetConfirmationDisableReason() (string, bool)
  • func (m *Module) GetModuleDefinition() *Definition
  • func (m *Module) GetModuleExclusiveGroup() *string
• type ModuleAccessibility
  • func (a *ModuleAccessibility) IsAvailable(editionName string) bool
  • func (a *ModuleAccessibility) IsEnabled(editionName, bundleName string) bool
  • func (a *ModuleAccessibility) ToV1Alpha1() *v1alpha1.ModuleAccessibility
• type ModuleDescriptions
• type ModuleEdition
• type ModuleUpdate
  • func (a *ModuleUpdate) ToV1Alpha1() *v1alpha1.UpdateSpec
• type ModuleUpdateVersion

Constants

const (
	DefinitionFile = "module.yaml"

	ExperimentalModuleStage = "Experimental"
)

Types

type Definition

type Definition struct {
	Name           string   `json:"name" yaml:"name"`
	Critical       bool     `json:"critical,omitempty" yaml:"critical,omitempty"`
	Weight         uint32   `json:"weight,omitempty" yaml:"weight,omitempty"`
	Tags           []string `json:"tags,omitempty" yaml:"tags,omitempty"`
	Subsystems     []string `json:"subsystems,omitempty" yaml:"subsystems,omitempty"`
	Namespace      string   `json:"namespace,omitempty" yaml:"namespace,omitempty"`
	Stage          string   `json:"stage,omitempty" yaml:"stage,omitempty"`
	ExclusiveGroup string   `json:"exclusiveGroup,omitempty" yaml:"exclusiveGroup,omitempty"`

	Descriptions  *ModuleDescriptions          `json:"descriptions,omitempty" yaml:"descriptions,omitempty"`
	Requirements  *v1alpha1.ModuleRequirements `json:"requirements,omitempty" yaml:"requirements,omitempty"`
	Accessibility *ModuleAccessibility         `json:"accessibility,omitempty" yaml:"accessibility,omitempty"`

	DisableOptions *v1alpha1.ModuleDisableOptions `json:"disable,omitempty" yaml:"disable,omitempty"`
	Path           string                         `json:"-" yaml:"-"`

	// Update holds version transition hints that allow skipping step-by-step upgrades.
	// Example:
	// update:
	//   versions:
	//     - from: 1.67
	//       to: 1.75
	//     - from: 1.20
	//       to: 2.0
	Update *ModuleUpdate `json:"update,omitempty" yaml:"update,omitempty"`
}

Definition of module.yaml file struct

func (*Definition) Annotations

func (d *Definition) Annotations() map[string]string

func (*Definition) IsExperimental

func (d *Definition) IsExperimental() bool

func (*Definition) Labels

func (d *Definition) Labels() map[string]string

func (*Definition) Validate

func (d *Definition) Validate(values addonutils.Values, logger *log.Logger) error

type Module

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

func NewModule

func NewModule(def *Definition, staticValues utils.Values, configBytes, valuesBytes []byte, logger *log.Logger) (*Module, error)

func (*Module) GetBasicModule

func (m *Module) GetBasicModule() *modules.BasicModule

func (*Module) GetConfirmationDisableReason

func (m *Module) GetConfirmationDisableReason() (string, bool)

func (*Module) GetModuleDefinition

func (m *Module) GetModuleDefinition() *Definition

func (*Module) GetModuleExclusiveGroup

func (m *Module) GetModuleExclusiveGroup() *string

type ModuleAccessibility

type ModuleAccessibility struct {
	Editions map[string]ModuleEdition `json:"editions" yaml:"editions"`
}

func (*ModuleAccessibility) IsAvailable

func (a *ModuleAccessibility) IsAvailable(editionName string) bool

IsAvailable checks if the module available in the specific edition

func (*ModuleAccessibility) IsEnabled

func (a *ModuleAccessibility) IsEnabled(editionName, bundleName string) bool

IsEnabled checks if the module enabled in the specific edition and bundle

func (*ModuleAccessibility) ToV1Alpha1

func (a *ModuleAccessibility) ToV1Alpha1() *v1alpha1.ModuleAccessibility

type ModuleDescriptions

type ModuleDescriptions struct {
	Ru string `json:"ru,omitempty" yaml:"ru,omitempty"`
	En string `json:"en,omitempty" yaml:"en,omitempty"`
}

type ModuleEdition

type ModuleEdition struct {
	Available        bool     `json:"available" yaml:"available"`
	EnabledInBundles []string `json:"enabledInBundles" yaml:"enabledInBundles"`
}

type ModuleUpdate

type ModuleUpdate struct {
	Versions []ModuleUpdateVersion `json:"versions,omitempty" yaml:"versions,omitempty"`
}

ModuleUpdate describes allowed version transitions for a target release version.

func (*ModuleUpdate) ToV1Alpha1

func (a *ModuleUpdate) ToV1Alpha1() *v1alpha1.UpdateSpec

type ModuleUpdateVersion

type ModuleUpdateVersion struct {
	From string `json:"from" yaml:"from"`
	To   string `json:"to" yaml:"to"`
}

ModuleUpdateVersion represents a constraint range. "from" and "to" support major.minor or major.minor.patch. "to" should point to the target release version defined by this module.yaml.