orchestrator

Documentation

Index

• Variables
• func ContainsItemID(want []*generic.Item_ID, have *generic.Item_ID) bool
• func EnabledGrpcMetrics()
• func HasCorrectLabels(want map[string]string, have Labels) bool
• func UnmarshalLazyValue(key string, lazy datasync.LazyValue) (proto.Message, error)
• type Deps
• type Dispatcher
• type KLStore
• type KVPairs
• type KVStore
• type KeyVal
• type Labels
• type Option
  • func UseReflection(enabled bool) Option
• type Plugin
  • func NewPlugin(opts ...Option) *Plugin
  • func (p *Plugin) AfterInit() (err error)
  • func (p *Plugin) Close() (err error)
  • func (p Plugin) GetStatus(key string) (*Status, error)
  • func (p *Plugin) Init() (err error)
  • func (p *Plugin) InitialSync() error
  • func (p Plugin) ListData() KVPairs
  • func (p Plugin) ListLabels(key string) Labels
  • func (p Plugin) ListState() (KVPairs, error)
  • func (p Plugin) PushData(ctx context.Context, kvPairs []KeyVal, keyLabels map[string]Labels) (results []Result, err error)
• type Result
• type Status
• type Store

Variables

var DefaultPlugin = *NewPlugin()

DefaultPlugin is default instance of Plugin

var (
	// EnableStatusPublishing enables status publishing.
	EnableStatusPublishing = os.Getenv("ENABLE_STATUS_PUBLISHING") != ""
)

Functions

func ContainsItemID

func ContainsItemID(want []*generic.Item_ID, have *generic.Item_ID) bool

func EnabledGrpcMetrics

func EnabledGrpcMetrics()

func HasCorrectLabels

func HasCorrectLabels(want map[string]string, have Labels) bool

func UnmarshalLazyValue

func UnmarshalLazyValue(key string, lazy datasync.LazyValue) (proto.Message, error)

UnmarshalLazyValue is helper function for unmarshalling from datasync.LazyValue.

Types

type Deps

type Deps struct {
	infra.PluginDeps

	GRPC            grpc.Server
	KVScheduler     kvs.KVScheduler
	Watcher         datasync.KeyValProtoWatcher
	StatusPublisher datasync.KeyProtoValWriter
}

Deps represents dependencies for the plugin.

type Dispatcher

type Dispatcher interface {
	ListData() KVPairs
	PushData(context.Context, []KeyVal, map[string]Labels) ([]Result, error)
	GetStatus(key string) (*Status, error)
	ListState() (KVPairs, error)
	ListLabels(key string) Labels
}

type KLStore

type KLStore interface {
	ListLabels(key string) Labels
	AddLabel(key, lkey, lval string)
	HasLabel(key, lkey string) bool
	DeleteLabel(key, lkey string)
	ResetLabels(key string)
}

KLStore describes an interface for key-label store used by dispatcher.

type KVPairs

type KVPairs map[string]proto.Message

KVPairs represents key-value pairs.

type KVStore

type KVStore interface {
	ListAll() KVPairs
	List(dataSrc string) KVPairs
	Update(dataSrc, key string, val proto.Message)
	Delete(dataSrc, key string)
	Reset(dataSrc string)
}

KVStore describes an interface for key-value store used by dispatcher.

type KeyVal

type KeyVal struct {
	Key string
	Val proto.Message
}

KeyVal associates value with its key.

type Labels

type Labels map[string]string

Label is string key-value pair associated with configuration item. Label key format guidelines: label key should be a lower-case alphanumeric string which may contain periods and hyphens (but it should not contain consecutive periods/hyphens and it should not start with period/hyphen). Labels for configuration items should be prefixed with the reverse DNS notation of a domain they originate from (with domain owner's permission) for example: com.example.foo-bar-label. The io.ligato.* and ligato.* prefixes are reserved by vpp-agent for internal use.

type Option

type Option func(*Plugin)

Option is a function that acts on a Plugin to inject Dependencies or configuration

func UseReflection

func UseReflection(enabled bool) Option

type Plugin

type Plugin struct {
	Deps
	// contains filtered or unexported fields
}

Plugin implements sync service for GRPC.

func NewPlugin

func NewPlugin(opts ...Option) *Plugin

NewPlugin creates a new Plugin with the provides Options

func (*Plugin) AfterInit

func (p *Plugin) AfterInit() (err error)

AfterInit subscribes to known NB prefixes.

func (*Plugin) Close

func (p *Plugin) Close() (err error)

func (Plugin) GetStatus

func (p Plugin) GetStatus(key string) (*Status, error)

func (*Plugin) Init

func (p *Plugin) Init() (err error)

Init registers the service to GRPC server.

func (*Plugin) InitialSync

func (p *Plugin) InitialSync() error

InitialSync will start initial synchronization.

func (Plugin) ListData

func (p Plugin) ListData() KVPairs

ListData retrieves actual data.

func (Plugin) ListLabels

func (p Plugin) ListLabels(key string) Labels

func (Plugin) ListState

func (p Plugin) ListState() (KVPairs, error)

ListState retrieves running state.

func (Plugin) PushData

func (p Plugin) PushData(ctx context.Context, kvPairs []KeyVal, keyLabels map[string]Labels) (results []Result, err error)

PushData updates actual data.

type Result

type Result struct {
	Key    string
	Status *Status
}

type Status

type Status = kvscheduler.ValueStatus

type Store

type Store interface {
	KLStore
	KVStore
}