Documentation ¶
Index ¶
- Constants
- Variables
- type Allocator
- 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
- type Interface
- type MetaAllocator
- func (c *MetaAllocator) Allocate(ip net.IP) error
- func (c *MetaAllocator) AllocateNext() (net.IP, error)
- func (c *MetaAllocator) AllocateNextService(service *api.Service) (net.IP, error)
- func (c *MetaAllocator) AllocateService(service *api.Service, ip net.IP) error
- func (c *MetaAllocator) CIDR() net.IPNet
- func (c *MetaAllocator) Destroy()
- func (c *MetaAllocator) DryRun() Interface
- func (c *MetaAllocator) EnableMetrics()
- func (c *MetaAllocator) ForEach(f func(ip net.IP))
- func (c *MetaAllocator) Free() int
- func (c *MetaAllocator) Has(ip net.IP) bool
- func (c *MetaAllocator) IPFamily() api.IPFamily
- func (c *MetaAllocator) Release(ip net.IP) error
- func (c *MetaAllocator) Used() int
- type Range
- 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 ¶
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
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
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
AllocateNext return an IP address that wasn't allocated yet.
func (*Allocator) AllocateService ¶ added in v1.27.0
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) EnableMetrics ¶ added in v1.27.0
func (a *Allocator) EnableMetrics()
EnableMetrics
func (*Allocator) ForEach ¶ added in v1.27.0
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
for testing, it assumes this is the allocator is unique for the ipFamily
type ErrNotInRange ¶
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) AllocateNext ¶ added in v1.29.0
func (c *MetaAllocator) AllocateNext() (net.IP, error)
func (*MetaAllocator) AllocateNextService ¶ added in v1.29.0
func (*MetaAllocator) AllocateService ¶ added in v1.29.0
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) IPFamily ¶ added in v1.29.0
func (c *MetaAllocator) IPFamily() api.IPFamily
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
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
NewInMemory creates an in-memory allocator.
func (*Range) Allocate ¶
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 ¶
AllocateNext reserves one of the IPs from the pool. ErrFull may be returned if there are no addresses left.
func (*Range) Destroy ¶ added in v1.25.0
func (r *Range) Destroy()
Destroy shuts down internal allocator.
func (*Range) EnableMetrics ¶ added in v1.25.0
func (r *Range) EnableMetrics()
EnableMetrics enables metrics recording.
func (*Range) Has ¶
Has returns true if the provided IP is already allocated and a call to Allocate(ip) would fail with ErrAllocated.
func (*Range) Release ¶
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 ¶
Restore restores the pool to the previously captured state. ErrMismatchedNetwork is returned if the provided IPNet range doesn't exactly match the previous range.