plugins

Documentation

Index

• type Plugin
• type PluginContext
• type PluginFactoryFn

Types

type Plugin

type Plugin interface {
	// Name is the name of plugin, must be unique.
	Name() string
	// Start is called to run this plugin.
	Start() error
	// Stop is called to stop this plugin.
	Stop() error
	// Feature returns feature name of this plugin.
	Feature() featuregate.Feature
}

Plugin interface contains methods which must be implemented by all plugins.

type PluginContext

type PluginContext struct {
	K8sClient      k8s.K8sClient
	StatesInformer statesinformer.StatesInformer
	MetricCache    metriccache.MetricCache
	MetricsQuery   metricsquery.MetricsQuery
	// Extra custom configuration for plugin.
	ExtraConfig *string
}

type PluginFactoryFn

type PluginFactoryFn func(ctx *PluginContext) Plugin