Documentation ¶
Overview ¶
Package plugins contains the interface for using plugins to extend the functionality of the node.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrUnsupported is returned when a plugin capability is not supported // by any of the registered plugins. ErrUnsupported = status.Error(codes.Unimplemented, "unsupported plugin capability") )
Functions ¶
Types ¶
type Config ¶
type Config struct { // Plugin is an inline plugin implementation. Plugin v1.PluginServer `yaml:"-" json:"-" toml:"-" mapstructure:"-"` // Path is the path to an executable for the plugin. Path string `yaml:"path,omitempty" json:"path,omitempty" toml:"path,omitempty" mapstructure:"path,omitempty"` // Server is the address of a server for the plugin. Server string `yaml:"server,omitempty" json:"server,omitempty" toml:"server,omitempty" mapstructure:"server,omitempty"` // Insecure is whether to use an insecure connection to the plugin server. Insecure bool `yaml:"insecure,omitempty" json:"insecure,omitempty" toml:"insecure,omitempty" mapstructure:"insecure,omitempty"` // TLSCAFile is the path to a CA for verifying certificates. TLSCAFile string `yaml:"tls-ca-file,omitempty" json:"tls-ca-file,omitempty" toml:"tls-ca-file,omitempty" mapstructure:"tls-ca-file,omitempty"` // TLSCertFile is the path to a certificate for authenticating to the plugin server. TLSCertFile string `` /* 131-byte string literal not displayed */ // TLSKeyFile is the path to a key for authenticating to the plugin server. TLSKeyFile string `` /* 127-byte string literal not displayed */ // TLSSkipVerify is whether to skip verifying the plugin server's certificate. TLSSkipVerify bool `` /* 139-byte string literal not displayed */ // Config is the configuration for the plugin. Config map[string]any `yaml:"config,omitempty" json:"config,omitempty" toml:"config,omitempty" mapstructure:"config,omitempty"` }
Config is the configuration for a plugin.
type Manager ¶
type Manager interface { // Get returns the plugin with the given name. Get(name string) (v1.PluginClient, bool) // ServeStorage handles queries from plugins against the given storage backend. ServeStorage(db storage.Storage) // HasAuth returns true if the manager has an auth plugin. HasAuth() bool // HasWatchers returns true if the manager has any watch plugins. HasWatchers() bool // AuthUnaryInterceptor returns a unary interceptor for the configured auth plugin. // If no plugin is configured, the returned function is a pass-through. AuthUnaryInterceptor() grpc.UnaryServerInterceptor // AuthStreamInterceptor returns a stream interceptor for the configured auth plugin. // If no plugin is configured, the returned function is a pass-through. AuthStreamInterceptor() grpc.StreamServerInterceptor // AllocateIP calls the configured IPAM plugin to allocate an IP address for the given request. // If the requested version does not have a registered plugin, ErrUnsupported is returned. AllocateIP(ctx context.Context, req *v1.AllocateIPRequest) (netip.Prefix, error) // ApplyRaftLog applies a raft log entry to all storage plugins. Responses are still returned // even if an error occurs. ApplyRaftLog(ctx context.Context, entry *v1.StoreLogRequest) ([]*v1.RaftApplyResponse, error) // ApplySnapshot applies a snapshot to all storage plugins. ApplySnapshot(ctx context.Context, meta *raft.SnapshotMeta, data io.ReadCloser) error // Emit emits an event to all watch plugins. Emit(ctx context.Context, ev *v1.Event) error // Close closes all plugins. Close() error }
Manager is the interface for managing plugins.
type Options ¶
type Options struct { // Plugins is a map of plugin names to plugin configs. Plugins map[string]*Config `yaml:",inline" json:",inline" toml:",inline" mapstructure:",squash"` }
Options are the options for loading plugins.
Directories ¶
Path | Synopsis |
---|---|
Package builtins contains the built-in plugin implementations.
|
Package builtins contains the built-in plugin implementations. |
basicauth
Package basicauth is an authentication plugin that uses basic auth.
|
Package basicauth is an authentication plugin that uses basic auth. |
debug
Package debug implements a plugin that exposes an HTTP server for debugging purposes.
|
Package debug implements a plugin that exposes an HTTP server for debugging purposes. |
ipam
Package ipam provides a plugin for simple mesh IPAM.
|
Package ipam provides a plugin for simple mesh IPAM. |
ldap
Package ldap implements a basic LDAP authentication plugin.
|
Package ldap implements a basic LDAP authentication plugin. |
mtls
Package mtls is an authentication plugin that uses mTLS.
|
Package mtls is an authentication plugin that uses mTLS. |
Package clients contains the interface for using plugin clients.
|
Package clients contains the interface for using plugin clients. |
Package plugindb contains a SQL driver for running data queries over a Plugin Query stream.
|
Package plugindb contains a SQL driver for running data queries over a Plugin Query stream. |
Click to show internal directories.
Click to hide internal directories.