nsmplugin

Documentation

Index

• Constants
• Variables
• func ServiceLabelForNSMNotifs(groupName string) servicelabel.Option
• type Deps
• type NSMPlugin
  • func NewPlugin(opts ...Option) *NSMPlugin
  • func (p *NSMPlugin) Close() error
  • func (p *NSMPlugin) Init() error
• type Option
  • func WithCustomizedNotifications(kvdb keyval.KvProtoPlugin, groupName string) Option
  • func WithNotifications() Option

Constants

const (
	// PluginName defines name of the NSM Plugin.
	// Config file name is `PluginName + ".conf"`
	PluginName = "nsm-plugin"
)

Variables

var DefaultPlugin = *NewPlugin(WithNotifications())

DefaultPlugin is a default instance of NSMPlugin. Notifications enabled by default for the sake of CNF Provisioner.

Functions

func ServiceLabelForNSMNotifs

func ServiceLabelForNSMNotifs(groupName string) servicelabel.Option

Types

type Deps

type Deps struct {
	infra.PluginDeps
	KVScheduler    kvs.KVScheduler
	NotifPublisher descriptor.NotificationPublisher // optional
}

type NSMPlugin

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

NSMPlugin allows integration with Network Service Mesh.

func NewPlugin

func NewPlugin(opts ...Option) *NSMPlugin

NewPlugin creates a new Plugin with the provides Options

func (*NSMPlugin) Close

func (p *NSMPlugin) Close() error

Close is NOOP.

func (*NSMPlugin) Init

func (p *NSMPlugin) Init() error

Init initializes NSM descriptors.

type Option

type Option func(*NSMPlugin)

Option is a function that can be used in NewPlugin to customize Plugin.

func WithCustomizedNotifications

func WithCustomizedNotifications(kvdb keyval.KvProtoPlugin, groupName string) Option

WithNotifications enables notifications with customized parameters.

func WithNotifications

func WithNotifications() Option

WithNotifications enables notifications with default parameters (etcd DB, global group).