orchestrator

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 ¶ added in v3.5.0

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 ¶ added in v3.5.0

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(enabled bool) Option

type Plugin ¶

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

Plugin implements sync service for GRPC.

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 Result struct {
	Key    string
	Status *Status
}

type Status ¶

type Status = kvscheduler.ValueStatus

type Store ¶ added in v3.5.0

type Store interface {
	KLStore
	KVStore
}