config

Documentation

Overview

Package config is designed to listen to the config changes through the store and create a fully-resolved configuration state that can be used by the rest of the runtime code.

The main purpose of this library is to create an object-model that simplifies queries and correctness checks that the client code needs to deal with. This is accomplished by making sure the config state is fully resolved, and incorporating otherwise complex queries within this package.

Index

• func BuildHandler(handler *HandlerStatic, instances []*InstanceStatic, env adapter.Env, ...) (h adapter.Handler, err error)
• func ExtractShortName(name string) string
• func GetAdapterCfgDescriptor(base64Tmpl string) (*descriptor.FileDescriptorSet, *descriptor.FileDescriptorProto, error)
• func GetInstancesGroupedByHandlers(s *Snapshot) map[*HandlerStatic][]*InstanceStatic
• func GetInstancesGroupedByHandlersDynamic(s *Snapshot) map[*HandlerDynamic][]*InstanceDynamic
• func GetTmplDescriptor(base64Tmpl string) (*descriptor.FileDescriptorSet, *descriptor.FileDescriptorProto, string, ...)
• func KindMap(adapterInfo map[string]*adapter.Info, templateInfo map[string]*template.Info) map[string]proto.Message
• func ValidateBuilder(handler *HandlerStatic, instances []*InstanceStatic, ...) (hb adapter.HandlerBuilder, err error)
• type ActionDynamic
• type ActionStatic
• type Adapter
• type Counters
• type Ephemeral
  • func NewEphemeral(templates map[string]*template.Info, adapters map[string]*adapter.Info) *Ephemeral
  • func (e *Ephemeral) ApplyEvent(events []*store.Event)
  • func (e *Ephemeral) BuildSnapshot() (*Snapshot, error)
  • func (e *Ephemeral) GetEntry(event *store.Event) (*store.Resource, bool)
  • func (e *Ephemeral) SetState(state map[store.Key]*store.Resource)
• type HandlerDynamic
  • func (h HandlerDynamic) AdapterName() string
  • func (h HandlerDynamic) AdapterParams() interface{}
  • func (h HandlerDynamic) GetName() string
• type HandlerStatic
  • func (h HandlerStatic) AdapterName() string
  • func (h HandlerStatic) AdapterParams() interface{}
  • func (h HandlerStatic) GetName() string
• type InstanceDynamic
  • func (i InstanceDynamic) GetName() string
  • func (i InstanceDynamic) TemplateName() string
  • func (i InstanceDynamic) TemplateParams() interface{}
• type InstanceStatic
  • func (i InstanceStatic) GetName() string
  • func (i InstanceStatic) TemplateName() string
  • func (i InstanceStatic) TemplateParams() interface{}
• type Rule
• type Snapshot
  • func Empty() *Snapshot
  • func GetSnapshotForTest(templates map[string]*template.Info, adapters map[string]*adapter.Info, ...) (*Snapshot, error)
  • func (s *Snapshot) String() string
• type Template

Functions

func BuildHandler

func BuildHandler(
	handler *HandlerStatic,
	instances []*InstanceStatic,
	env adapter.Env, templates map[string]*template.Info) (h adapter.Handler, err error)

BuildHandler instantiates a handler object using the passed in handler and instances configuration.

func ExtractShortName

func ExtractShortName(name string) string

ExtractShortName extracts the 'name' portion of the FQN.

func GetAdapterCfgDescriptor

func GetAdapterCfgDescriptor(base64Tmpl string) (*descriptor.FileDescriptorSet, *descriptor.FileDescriptorProto, error)

GetAdapterCfgDescriptor find an adapter configuration descriptor

func GetInstancesGroupedByHandlers

func GetInstancesGroupedByHandlers(s *Snapshot) map[*HandlerStatic][]*InstanceStatic

GetInstancesGroupedByHandlers queries the snapshot and returns all used instances, grouped by the handlers that will receive them.

func GetInstancesGroupedByHandlersDynamic

func GetInstancesGroupedByHandlersDynamic(s *Snapshot) map[*HandlerDynamic][]*InstanceDynamic

GetInstancesGroupedByHandlersDynamic queries the snapshot and returns all used instances, grouped by the handlers that will receive them.

