Documentation ¶
Overview ¶
Package config provides utility objects for decoupling sources of configuration and the actual configuration state. Consumers must implement the Merger interface to unify the sources of change into an object.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
// DefaultFeatureGate is a shared global FeatureGate.
DefaultFeatureGate = &featureGate{
known: knownFeatures,
special: specialFeatures,
}
)
Functions ¶
This section is empty.
Types ¶
type Accessor ¶
type Accessor interface { // MergedState returns a representation of the current merge state. // Must be reentrant when more than one source is defined. MergedState() interface{} }
Accessor is an interface for retrieving the current merge state.
type AccessorFunc ¶
type AccessorFunc func() interface{}
AccessorFunc implements the Accessor interface.
func (AccessorFunc) MergedState ¶
func (f AccessorFunc) MergedState() interface{}
type Broadcaster ¶ added in v0.7.0
type Broadcaster struct {
// contains filtered or unexported fields
}
func NewBroadcaster ¶ added in v0.7.0
func NewBroadcaster() *Broadcaster
NewBroadcaster registers a set of listeners that support the Listener interface and notifies them all on changes.
func (*Broadcaster) Add ¶ added in v0.7.0
func (b *Broadcaster) Add(listener Listener)
Add registers listener to receive updates of changes.
func (*Broadcaster) Notify ¶ added in v0.7.0
func (b *Broadcaster) Notify(instance interface{})
Notify notifies all listeners.
type ConfigurationMap ¶ added in v1.3.0
func (*ConfigurationMap) Set ¶ added in v1.3.0
func (m *ConfigurationMap) Set(value string) error
func (*ConfigurationMap) String ¶ added in v1.3.0
func (m *ConfigurationMap) String() string
func (*ConfigurationMap) Type ¶ added in v1.3.0
func (*ConfigurationMap) Type() string
type FeatureGate ¶
type FeatureGate interface { AddFlag(fs *pflag.FlagSet) // owner: @timstclair // beta: v1.4 AppArmor() bool // owner: @girishkalele // alpha: v1.4 ExternalTrafficLocalOnly() bool // owner: @saad-ali // alpha: v1.3 DynamicVolumeProvisioning() bool // owner: mtaufen // alpha: v1.4 DynamicKubeletConfig() bool }
FeatureGate parses and stores flag gates for known features from a string like feature1=true,feature2=false,...
type Listener ¶
type Listener interface {
// OnUpdate is invoked when a change is made to an object.
OnUpdate(instance interface{})
}
type ListenerFunc ¶
type ListenerFunc func(instance interface{})
ListenerFunc receives a representation of the change or object.
func (ListenerFunc) OnUpdate ¶
func (f ListenerFunc) OnUpdate(instance interface{})
type Mux ¶
type Mux struct {
// contains filtered or unexported fields
}
Mux is a class for merging configuration from multiple sources. Changes are pushed via channels and sent to the merge function.
func (*Mux) Channel ¶
Channel returns a channel where a configuration source can send updates of new configurations. Multiple calls with the same source will return the same channel. This allows change and state based sources to use the same channel. Different source names however will be treated as a union.