ipallocator

Documentation

Index

• Constants
• func New(config *config.Config, store store.Store, locker lock.Locker) *allocator
• type AllocateIPOpts
• type IPAllocator
• type RangeAddresser

Constants

const (
	IPAllocatorPrefix     = "/ipalloc"
	IPAllocatorLockPrefix = "/ipalloc-lock"
)

Functions

func New

func New(config *config.Config, store store.Store, locker lock.Locker) *allocator

Types

type AllocateIPOpts

type AllocateIPOpts struct {
	AddressRange string
	// If set, will try to allocate this precise IP, error if already taken
	Address string
}

type IPAllocator

type IPAllocator interface {
	InitializePool(ctx context.Context, id string, addressRange string) (RangeAddresser, error)
	AllocateIP(ctx context.Context, id string, opts AllocateIPOpts) (string, error)
	ReleaseIP(ctx context.Context, id string, address string) error
	ReleasePool(ctx context.Context, id string) error
}

type RangeAddresser

type RangeAddresser interface {
	GetAddressRange() string
}