func GetTmplDescriptor

func GetTmplDescriptor(base64Tmpl string) (*descriptor.FileDescriptorSet, *descriptor.FileDescriptorProto, string, tmpl.TemplateVariety, error)

GetTmplDescriptor find a template descriptor

func KindMap

func KindMap(adapterInfo map[string]*adapter.Info, templateInfo map[string]*template.Info) map[string]proto.Message

KindMap generates a map from object kind to its proto message.

func ValidateBuilder

func ValidateBuilder(
	handler *HandlerStatic,
	instances []*InstanceStatic, templates map[string]*template.Info) (hb adapter.HandlerBuilder, err error)

ValidateBuilder constructs and validates a builder.

Types

type ActionDynamic

type ActionDynamic struct {
	// Handler that this action is resolved to.
	Handler *HandlerDynamic
	// Instances that should be generated as part of invoking action.
	Instances []*InstanceDynamic
}

ActionDynamic configuration. Fully resolved.

type ActionStatic

type ActionStatic struct {
	// Handler that this action is resolved to.
	Handler *HandlerStatic

	// Instances that should be generated as part of invoking action.
	Instances []*InstanceStatic
}

ActionStatic configuration. Fully resolved.

type Adapter

type Adapter struct {
	Name string

	// Adapter's file descriptor set.
	ConfigDescSet *descriptor.FileDescriptorSet

	// package name of the `Params` message
	PackageName string

	SupportedTemplates []*Template

	SessionBased bool

	Description string
}

Adapter contains info about an adapter

type Counters

type Counters struct {

	// Externally visible counters
	MatchErrors               prometheus.Counter
	UnsatisfiedActionHandlers prometheus.Counter
	HandlerValidationError    prometheus.Counter
	// contains filtered or unexported fields
}

Counters is the configuration related performance Counters. Other parts of the code can depend on some of the Counters here as well.

type Ephemeral

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

Ephemeral configuration state that gets updated by incoming config change events. By itself, the data contained is not meaningful. BuildSnapshot must be called to create a new snapshot instance, which contains fully resolved config. The Ephemeral is thread safe, which mean the state can be incrementally built asynchronously, before calling BuildSnapshot, using ApplyEvent.

func NewEphemeral

func NewEphemeral(
	templates map[string]*template.Info,
	adapters map[string]*adapter.Info) *Ephemeral

NewEphemeral returns a new Ephemeral instance.

NOTE: initial state is computed even if there are errors in the config. Configuration that has errors is reported in the returned error object, and is ignored in the snapshot creation.

func (*Ephemeral) ApplyEvent

func (e *Ephemeral) ApplyEvent(events []*store.Event)

ApplyEvent to the internal ephemeral state. This gets called by an external event listener to relay store change events to this ephemeral config object.

func (*Ephemeral) BuildSnapshot

func (e *Ephemeral) BuildSnapshot() (*Snapshot, error)

BuildSnapshot builds a stable, fully-resolved snapshot view of the configuration.

func (*Ephemeral) GetEntry

func (e *Ephemeral) GetEntry(event *store.Event) (*store.Resource, bool)

GetEntry returns the value stored for the key in the ephemeral.

func (*Ephemeral) SetState

func (e *Ephemeral) SetState(state map[store.Key]*store.Resource)

SetState with the supplied state map. All existing ephemeral state is overwritten.

type HandlerDynamic

type HandlerDynamic struct {
	Name string

	Adapter *Adapter

	// AdapterConfig used to construct the Handler. This is passed in verbatim to the remote adapter.
	AdapterConfig *types.Any

	// Connection information for the handler.
	Connection *v1beta1.Connection
}

HandlerDynamic configuration for dynamically loaded, grpc adapters. Fully resolved.

func (HandlerDynamic) AdapterName

func (h HandlerDynamic) AdapterName() string

AdapterName gets adapter name

func (HandlerDynamic) AdapterParams

func (h HandlerDynamic) AdapterParams() interface{}

AdapterParams gets AdapterParams

func (HandlerDynamic) GetName

func (h HandlerDynamic) GetName() string

GetName gets name

type HandlerStatic

