ipallocator

Documentation

Index

• Constants
• Variables
• type Allocator
  • func NewIPAllocator(cidr *net.IPNet, client networkingv1alpha1client.NetworkingV1alpha1Interface, ...) (*Allocator, error)
  • func (a *Allocator) Allocate(ip net.IP) error
  • func (a *Allocator) AllocateNext() (net.IP, error)
  • func (a *Allocator) AllocateNextService(svc *api.Service) (net.IP, error)
  • func (a *Allocator) AllocateService(svc *api.Service, ip net.IP) error
  • func (a *Allocator) CIDR() net.IPNet
  • func (a *Allocator) Destroy()
  • func (a *Allocator) DryRun() Interface
  • func (a *Allocator) EnableMetrics()
  • func (a *Allocator) ForEach(f func(net.IP))
  • func (a *Allocator) Free() int
  • func (a *Allocator) Has(ip net.IP) bool
  • func (a *Allocator) IPFamily() api.IPFamily
  • func (a *Allocator) Release(ip net.IP) error
  • func (a *Allocator) Used() int
• type ErrNotInRange
  • func (e *ErrNotInRange) Error() string
• type Interface
• type Range
  • func New(cidr *net.IPNet, allocatorFactory allocator.AllocatorWithOffsetFactory) (*Range, error)
  • func NewFromSnapshot(snap *api.RangeAllocation) (*Range, error)
  • func NewInMemory(cidr *net.IPNet) (*Range, error)
  • func (r *Range) Allocate(ip net.IP) error
  • func (r *Range) AllocateNext() (net.IP, error)
  • func (r *Range) CIDR() net.IPNet
  • func (r *Range) Destroy()
  • func (r *Range) DryRun() Interface
  • func (r *Range) EnableMetrics()
  • func (r *Range) ForEach(fn func(net.IP))
  • func (r *Range) Free() int
  • func (r *Range) Has(ip net.IP) bool
  • func (r *Range) IPFamily() api.IPFamily
  • func (r *Range) Release(ip net.IP) error
  • func (r *Range) Restore(net *net.IPNet, data []byte) error
  • func (r *Range) Snapshot(dst *api.RangeAllocation) error
  • func (r *Range) Used() int

Constants

const ControllerName = "ipallocator.k8s.io"

Variables

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")
)

Types

type Allocator

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

Allocator implements current ipallocator interface using IPAddress API object and an informer as backend.

func NewIPAllocator

func NewIPAllocator(
	cidr *net.IPNet,
	client networkingv1alpha1client.NetworkingV1alpha1Interface,
	ipAddressInformer networkingv1alpha1informers.IPAddressInformer,
) (*Allocator, error)

NewIPAllocator returns an IP allocator associated to a network range that use the IPAddress objectto track the assigned IP addresses, using an informer cache as storage.

func (*Allocator) Allocate

func (a *Allocator) 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. Only for testing, it will fail to create the IPAddress object because the Service reference is required.

func (*Allocator) AllocateNext

func (a *Allocator) AllocateNext() (net.IP, error)

AllocateNext return an IP address that wasn't allocated yet. Only for testing, it will fail to create the IPAddress object because the Service reference is required.

func (*Allocator) AllocateNextService

func (a *Allocator) AllocateNextService(svc *api.Service) (net.IP, error)

AllocateNext return an IP address that wasn't allocated yet.

func (*Allocator) AllocateService

func (a *Allocator) AllocateService(svc *api.Service, ip net.IP) error

AllocateService 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 (*Allocator) CIDR

func (a *Allocator) CIDR() net.IPNet

func (*Allocator) Destroy

func (a *Allocator) Destroy()

Destroy

func (*Allocator) DryRun

func (a *Allocator) DryRun() Interface

DryRun

func (*Allocator) EnableMetrics

func (a *Allocator) EnableMetrics()

EnableMetrics

func (*Allocator) ForEach

func (a *Allocator) ForEach(f func(net.IP))

ForEach executes the function on each allocated IP This is required to satisfy the Allocator Interface only

func (*Allocator) Free

func (a *Allocator) Free() int

for testing

func (*Allocator) Has

func (a *Allocator) Has(ip net.IP) bool

for testing

func (*Allocator) IPFamily

func (a *Allocator) IPFamily() api.IPFamily

func (*Allocator) Release

func (a *Allocator) 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 (*Allocator) Used

func (a *Allocator) Used() int

for testing

type ErrNotInRange

type ErrNotInRange struct {
	IP         net.IP
	ValidRange string
}

func (*ErrNotInRange) Error

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

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

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

NewFromSnapshot allocates a Range and initializes it from a snapshot.

func NewInMemory

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

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

CIDR returns the CIDR covered by the range.

func (*Range) Destroy

func (r *Range) Destroy()

Destroy shuts down internal allocator.

func (*Range) DryRun

func (r *Range) DryRun() Interface

DryRun returns a non-persisting form of this Range.

func (*Range) EnableMetrics

func (r *Range) EnableMetrics()

EnableMetrics enables metrics recording.

func (*Range) ForEach

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

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

func (r *Range) Used() int

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