specprovider

Documentation

Index

• Variables
• type ConfigManager
• type ConfigManagerSource
• type SpecProvider
• type SpecProviderBuilder
  • func NewBuilder() SpecProviderBuilder
• type SpecProviderConfig
  • func (cfg *SpecProviderConfig) GetUpgradeType() upgradev1alpha1.UpgradeType
  • func (cfg *SpecProviderConfig) IsValid() error

Variables

var (
	// ErrInvalidSpecProvider is an error advising an invalid spec provider configuration
	ErrInvalidSpecProvider = fmt.Errorf("invalid configManager spec provider type defined")
	// ErrNoSpecProviderConfig is an error advising no config has been configured
	ErrNoSpecProviderConfig = fmt.Errorf("no configManager spec provider configured")
)

Types

type ConfigManager

type ConfigManager struct {
	Source string `yaml:"source"`
}

ConfigManager holds fields that describe a ConfigManager

type ConfigManagerSource

type ConfigManagerSource string

ConfigManagerSource is a type that denotes the source of configuration management

const (
	// OCM denotes OCM as the config manager source
	OCM ConfigManagerSource = "OCM"
	// LOCAL denotes a local config manager source
	LOCAL ConfigManagerSource = "LOCAL"
)

type SpecProvider

type SpecProvider interface {
	Get() ([]upgradev1alpha1.UpgradeConfigSpec, error)
}

SpecProvider is an interface that enables an implementation of a spec provider

type SpecProviderBuilder

type SpecProviderBuilder interface {
	New(client.Client, configmanager.ConfigManagerBuilder) (SpecProvider, error)
}

SpecProviderBuilder is an interface that enables implementation of a spec provider builder

func NewBuilder

func NewBuilder() SpecProviderBuilder

NewBuilder returns a new specProviderBuilder

type SpecProviderConfig

type SpecProviderConfig struct {
	// UpgradeType is used to select which upgrader to use when upgrading
	UpgradeType string `yaml:"upgradeType"`
	// ConfigManager configures the source that the operator uses to read UpgradeConfig specs
	ConfigManager ConfigManager `yaml:"configManager"`
}

SpecProviderConfig holds fields that describe a spec providers config

func (*SpecProviderConfig) GetUpgradeType

func (cfg *SpecProviderConfig) GetUpgradeType() upgradev1alpha1.UpgradeType

GetUpgradeType returns the upgrader type to populate in the upgrade config spec

func (*SpecProviderConfig) IsValid

func (cfg *SpecProviderConfig) IsValid() error

IsValid returns a nil error when the SpecProviderConfig is valid