type HandlerStatic struct {

	// Name of the Handler. Fully qualified.
	Name string

	// Associated adapter. Always resolved.
	Adapter *adapter.Info

	// parameters used to construct the Handler.
	Params proto.Message
}

HandlerStatic configuration for compiled in adapters. Fully resolved.

func (HandlerStatic) AdapterName

func (h HandlerStatic) AdapterName() string

AdapterName gets adapter name

func (HandlerStatic) AdapterParams

func (h HandlerStatic) AdapterParams() interface{}

AdapterParams gets AdapterParams

func (HandlerStatic) GetName

func (h HandlerStatic) GetName() string

GetName gets name

type InstanceDynamic

type InstanceDynamic struct {
	Name string

	Template *Template

	// Encoder to create request instance bytes from attributes
	Encoder dynamic.Encoder

	// Params of the instance; used to to create the config SHA.
	Params map[string]interface{}
}

InstanceDynamic configuration for dynamically loaded templates. Fully resolved.

func (InstanceDynamic) GetName

func (i InstanceDynamic) GetName() string

GetName gets name

func (InstanceDynamic) TemplateName

func (i InstanceDynamic) TemplateName() string

TemplateName gets TemplateName

func (InstanceDynamic) TemplateParams

func (i InstanceDynamic) TemplateParams() interface{}

TemplateParams gets TemplateParams

type InstanceStatic

type InstanceStatic struct {
	// Name of the instance. Fully qualified.
	Name string

	// Associated template. Always resolved.
	Template *template.Info

	// parameters used to construct the instance.
	Params proto.Message

	// inferred type for the instance.
	InferredType proto.Message
}

InstanceStatic configuration for compiled templates. Fully resolved.

func (InstanceStatic) GetName

func (i InstanceStatic) GetName() string

GetName gets name

func (InstanceStatic) TemplateName

func (i InstanceStatic) TemplateName() string

TemplateName gets TemplateName

func (InstanceStatic) TemplateParams

func (i InstanceStatic) TemplateParams() interface{}

TemplateParams gets TemplateParams

type Rule

type Rule struct {
	// Name of the rule
	Name string

	// Namespace of the rule
	Namespace string

	// Match condition
	Match string

	ActionsDynamic []*ActionDynamic

	ActionsStatic []*ActionStatic
}

Rule configuration. Fully resolved.

type Snapshot

type Snapshot struct {
	ID int64

	// Static information
	Templates map[string]*template.Info
	Adapters  map[string]*adapter.Info

	// Config store based information
	Attributes ast.AttributeDescriptorFinder

	HandlersStatic  map[string]*HandlerStatic
	InstancesStatic map[string]*InstanceStatic

	//  TemplateMetadatas contains template descriptors loaded from the store
	TemplateMetadatas map[string]*Template
	//  AdapterMetadatas contains adapter metadata loaded from the store
	AdapterMetadatas map[string]*Adapter

	HandlersDynamic  map[string]*HandlerDynamic
	InstancesDynamic map[string]*InstanceDynamic
	Rules            []*Rule

	// Perf Counters relevant to configuration.
	Counters Counters
}

Snapshot view of configuration.

func Empty

func Empty() *Snapshot

Empty returns a new, empty configuration snapshot.

func GetSnapshotForTest

func GetSnapshotForTest(templates map[string]*template.Info, adapters map[string]*adapter.Info, serviceConfig string, globalConfig string) (*Snapshot, error)

GetSnapshotForTest creates a config.Snapshot for testing purposes, based on the supplied configuration.

func (*Snapshot) String

func (s *Snapshot) String() string

String writes out contents of a snapshot in a stable way. Useful for quickly writing out contents in a string for comparison testing.

type Template

type Template struct {
	// Name of the template.
	//
	// Note this is the template's resource name and not the template's internal name that adapter developer
	// uses to implement adapter service.
	Name string

	// Variety of this template
	Variety adptTmpl.TemplateVariety

	// InternalPackageDerivedName is the name of the template from adapter developer point of view.
	// The service and functions implemented by the adapter is based on this name
	// NOTE: This name derived from template proto package and not the resource name.
	InternalPackageDerivedName string

	// Template's file descriptor set.
	FileDescSet *descriptor.FileDescriptorSet

	// package name of the `Template` message
	PackageName string
}

Template contains info about a template