ipallocator

package
v1.30.0 Latest Latest
Warning

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

 Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 33 Imported by: 269

Documentation

Index

Constants

View Source 
const ControllerName = "ipallocator.k8s.io"

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")
	ErrNotReady          = errors.New("allocator not ready")
)

Functions

This section is empty.

Types

type Allocator added in v1.27.0 

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

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

func NewIPAllocator added in v1.27.0 

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 added in v1.27.0 

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 added in v1.27.0 

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 added in v1.27.0 

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

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

func (*Allocator) AllocateService added in v1.27.0 

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 added in v1.27.0 

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

func (*Allocator) Destroy added in v1.27.0 

func (a *Allocator) Destroy()

Destroy

func (*Allocator) DryRun added in v1.27.0 

func (a *Allocator) DryRun() Interface

DryRun

func (*Allocator) EnableMetrics added in v1.27.0 

func (a *Allocator) EnableMetrics()

EnableMetrics

func (*Allocator) ForEach added in v1.27.0 

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 added in v1.27.0 

func (a *Allocator) Free() int

for testing, it assumes this is the allocator is unique for the ipFamily

func (*Allocator) Has added in v1.27.0 

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

for testing

func (*Allocator) IPFamily added in v1.27.0 

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

func (*Allocator) Release added in v1.27.0 

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 added in v1.27.0 

func (a *Allocator) Used() int

for testing, it assumes this is the allocator is unique for the ipFamily

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 MetaAllocator added in v1.29.0 

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

MetaAllocator implements current allocator interface using ServiceCIDR and IPAddress API objects.

func NewMetaAllocator added in v1.29.0 

func NewMetaAllocator(
	client networkingv1alpha1client.NetworkingV1alpha1Interface,
	serviceCIDRInformer networkingv1alpha1informers.ServiceCIDRInformer,
	ipAddressInformer networkingv1alpha1informers.IPAddressInformer,
	isIPv6 bool,
) (*MetaAllocator, error)

NewMetaAllocator returns an IP allocator that use the IPAddress and ServiceCIDR objects to track the assigned IP addresses, using an informer cache as storage.

func (*MetaAllocator) Allocate added in v1.29.0 

func (c *MetaAllocator) Allocate(ip net.IP) error

func (*MetaAllocator) AllocateNext added in v1.29.0 

func (c *MetaAllocator) AllocateNext() (net.IP, error)

func (*MetaAllocator) AllocateNextService added in v1.29.0 

func (c *MetaAllocator) AllocateNextService(service *api.Service) (net.IP, error)

func (*MetaAllocator) AllocateService added in v1.29.0 

func (c *MetaAllocator) AllocateService(service *api.Service, ip net.IP) error

func (*MetaAllocator) CIDR added in v1.29.0 

func (c *MetaAllocator) CIDR() net.IPNet

func (*MetaAllocator) Destroy added in v1.29.0 

func (c *MetaAllocator) Destroy()

func (*MetaAllocator) DryRun added in v1.29.0 

func (c *MetaAllocator) DryRun() Interface

DryRun returns a random allocator

func (*MetaAllocator) EnableMetrics added in v1.29.0 

func (c *MetaAllocator) EnableMetrics()

func (*MetaAllocator) ForEach added in v1.29.0 

func (c *MetaAllocator) ForEach(f func(ip net.IP))

func (*MetaAllocator) Free added in v1.29.0 

func (c *MetaAllocator) Free() int

for testing

func (*MetaAllocator) Has added in v1.29.0 

func (c *MetaAllocator) Has(ip net.IP) bool

func (*MetaAllocator) IPFamily added in v1.29.0 

func (c *MetaAllocator) IPFamily() api.IPFamily

func (*MetaAllocator) Release added in v1.29.0 

func (c *MetaAllocator) Release(ip net.IP) error

func (*MetaAllocator) Used added in v1.29.0 

func (c *MetaAllocator) Used() int

for testing

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.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.