config

Documentation

Overview

Package config stores katanomi configuration manager which watch configmap and work immediately if configmap changed

Index

• Constants
• func Name() string
• func WithKatanomiConfigManager(ctx context.Context, manager *Manager) context.Context
• type Config
  • func (c Config) GetBool(key string) (*bool, error)
  • func (c Config) GetObject(key string, object interface{}) error
• type FeatureFlags
  • func (f *FeatureFlags) FeatureValue(flag string) FeatureValue
• type FeatureValue
  • func (f FeatureValue) AsBool() (bool, error)
  • func (f FeatureValue) AsDuration() (time.Duration, error)
  • func (f FeatureValue) AsInt() (int, error)
  • func (f FeatureValue) String() string
• type HasFeatureChangedFunc
• type ListByFeatureFlagChanged
• type Manager
  • func KatanomiConfigManager(ctx context.Context) *Manager
  • func NewManager(informer watcher.DefaultingWatcherWithOnChange, logger *zap.SugaredLogger, ...) *Manager
  • func (manager *Manager) AddWatcher(w Watcher)
  • func (manager *Manager) GetConfig() *Config
  • func (manager *Manager) GetFeatureFlag(flag string) FeatureValue
  • func (manager *Manager) GetFeatureFlagByClient(ctx context.Context, flag string) FeatureValue
  • func (manager *Manager) WatchFeatureFlagChanged(ctx context.Context, listFunc ListByFeatureFlagChanged, ...) (source.Source, handler.EventHandler, builder.WatchesOption)
• type ManagerInterface
• type WatchFunc
• type Watcher
  • func NewConfigWatcher(cb WatchFunc) Watcher

Constants

const (
	// VersionEnabledFeatureKey indicates the configuration key of the version feature gate.
	// If the value is true, the feature is enabled cluster-wide.
	VersionEnabledFeatureKey = "version.enabled"

	// InitializeAllowLocalRequestsFeatureKey indicates the configuration key of.
	// If the value is true, the feature is enabled cluster-wide.
	InitializeAllowLocalRequestsFeatureKey = "plugin.gitlab.allow-local-requests"

	// PrunerDelayAfterCompletedFeatureKey represent taskRun delay configuration key
	PrunerDelayAfterCompletedFeatureKey = "taskRunPruner.delayAfterCompleted"

	// PrunerKeepFeatureKey represent taskRun keep configuration key
	PrunerKeepFeatureKey = "taskRunPruner.keep"

	// BuildMRCheckTimeoutKey represent build merge request status check timeout key
	BuildMRCheckTimeoutKey = "build.mergerequest.checkTimeout"
)

Functions

func Name

func Name() string

Name return config name for configuration

func WithKatanomiConfigManager

func WithKatanomiConfigManager(ctx context.Context, manager *Manager) context.Context

WithKatanomiConfigManager sets a Config Manager instance into a context

Types

type Config

type Config struct {
	Data map[string]string
}

Config store katanomi configuration

func (Config) GetBool

func (c Config) GetBool(key string) (*bool, error)

GetBool will parse value in Config.Data["key"] to bool if the key not exist, it will return nil if the value is not a valid bool string, it will return error

func (Config) GetObject

func (c Config) GetObject(key string, object interface{}) error

GetObject will parse value in Config.Data["key"] to object it expects the value should be yaml content

type FeatureFlags

type FeatureFlags struct {
	Data map[string]string
}

FeatureFlags holds the features configurations

func (*FeatureFlags) FeatureValue

func (f *FeatureFlags) FeatureValue(flag string) FeatureValue

FeatureValue returns the value of the implemented feature flag, or the default if not found.

type FeatureValue

type FeatureValue string

FeatureValue definition of FeatureValue feature value

