config

Documentation

Overview

Package config holds the typed objects that define the schemas for ConfigMap objects that pertain to our API objects.

Index

• Constants
• func ToContext(ctx context.Context, c *Config) context.Context
• type BrokerConfig
  • func (in *BrokerConfig) DeepCopy() *BrokerConfig
  • func (in *BrokerConfig) DeepCopyInto(out *BrokerConfig)
• type Config
  • func FromContext(ctx context.Context) *Config
  • func FromContextOrDefaults(ctx context.Context) *Config
• type DefaultConfig
  • func (in *DefaultConfig) DeepCopy() *DefaultConfig
  • func (in *DefaultConfig) DeepCopyInto(out *DefaultConfig)
• type Defaults
  • func NewDefaultsConfigFromConfigMap(config *corev1.ConfigMap) (*Defaults, error)
  • func NewDefaultsConfigFromMap(data map[string]string) (*Defaults, error)
  • func (in *Defaults) DeepCopy() *Defaults
  • func (in *Defaults) DeepCopyInto(out *Defaults)
  • func (d *Defaults) GetBrokerClass(ns string) (string, error)
  • func (d *Defaults) GetBrokerConfig(ns string, brokerClassName *string) (*BrokerConfig, error)
• type Store
  • func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value interface{})) *Store
  • func (s *Store) Load() *Config
  • func (s *Store) ToContext(ctx context.Context) context.Context

Constants

const (
	// DefaultsConfigName is the name of config map for the default
	// configs that brokers should use
	DefaultsConfigName = "config-br-defaults"

	// BrokerDefaultsKey is the name of the key that's used for finding
	// defaults for broker configs.
	BrokerDefaultsKey = "default-br-config"
)

Functions

func ToContext

func ToContext(ctx context.Context, c *Config) context.Context

ToContext attaches the provided Config to the provided context, returning the new context with the Config attached.

Types

type BrokerConfig

type BrokerConfig struct {
	*duckv1.KReference `json:",inline"`
	Delivery           *eventingduckv1.DeliverySpec `json:"delivery,omitempty"`
}

BrokerConfig contains configuration for a given broker. Allows configuring the reference to the config it should use and it's delivery.

func (*BrokerConfig) DeepCopy

func (in *BrokerConfig) DeepCopy() *BrokerConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BrokerConfig.

func (*BrokerConfig) DeepCopyInto

func (in *BrokerConfig) DeepCopyInto(out *BrokerConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Config

type Config struct {
	Defaults *Defaults
}

Config holds the collection of configurations that we attach to contexts. +k8s:deepcopy-gen=false

func FromContext

func FromContext(ctx context.Context) *Config

FromContext extracts a Config from the provided context.

func FromContextOrDefaults

func FromContextOrDefaults(ctx context.Context) *Config

FromContextOrDefaults is like FromContext, but when no Config is attached it returns a Config populated with the defaults for each of the Config fields.

type DefaultConfig

type DefaultConfig struct {
	// DefaultBrokerClass and DefaultBrokerClassConfig are the default broker class for the whole cluster/namespace.
	// Users have to specify both of them
	DefaultBrokerClass string `json:"brokerClass,omitempty"`

	//Deprecated: Use the config in BrokerClasses instead
	*BrokerConfig `json:",inline"`

	// Optional: BrokerClasses are the default broker classes' config. The key is the broker class name, and the value is the config for that broker class.
	BrokerClasses map[string]*BrokerConfig `json:"brokerClasses,omitempty"`

	DisallowDifferentNamespaceConfig *bool `json:"disallowDifferentNamespaceConfig,omitempty"`
}

DefaultConfig struct contains the default configuration for the cluster and namespace.

func (*DefaultConfig) DeepCopy

func (in *DefaultConfig) DeepCopy() *DefaultConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DefaultConfig.

func (*DefaultConfig) DeepCopyInto

func (in *DefaultConfig) DeepCopyInto(out *DefaultConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Defaults

type Defaults struct {
	// NamespaceDefaultsConfig are the default Broker Configs for each namespace.
	// Namespace is the key, the value is the NamespaceDefaultConfig
	NamespaceDefaultsConfig map[string]*DefaultConfig `json:"namespaceDefaults,omitempty"`

	// ClusterDefaultConfig is the default broker config for all the namespaces that
	// are not in NamespaceDefaultBrokerConfigs. Different broker class could have
	// different default config.
	ClusterDefaultConfig *DefaultConfig `json:"clusterDefault,omitempty"`
}

Defaults includes the default values to be populated by the webhook.

func NewDefaultsConfigFromConfigMap

func NewDefaultsConfigFromConfigMap(config *corev1.ConfigMap) (*Defaults, error)

NewDefaultsConfigFromConfigMap creates a Defaults from the supplied configMap

func NewDefaultsConfigFromMap

func NewDefaultsConfigFromMap(data map[string]string) (*Defaults, error)

NewDefaultsConfigFromMap creates a Defaults from the supplied Map

func (*Defaults) DeepCopy

func (in *Defaults) DeepCopy() *Defaults

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Defaults.

func (*Defaults) DeepCopyInto

func (in *Defaults) DeepCopyInto(out *Defaults)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Defaults) GetBrokerClass

func (d *Defaults) GetBrokerClass(ns string) (string, error)

GetBrokerClass returns a namespace specific Broker Class, and if that doesn't exist, return a Cluster Default and if the defaults doesn't exist return an error.

func (*Defaults) GetBrokerConfig

func (d *Defaults) GetBrokerConfig(ns string, brokerClassName *string) (*BrokerConfig, error)

GetBrokerConfig returns a namespace specific Broker Config, and if that doesn't exist, return a Cluster Default and if that doesn't exist return an error.

type Store

type Store struct {
	*configmap.UntypedStore
}

Store is a typed wrapper around configmap.Untyped store to handle our configmaps. +k8s:deepcopy-gen=false

func NewStore

func NewStore(logger configmap.Logger, onAfterStore ...func(name string, value interface{})) *Store

NewStore creates a new store of Configs and optionally calls functions when ConfigMaps are updated.

func (*Store) Load

func (s *Store) Load() *Config

Load creates a Config from the current config state of the Store.

func (*Store) ToContext

func (s *Store) ToContext(ctx context.Context) context.Context

ToContext attaches the current Config state to the provided context.