plugins

Documentation

Overview

Package plugins contains the plugin manager.

Package plugins contains the plugin manager.

Index

• Variables
• func NewAuthStreamInterceptor(plugin v1.AuthPluginClient) grpc.StreamServerInterceptor
• func NewAuthUnaryInterceptor(plugin v1.AuthPluginClient) grpc.UnaryServerInterceptor
• func Serve(ctx context.Context, plugin v1.PluginServer) error
• type BuiltinIPAM
  • func NewBuiltinIPAM(opts IPAMConfig) *BuiltinIPAM
  • func (p *BuiltinIPAM) Allocate(ctx context.Context, r *v1.AllocateIPRequest, opts ...grpc.CallOption) (*v1.AllocatedIP, error)
  • func (p *BuiltinIPAM) Release(ctx context.Context, req *v1.ReleaseIPRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
• type IPAMConfig
• type IPAMPlugin
• type Manager
  • func NewManager(ctx context.Context, opts Options) (Manager, error)
  • func NewManagerWithDB(db storage.Provider) Manager
• type NodeConfig
• type Options
• type Plugin

Variables

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

func NewAuthStreamInterceptor

func NewAuthStreamInterceptor(plugin v1.AuthPluginClient) grpc.StreamServerInterceptor

NewAuthStreamInterceptor returns a stream interceptor for the given auth plugin.

func NewAuthUnaryInterceptor

func NewAuthUnaryInterceptor(plugin v1.AuthPluginClient) grpc.UnaryServerInterceptor

NewAuthUnaryInterceptor returns a unary interceptor for the given auth plugin.

func Serve

func Serve(ctx context.Context, plugin v1.PluginServer) error

Serve is a convenience function for serving a plugin. It should be used by plugins that are intended to be run as a separate process.

Types

type BuiltinIPAM

type BuiltinIPAM struct {
	v1.UnimplementedIPAMPluginServer

	IPAMConfig
	// contains filtered or unexported fields
}

BuiltinIPAM is the built-in IPAM plugin that uses the mesh database to perform allocations.

func NewBuiltinIPAM

func NewBuiltinIPAM(opts IPAMConfig) *BuiltinIPAM

NewBuiltinIPAM returns a new ipam plugin with the given database.

func (*BuiltinIPAM) Allocate

func (p *BuiltinIPAM) Allocate(ctx context.Context, r *v1.AllocateIPRequest, opts ...grpc.CallOption) (*v1.AllocatedIP, error)

func (*BuiltinIPAM) Release

func (p *BuiltinIPAM) Release(ctx context.Context, req *v1.ReleaseIPRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)

type IPAMConfig

type IPAMConfig struct {
	// Storage is the storage plugin to use for IPAM.
	Storage storage.MeshDB
	// StaticIPv4 is a map of node names to IPv4 addresses.
	StaticIPv4 map[string]string
}

IPAMConfig contains static address assignments for nodes.

type IPAMPlugin

type IPAMPlugin interface {
	Allocate(ctx context.Context, r *v1.AllocateIPRequest, opts ...grpc.CallOption) (*v1.AllocatedIP, error)
	Release(ctx context.Context, r *v1.ReleaseIPRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

IPAMPlugin wraps the interface of the IPAM plugin only exposing the Allocate method. This makes for ease of use with the built-in IPAM.

type Manager

type Manager interface {
	// Get returns the plugin with the given name.
	Get(name string) (clients.PluginClient, bool)
	// 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 no IPAM plugin is configured, ErrUnsupported is returned.
	AllocateIP(ctx context.Context, req *v1.AllocateIPRequest) (netip.Prefix, error)
	// ReleaseIP calls the configured IPAM plugin to release an IP address for the given request.
	// If no IPAM plugin is configured, ErrUnsupported is returned.
	ReleaseIP(ctx context.Context, req *v1.ReleaseIPRequest) 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.

func NewManager

func NewManager(ctx context.Context, opts Options) (Manager, error)

NewManager creates a new plugin manager.

func NewManagerWithDB

func NewManagerWithDB(db storage.Provider) Manager

NewManagerWithDB creates a new plugin manager with a storage provider and no plugins configured.

type NodeConfig

type NodeConfig struct {
	// NodeID is the ID of the node.
	NodeID types.NodeID
	// NetworkIPv4 is the IPv4 network of the mesh
	NetworkIPv4 netip.Prefix
	// NetworkIPv6 is the IPv6 network of the mesh
	NetworkIPv6 netip.Prefix
	// AddressIPv4 is the IPv4 address of the node
	AddressIPv4 netip.Prefix
	// AddressIPv6 is the IPv6 address of the node
	AddressIPv6 netip.Prefix
	// Domain is the domain of the mesh
	Domain string
	// Key is the node's private key
	Key crypto.PrivateKey
}

NodeConfig is the configuration of the node to pass to each plugin.

type Options

type Options struct {
	// Storage is the storage backend to use for plugins.
	Storage storage.Provider
	// Plugins is a map of plugin names to plugin configs.
	Plugins map[string]Plugin
	// Node is the node configuration to pass to each plugin.
	Node NodeConfig
	// DisableDefaultIPAM disables the default IPAM plugin.
	DisableDefaultIPAM bool
	// DefaultIPAMStaticIPv4 is a map of node names to IPv4 addresses.
	DefaultIPAMStaticIPv4 map[string]string
}

Options are the options for creating a new plugin manager.

type Plugin

type Plugin struct {
	// Client is the plugin client.
	Client clients.PluginClient
	// Config is the plugin configuration.
	Config map[string]any
	// contains filtered or unexported fields
}

Plugin represents a plugin client and its configuration.