const (
	// DefaultVersionEnabled indicates the default value of the version feature gate.
	// If the corresponding key does not exist, the default value is returned.
	DefaultVersionEnabled FeatureValue = "false"

	// DefaultInitializeAllowLocalRequests indicates the configuration key of.
	// If the corresponding key does not exist, the default value is returned.
	DefaultInitializeAllowLocalRequests FeatureValue = "true"

	// DefaultPrunerDelayAfterCompleted represent default duration for delay taskRun
	// If the corresponding key does not exist, the default value is returned.
	DefaultPrunerDelayAfterCompleted FeatureValue = "time.Hour"

	// DefaultPrunerKeep represent default keep number for taskRun
	// If the corresponding key does not exist, the default value is returned.
	DefaultPrunerKeep FeatureValue = "10000"

	// DefaultMRCheckTimeout represent default timeout for merge request status check
	DefaultMRCheckTimeout FeatureValue = "10m"
)

func (FeatureValue) AsBool

func (f FeatureValue) AsBool() (bool, error)

AsBool returns as a Bool, or false if the conversion fails.

func (FeatureValue) AsDuration

func (f FeatureValue) AsDuration() (time.Duration, error)

AsBool returns as a Duration, or 0 if the conversion fails.

func (FeatureValue) AsInt

func (f FeatureValue) AsInt() (int, error)

AsInt returned as an integer, or -1 if the conversion fails.

func (FeatureValue) String

func (f FeatureValue) String() string

String returned as a string

type HasFeatureChangedFunc

type HasFeatureChangedFunc func(new *FeatureFlags, old *FeatureFlags) bool

HasFeatureChangedFunc check whether the function switch of interest has changed.

type ListByFeatureFlagChanged

type ListByFeatureFlagChanged func(ctx context.Context) []metav1.Object

ListByFeatureFlagChanged when the function switch is changed, get the object function that triggers reconile.

type Manager

type Manager struct {
	Informer watcher.DefaultingWatcherWithOnChange
	Logger   *zap.SugaredLogger

	*Config
	// contains filtered or unexported fields
}

Manager will manage katanomi configuration and store in Config

func KatanomiConfigManager

func KatanomiConfigManager(ctx context.Context) *Manager

KatanomiConfigManager returns a Config Manager, returns nil if not found

func NewManager

func NewManager(informer watcher.DefaultingWatcherWithOnChange, logger *zap.SugaredLogger, cmName string) *Manager

NewManager will instantiate a manager that watch configmap for core component configuration

func (*Manager) AddWatcher

func (manager *Manager) AddWatcher(w Watcher)

AddWatcher add a watcher to manager the watcher will be called when the configmap is changed

func (*Manager) GetConfig

func (manager *Manager) GetConfig() *Config

GetConfig will return the config of manager

func (*Manager) GetFeatureFlag

func (manager *Manager) GetFeatureFlag(flag string) FeatureValue

GetFeatureFlag get the function switch data, if the function switch is not set, return the default value of the switch.

func (*Manager) GetFeatureFlagByClient

func (manager *Manager) GetFeatureFlagByClient(ctx context.Context, flag string) FeatureValue

GetFeatureFlagByClient get the config configuration by requesting configmap from the client. prioritize the use of GetFeatureFlag, and use the current function in scenarios that require high real-time data.

func (*Manager) WatchFeatureFlagChanged

func (manager *Manager) WatchFeatureFlagChanged(ctx context.Context, listFunc ListByFeatureFlagChanged, featureChanged HasFeatureChangedFunc) (source.Source, handler.EventHandler, builder.WatchesOption)

WatchFeatureFlagChanged trigger reconcile when the function switch is changed.

type ManagerInterface

type ManagerInterface interface {
	GetConfig() *Config
	GetFeatureFlag(flag string) FeatureValue
}

type WatchFunc

type WatchFunc func(*Config)

WatchFunc is the callback function for config watcher

type Watcher

type Watcher interface {
	Watch(config *Config)
}

Watcher describes the interface for config watcher

func NewConfigWatcher

func NewConfigWatcher(cb WatchFunc) Watcher

NewConfigWatcher constructs a new config watcher please note that the callback should be processed quickly and should not block