ipallocator

package
v1.25.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 17, 2023 License: Apache-2.0 Imports: 12 Imported by: 366

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrFull              = errors.New("range is full")
	ErrAllocated         = errors.New("provided IP is already allocated")
	ErrMismatchedNetwork = errors.New("the provided network does not match the current range")
)

Functions

This section is empty.

Types

type ErrNotInRange

type ErrNotInRange struct {
	IP         net.IP
	ValidRange string
}

func (*ErrNotInRange) Error added in v1.8.0

func (e *ErrNotInRange) Error() string

type Interface

type Interface interface {
	Allocate(net.IP) error
	AllocateNext() (net.IP, error)
	Release(net.IP) error
	ForEach(func(net.IP))
	CIDR() net.IPNet
	IPFamily() api.IPFamily
	Has(ip net.IP) bool
	Destroy()
	EnableMetrics()

	// DryRun offers a way to try operations without persisting them.
	DryRun() Interface
}

Interface manages the allocation of IP addresses out of a range. Interface should be threadsafe.

type Range

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

Range is a contiguous block of IPs that can be allocated atomically.

The internal structure of the range is:

For CIDR 10.0.0.0/24
254 addresses usable out of 256 total (minus base and broadcast IPs)
  The number of usable addresses is r.max

CIDR base IP          CIDR broadcast IP
10.0.0.0                     10.0.0.255
|                                     |
0 1 2 3 4 5 ...         ... 253 254 255
  |                              |
r.base                     r.base + r.max
  |                              |
offset #0 of r.allocated   last offset of r.allocated

func New added in v1.23.0

func New(cidr *net.IPNet, allocatorFactory allocator.AllocatorWithOffsetFactory) (*Range, error)

New creates a Range over a net.IPNet, calling allocatorFactory to construct the backing store.

func NewFromSnapshot added in v1.5.2

func NewFromSnapshot(snap *api.RangeAllocation) (*Range, error)

NewFromSnapshot allocates a Range and initializes it from a snapshot.

func NewInMemory added in v1.23.0

func NewInMemory(cidr *net.IPNet) (*Range, error)

NewInMemory creates an in-memory allocator.

func (*Range) Allocate

func (r *Range) Allocate(ip net.IP) error

Allocate attempts to reserve the provided IP. ErrNotInRange or ErrAllocated will be returned if the IP is not valid for this range or has already been reserved. ErrFull will be returned if there are no addresses left.

func (*Range) AllocateNext

func (r *Range) AllocateNext() (net.IP, error)

AllocateNext reserves one of the IPs from the pool. ErrFull may be returned if there are no addresses left.

func (*Range) CIDR added in v1.5.2

func (r *Range) CIDR() net.IPNet

CIDR returns the CIDR covered by the range.

func (*Range) Destroy added in v1.25.0

func (r *Range) Destroy()

Destroy shuts down internal allocator.

func (*Range) DryRun added in v1.23.0

func (r *Range) DryRun() Interface

DryRun returns a non-persisting form of this Range.

func (*Range) EnableMetrics added in v1.25.0

func (r *Range) EnableMetrics()

EnableMetrics enables metrics recording.

func (*Range) ForEach added in v1.5.2

func (r *Range) ForEach(fn func(net.IP))

ForEach calls the provided function for each allocated IP.

func (*Range) Free

func (r *Range) Free() int

Free returns the count of IP addresses left in the range.

func (*Range) Has

func (r *Range) Has(ip net.IP) bool

Has returns true if the provided IP is already allocated and a call to Allocate(ip) would fail with ErrAllocated.

func (*Range) IPFamily added in v1.22.0

func (r *Range) IPFamily() api.IPFamily

IPFamily returns the IP family of this range.

func (*Range) Release

func (r *Range) Release(ip net.IP) error

Release releases the IP back to the pool. Releasing an unallocated IP or an IP out of the range is a no-op and returns no error.

func (*Range) Restore

func (r *Range) Restore(net *net.IPNet, data []byte) error

Restore restores the pool to the previously captured state. ErrMismatchedNetwork is returned if the provided IPNet range doesn't exactly match the previous range.

func (*Range) Snapshot

func (r *Range) Snapshot(dst *api.RangeAllocation) error

Snapshot saves the current state of the pool.

func (*Range) Used added in v1.5.2

func (r *Range) Used() int

Used returns the count of IP addresses used in the range.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL