ipam

Documentation

Overview

Package ipam provides a plugin for simple mesh IPAM. It also acts as a storage plugin and uses the leases tracked in the mesh database to pseudo-randomly assign IP addresses to nodes.

Index

• type Config
  • func (c *Config) AsMapStructure() map[string]any
  • func (c *Config) BindFlags(prefix string, fs *pflag.FlagSet)
  • func (c *Config) DefaultOptions() *Config
  • func (c *Config) SetMapStructure(in map[string]any)
• type Plugin
  • func (p *Plugin) Allocate(ctx context.Context, r *v1.AllocateIPRequest) (*v1.AllocatedIP, error)
  • func (p *Plugin) Close(ctx context.Context, req *emptypb.Empty) (*emptypb.Empty, error)
  • func (p *Plugin) Configure(ctx context.Context, req *v1.PluginConfiguration) (*emptypb.Empty, error)
  • func (p *Plugin) GetInfo(context.Context, *emptypb.Empty) (*v1.PluginInfo, error)
  • func (p *Plugin) InjectQuerier(srv v1.StorageQuerierPlugin_InjectQuerierServer) error
  • func (p *Plugin) Release(context.Context, *v1.ReleaseIPRequest) (*emptypb.Empty, error)

Types

type Config

type Config struct {
	// StaticIPv4 is a map of node names to IPv4 addresses.
	StaticIPv4 map[string]any `mapstructure:"static-ipv4,omitempty" koanf:"static-ipv4,omitempty"`
}

Config contains static address assignments for nodes.

func (*Config) AsMapStructure

func (c *Config) AsMapStructure() map[string]any

func (*Config) BindFlags

func (c *Config) BindFlags(prefix string, fs *pflag.FlagSet)

BindFlags binds the plugin flags to the given flag set.

func (*Config) DefaultOptions

func (c *Config) DefaultOptions() *Config

DefaultOptions returns the default options for the plugin.

func (*Config) SetMapStructure

func (c *Config) SetMapStructure(in map[string]any)

type Plugin

type Plugin struct {
	v1.UnimplementedPluginServer
	v1.UnimplementedIPAMPluginServer
	v1.UnimplementedStorageQuerierPluginServer
	// contains filtered or unexported fields
}

Plugin is the ipam plugin.

func (*Plugin) Allocate

func (p *Plugin) Allocate(ctx context.Context, r *v1.AllocateIPRequest) (*v1.AllocatedIP, error)

func (*Plugin) Close

func (p *Plugin) Close(ctx context.Context, req *emptypb.Empty) (*emptypb.Empty, error)

func (*Plugin) Configure

func (p *Plugin) Configure(ctx context.Context, req *v1.PluginConfiguration) (*emptypb.Empty, error)

func (*Plugin) GetInfo

func (p *Plugin) GetInfo(context.Context, *emptypb.Empty) (*v1.PluginInfo, error)

func (*Plugin) InjectQuerier

func (p *Plugin) InjectQuerier(srv v1.StorageQuerierPlugin_InjectQuerierServer) error

func (*Plugin) Release

func (p *Plugin) Release(context.Context, *v1.ReleaseIPRequest) (*emptypb.Empty, error)

TODO: Release is not implemented server-side yet either.