deckhouse_config

Documentation

Index

• Constants
• func GeneratedConfigMap(data map[string]string) *v1.ConfigMap
• func GetAllConfigs(kubeClient k8s.Client) ([]*v1alpha1.ModuleConfig, error)
• func GetConfigMap(klient k8s.Client, ns string, name string) (*v1.ConfigMap, error)
• func GetDeckhouseConfigMap(klient k8s.Client) (*v1.ConfigMap, error)
• func GetGeneratedConfigMap(klient k8s.Client) (*v1.ConfigMap, error)
• func InitService(mm ModuleManager)
• func IsServiceInited() bool
• func SetModuleConfigEnabledFlag(kubeClient k8s.Client, name string, enabled bool) error
• type ConfigService
  • func Service() *ConfigService
  • func (srv *ConfigService) AddModuleNameToSource(moduleName, moduleSource string)
  • func (srv *ConfigService) AddPossibleName(name string)
  • func (srv *ConfigService) ConfigValidator() *ConfigValidator
  • func (srv *ConfigService) GetValuesValidator() *validation.ValuesValidator
  • func (srv *ConfigService) ModuleToSourcesNames() map[string]string
  • func (srv *ConfigService) PossibleNames() set.Set
  • func (srv *ConfigService) SetModuleNameToSources(allModuleNamesToSources map[string]string)
  • func (srv *ConfigService) StatusReporter() *StatusReporter
  • func (srv *ConfigService) ValidateModule(module *modules.BasicModule) error
• type ConfigValidator
  • func NewConfigValidator(valuesValidator ValuesValidator) *ConfigValidator
  • func (c *ConfigValidator) ConvertToLatest(cfg *v1alpha1.ModuleConfig) ValidationResult
  • func (c *ConfigValidator) Validate(cfg *v1alpha1.ModuleConfig) ValidationResult
• type ModuleConfigStatus
• type ModuleManager
• type ModuleStatus
• type StatusReporter
  • func NewModuleInfo(mm ModuleManager, possibleNames set.Set) *StatusReporter
  • func (s *StatusReporter) ForConfig(cfg *v1alpha1.ModuleConfig) ModuleConfigStatus
  • func (s *StatusReporter) ForModule(module *v1alpha1.Module, cfg *v1alpha1.ModuleConfig, bundleName string) ModuleStatus
• type ValidationResult
  • func (v ValidationResult) HasError() bool
• type ValuesValidator

Constants

const DeckhouseConfigMapName = "deckhouse"

const DeckhouseNS = "d8-system"

const GeneratedConfigMapName = "deckhouse-generated-config-do-not-edit"

Functions

func GeneratedConfigMap

func GeneratedConfigMap(data map[string]string) *v1.ConfigMap

func GetAllConfigs

func GetAllConfigs(kubeClient k8s.Client) ([]*v1alpha1.ModuleConfig, error)

GetAllConfigs returns all ModuleConfig objects.

func GetConfigMap

func GetConfigMap(klient k8s.Client, ns string, name string) (*v1.ConfigMap, error)

func GetDeckhouseConfigMap

func GetDeckhouseConfigMap(klient k8s.Client) (*v1.ConfigMap, error)

GetDeckhouseConfigMap returns default ConfigMap with config values (ConfigMap/deckhouse).

func GetGeneratedConfigMap

func GetGeneratedConfigMap(klient k8s.Client) (*v1.ConfigMap, error)

GetGeneratedConfigMap returns generated ConfigMap with config values.

func InitService

func InitService(mm ModuleManager)

func IsServiceInited

func IsServiceInited() bool

func SetModuleConfigEnabledFlag

func SetModuleConfigEnabledFlag(kubeClient k8s.Client, name string, enabled bool) error

SetModuleConfigEnabledFlag updates spec.enabled flag or creates a new ModuleConfig with spec.enabled flag.

Types

type ConfigService

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

func Service

func Service() *ConfigService

func (*ConfigService) AddModuleNameToSource

func (srv *ConfigService) AddModuleNameToSource(moduleName, moduleSource string)

func (*ConfigService) AddPossibleName

func (srv *ConfigService) AddPossibleName(name string)

func (*ConfigService) ConfigValidator

func (srv *ConfigService) ConfigValidator() *ConfigValidator

func (*ConfigService) GetValuesValidator

func (srv *ConfigService) GetValuesValidator() *validation.ValuesValidator

func (*ConfigService) ModuleToSourcesNames

func (srv *ConfigService) ModuleToSourcesNames() map[string]string

func (*ConfigService) PossibleNames

func (srv *ConfigService) PossibleNames() set.Set

func (*ConfigService) SetModuleNameToSources

func (srv *ConfigService) SetModuleNameToSources(allModuleNamesToSources map[string]string)

func (*ConfigService) StatusReporter

func (srv *ConfigService) StatusReporter() *StatusReporter

func (*ConfigService) ValidateModule

func (srv *ConfigService) ValidateModule(module *modules.BasicModule) error

type ConfigValidator

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

ConfigValidator is a validator for values in ModuleConfig.

func NewConfigValidator

func NewConfigValidator(valuesValidator ValuesValidator) *ConfigValidator

func (*ConfigValidator) ConvertToLatest

func (c *ConfigValidator) ConvertToLatest(cfg *v1alpha1.ModuleConfig) ValidationResult

ConvertToLatest checks if ModuleConfig resource is well-formed and runs conversions for spec.settings is needed. TODO(future) return cfg, error. Put cfg.Spec into result cfg.

func (*ConfigValidator) Validate

func (c *ConfigValidator) Validate(cfg *v1alpha1.ModuleConfig) ValidationResult

Validate checks ModuleConfig resource: - check if resource is well-formed - runs conversions for spec.settings is needed - use OpenAPI schema defined in related config-values.yaml file to validate converted spec.settings. TODO(future) return cfg, error. Put cfg.Spec into result cfg.

type ModuleConfigStatus

type ModuleConfigStatus struct {
	Version string
	Message string
}

type ModuleManager

type ModuleManager interface {
	IsModuleEnabled(modName string) bool
	GetModule(modName string) *modules.BasicModule
	GetModuleNames() []string
	GetEnabledModuleNames() []string
	GetValuesValidator() *validation.ValuesValidator
	ValidateModule(module *modules.BasicModule) error
}

ModuleManager interface is a part of addon-operator's ModuleManager interface with methods needed for deckhouse-config package.

type ModuleStatus

type ModuleStatus struct {
	Status     string
	Message    string
	HooksState string
}

type StatusReporter

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

func NewModuleInfo

func NewModuleInfo(mm ModuleManager, possibleNames set.Set) *StatusReporter

func (*StatusReporter) ForConfig

func (s *StatusReporter) ForConfig(cfg *v1alpha1.ModuleConfig) ModuleConfigStatus

func (*StatusReporter) ForModule

func (s *StatusReporter) ForModule(module *v1alpha1.Module, cfg *v1alpha1.ModuleConfig, bundleName string) ModuleStatus

type ValidationResult

type ValidationResult struct {
	Settings map[string]interface{}
	Version  int

	Warning string
	Error   string
}

func (ValidationResult) HasError

func (v ValidationResult) HasError() bool

HasError return true if result has error. TODO(future) use regular error instead.

type ValuesValidator

type ValuesValidator interface {
	GetSchema(schemaType validation.SchemaType, valuesType validation.SchemaType, modName string) *spec.Schema
	ValidateGlobalConfigValues(values utils.Values) error
	ValidateModuleConfigValues(moduleName string, values utils.Values) error
}

ValuesValidator is a part of ValuesValidator from addon-operator with needed methods to validate config values.