plugin

Documentation

Index

• Variables
• type InitContext
• type Plugin
  • func (p *Plugin) Instance() (interface{}, error)
• type Registration
  • func (r *Registration) Init(ic *InitContext) *Plugin
• type ResourceRegister
  • func (reg *ResourceRegister) List() []*Registration
  • func (reg *ResourceRegister) Register(r *Registration)

Variables

var (
	// ErrNoPluginID is returned when no id is specified
	ErrNoPluginID = pkgerr.New("plugin: no id")
)

Types

type InitContext

type InitContext struct {
	Context    context.Context
	Config     interface{}
	Client     clientset.Interface
	Informer   informers.SharedInformerFactory
	VCClient   vcclient.Interface
	VCInformer vcinformers.VirtualClusterInformer
}

InitContext is used for plugin initialization

type Plugin

type Plugin struct {
	Registration *Registration // registration, as initialized
	// contains filtered or unexported fields
}

Plugin represents an initialized plugin, used with an init context.

func (*Plugin) Instance

func (p *Plugin) Instance() (interface{}, error)

Instance returns the instance and any initialization error of the plugin

type Registration

type Registration struct {
	// ID of the plugin
	ID string

	// InitFn is called when initializing a plugin. The registration and
	// context are passed in.
	InitFn func(*InitContext) (interface{}, error)
	// Disable the plugin from loading
	Disable bool
}

Registration contains information for registering a plugin

func (*Registration) Init

func (r *Registration) Init(ic *InitContext) *Plugin

Init the registered plugin

type ResourceRegister

type ResourceRegister struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

var SyncerResourceRegister ResourceRegister

func (*ResourceRegister) List

func (reg *ResourceRegister) List() []*Registration

List returns the list of registered plugins for initialization.

func (*ResourceRegister) Register

func (reg *ResourceRegister) Register(r *Registration)

Register allows plugins to register