plugins

Documentation

Index

• Constants
• Variables
• func CheckAvailability(ctx context.Context, cc *grpc.ClientConn, id string) error
• func ClientConfig(md meta.PluginMeta, scheme meta.Scheme, opts ...ClientOption) *plugin.ClientConfig
• func ConfigureSysProcAttr(cmd *exec.Cmd)
• func Serve(scheme meta.Scheme)
• func ServeConfig(scheme meta.Scheme) *plugin.ServeConfig
• type ClientOption
  • func WithReattachConfig(reattach *plugin.ReattachConfig) ClientOption
  • func WithSecureConfig(sc *plugin.SecureConfig) ClientOption
• type ClientOptions
• type DiscoveryConfig
  • func (dc DiscoveryConfig) Discover() []meta.PluginMeta
• type Filter
• type LoadOption
  • func WithClientOptions(clientOptions ...ClientOption) LoadOption
  • func WithManifest(manifest *controlv1.UpdateManifest) LoadOption
• type LoadOptions
• type LoaderInterface
• type Main
  • func (m *Main) Exec()
• type PluginLoader
  • func NewPluginLoader(opts ...PluginLoaderOption) *PluginLoader
  • func (p *PluginLoader) Complete()
  • func (p *PluginLoader) Hook(h any)
  • func (p *PluginLoader) LoadOne(ctx context.Context, md meta.PluginMeta, cc *plugin.ClientConfig)
  • func (p *PluginLoader) LoadPlugins(ctx context.Context, pluginDir string, scheme meta.Scheme, opts ...LoadOption)
• type PluginLoaderOption
  • func WithLogger(lg *slog.Logger) PluginLoaderOption
• type PluginLoaderOptions

Constants

const DefaultPluginGlob = "plugin_*"

Variables

var (
	GatewayScheme = meta.NewScheme(meta.WithMode(meta.ModeGateway))
	AgentScheme   = meta.NewScheme(meta.WithMode(meta.ModeAgent))
)

var ErrNotImplemented = errors.New("not implemented")

var Handshake = plugin.HandshakeConfig{
	ProtocolVersion:  plugin.CoreProtocolVersion,
	MagicCookieKey:   "OPNI_MAGIC_COOKIE",
	MagicCookieValue: "opni",
}

var NoopLoader = noopLoader{}

Functions

func CheckAvailability

func CheckAvailability(ctx context.Context, cc *grpc.ClientConn, id string) error

func ClientConfig

func ClientConfig(md meta.PluginMeta, scheme meta.Scheme, opts ...ClientOption) *plugin.ClientConfig

func ConfigureSysProcAttr

func ConfigureSysProcAttr(cmd *exec.Cmd)

func Serve

func Serve(scheme meta.Scheme)

func ServeConfig

func ServeConfig(scheme meta.Scheme) *plugin.ServeConfig

Types

type ClientOption

type ClientOption func(*ClientOptions)

func WithReattachConfig

func WithReattachConfig(reattach *plugin.ReattachConfig) ClientOption

func WithSecureConfig

func WithSecureConfig(sc *plugin.SecureConfig) ClientOption

type ClientOptions

type ClientOptions struct {
	// contains filtered or unexported fields
}

type DiscoveryConfig

type DiscoveryConfig struct {
	// Directory to search for plugins
	Dir string
	// Optional filesystem (defaults to os filesystem)
	Fs afero.Fs
	// Optional filters to allow excluding plugins from discovery
	Filters []Filter
	// If true, query the plugin for its supported modes. The available modes
	// will be stored in the plugin's ExtendedMetadata and can be used in filters.
	QueryModes bool
	// Optional logger, defaults to no logging
	Logger *slog.Logger
}

func (DiscoveryConfig) Discover

func (dc DiscoveryConfig) Discover() []meta.PluginMeta

type Filter

type Filter = func(meta.PluginMeta) bool

type LoadOption

type LoadOption func(*LoadOptions)

func WithClientOptions

func WithClientOptions(clientOptions ...ClientOption) LoadOption

func WithManifest

func WithManifest(manifest *controlv1.UpdateManifest) LoadOption

WithManifest will use the provided manifest to restrict the set of plugins that can be loaded, and verify plugin checksums before loading. If this option is not provided, plugins will be loaded without any restrictions or verification.

type LoadOptions

type LoadOptions struct {
	// contains filtered or unexported fields
}

type LoaderInterface

type LoaderInterface interface {
	// Adds a hook to the loader, which will be invoked at a specific time according
	// to the hook type. See the specific hooks for more information.
	Hook(h any)
}

type Main

type Main struct {
	Modes meta.ModeSet
}

func (*Main) Exec

func (m *Main) Exec()

type PluginLoader

type PluginLoader struct {
	PluginLoaderOptions
	// contains filtered or unexported fields
}

func NewPluginLoader

func NewPluginLoader(opts ...PluginLoaderOption) *PluginLoader

func (*PluginLoader) Complete

func (p *PluginLoader) Complete()

Complete marks the plugin loader as completed. This function will be called automatically by LoadPlugins(), although it can be called manually if LoadPlugins() is not used. It is not safe to call this function and LoadPlugins() on the same plugin loader. It will invoke LoadingCompletedHooks in parallel and does not block.

func (*PluginLoader) Hook

func (p *PluginLoader) Hook(h any)

func (*PluginLoader) LoadOne

func (p *PluginLoader) LoadOne(ctx context.Context, md meta.PluginMeta, cc *plugin.ClientConfig)

LoadOne loads a single plugin. It invokes PluginLoadHooks for the type of the plugin being loaded and will block until all load hooks have completed.

func (*PluginLoader) LoadPlugins

func (p *PluginLoader) LoadPlugins(ctx context.Context, pluginDir string, scheme meta.Scheme, opts ...LoadOption)

LoadPlugins loads a set of plugins defined by the plugin configuration. This function loads plugins in parallel and does not block. It will invoke LoadingCompletedHooks once all plugins have been loaded. Once this function is called, it is unsafe to call LoadPlugins() or LoadOne() again for this plugin loader, although new hooks can still be added and will be invoked immediately according to the current state of the plugin loader.

type PluginLoaderOption

type PluginLoaderOption func(*PluginLoaderOptions)

func WithLogger

func WithLogger(lg *slog.Logger) PluginLoaderOption

type PluginLoaderOptions

type PluginLoaderOptions struct {
	// contains filtered or unexported fields
}