config

Documentation

Index

• func CloneWithSerialization[T NumaflowControllerDefinitionConfig | GlobalConfig](orig *T) (*T, error)
• type ConfigManager
  • func GetConfigManagerInstance() *ConfigManager
  • func (cm *ConfigManager) GetConfig() (GlobalConfig, error)
  • func (*ConfigManager) GetControllerDefinitionsMgr() *NumaflowControllerDefinitionsManager
  • func (cm *ConfigManager) GetNamespaceConfig(namespace string) *NamespaceConfig
  • func (cm *ConfigManager) GetUSDEConfig() USDEConfig
  • func (cm *ConfigManager) LoadAllConfigs(onErrorReloading func(error), options ...Option) error
  • func (cm *ConfigManager) RegisterCallback(f func(config GlobalConfig))
  • func (cm *ConfigManager) UnsetNamespaceConfig(namespace string)
  • func (cm *ConfigManager) UnsetUSDEConfig()
  • func (cm *ConfigManager) UpdateNamespaceConfig(namespace string, config NamespaceConfig)
  • func (cm *ConfigManager) UpdateUSDEConfig(config USDEConfig)
• type GlobalConfig
• type NamespaceConfig
• type NumaflowControllerDefinitionConfig
• type NumaflowControllerDefinitionsManager
  • func (cm *NumaflowControllerDefinitionsManager) GetNumaflowControllerDefinitionsConfig() map[string]string
  • func (cm *NumaflowControllerDefinitionsManager) RemoveNumaflowControllerDefinitionConfig(config NumaflowControllerDefinitionConfig)
  • func (cm *NumaflowControllerDefinitionsManager) UpdateNumaflowControllerDefinitionConfig(config NumaflowControllerDefinitionConfig)
• type Option
  • func WithConfigFileName(configFileName string) Option
  • func WithConfigsPath(configsPath string) Option
• type SpecDataLossField
• type USDEConfig
• type USDEUserStrategy
  • func (s USDEUserStrategy) IsValid() bool
  • func (s *USDEUserStrategy) UnmarshalJSON(data []byte) (err error)

Functions

func CloneWithSerialization

func CloneWithSerialization[T NumaflowControllerDefinitionConfig | GlobalConfig](orig *T) (*T, error)

Types

type ConfigManager

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

func GetConfigManagerInstance

func GetConfigManagerInstance() *ConfigManager

GetConfigManagerInstance returns a singleton config manager throughout the application

func (*ConfigManager) GetConfig

func (cm *ConfigManager) GetConfig() (GlobalConfig, error)

func (*ConfigManager) GetControllerDefinitionsMgr

func (*ConfigManager) GetControllerDefinitionsMgr() *NumaflowControllerDefinitionsManager

func (*ConfigManager) GetNamespaceConfig

func (cm *ConfigManager) GetNamespaceConfig(namespace string) *NamespaceConfig

func (*ConfigManager) GetUSDEConfig

func (cm *ConfigManager) GetUSDEConfig() USDEConfig

func (*ConfigManager) LoadAllConfigs

func (cm *ConfigManager) LoadAllConfigs(
	onErrorReloading func(error),
	options ...Option,
) error

func (*ConfigManager) RegisterCallback

func (cm *ConfigManager) RegisterCallback(f func(config GlobalConfig))

RegisterCallback adds a callback to be called when the config changes

func (*ConfigManager) UnsetNamespaceConfig

func (cm *ConfigManager) UnsetNamespaceConfig(namespace string)

func (*ConfigManager) UnsetUSDEConfig

func (cm *ConfigManager) UnsetUSDEConfig()

func (*ConfigManager) UpdateNamespaceConfig

func (cm *ConfigManager) UpdateNamespaceConfig(namespace string, config NamespaceConfig)

func (*ConfigManager) UpdateUSDEConfig

func (cm *ConfigManager) UpdateUSDEConfig(config USDEConfig)

type GlobalConfig

type GlobalConfig struct {
	LogLevel          int    `json:"logLevel" mapstructure:"logLevel"`
	IncludedResources string `json:"includedResources" mapstructure:"includedResources"`
	// List of Numaflow Controller image names to look for
	NumaflowControllerImageNames []string `json:"numaflowControllerImageNames" mapstructure:"numaflowControllerImageNames"`
	// If user's config doesn't exist or doesn't specify strategy, this is the default
	DefaultUpgradeStrategy USDEUserStrategy `json:"defaultUpgradeStrategy" mapstructure:"defaultUpgradeStrategy"`
}

GlobalConfig is the configuration for the controllers, it is supposed to be populated from the configmap attached to the controller manager.

type NamespaceConfig

type NamespaceConfig struct {
	UpgradeStrategy USDEUserStrategy `json:"upgradeStrategy,omitempty" yaml:"upgradeStrategy,omitempty"`
}

type NumaflowControllerDefinitionConfig

type NumaflowControllerDefinitionConfig struct {
	ControllerDefinitions []apiv1.ControllerDefinitions `json:"controllerDefinitions" yaml:"controllerDefinitions"`
}

type NumaflowControllerDefinitionsManager

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

func (*NumaflowControllerDefinitionsManager) GetNumaflowControllerDefinitionsConfig

func (cm *NumaflowControllerDefinitionsManager) GetNumaflowControllerDefinitionsConfig() map[string]string

func (*NumaflowControllerDefinitionsManager) RemoveNumaflowControllerDefinitionConfig

func (cm *NumaflowControllerDefinitionsManager) RemoveNumaflowControllerDefinitionConfig(config NumaflowControllerDefinitionConfig)

func (*NumaflowControllerDefinitionsManager) UpdateNumaflowControllerDefinitionConfig

func (cm *NumaflowControllerDefinitionsManager) UpdateNumaflowControllerDefinitionConfig(config NumaflowControllerDefinitionConfig)

type Option

type Option func(*options)

func WithConfigFileName

func WithConfigFileName(configFileName string) Option

func WithConfigsPath

func WithConfigsPath(configsPath string) Option

type SpecDataLossField

type SpecDataLossField struct {
	Path             string `json:"path" yaml:"path"`
	IncludeSubfields bool   `json:"includeSubfields,omitempty" yaml:"includeSubfields,omitempty"`
}

type USDEConfig

type USDEConfig struct {
	PipelineSpecDataLossFields   []SpecDataLossField `json:"pipelineSpecDataLossFields,omitempty" yaml:"pipelineSpecDataLossFields,omitempty"`
	ISBServiceSpecDataLossFields []SpecDataLossField `json:"isbServiceSpecDataLossFields,omitempty" yaml:"isbServiceSpecDataLossFields,omitempty"`
}

type USDEUserStrategy

type USDEUserStrategy string

const (
	ProgressiveStrategyID USDEUserStrategy = "progressive"
	PPNDStrategyID        USDEUserStrategy = "pause-and-drain"
	NoStrategyID          USDEUserStrategy = "no-strategy"
)

func (USDEUserStrategy) IsValid

func (s USDEUserStrategy) IsValid() bool

func (*USDEUserStrategy) UnmarshalJSON

func (s *USDEUserStrategy) UnmarshalJSON(data []byte) (err error)