cidrset

Documentation

Index

• Variables
• type CidrSet
  • func NewCIDRSet(clusterCIDR *net.IPNet, subNetMaskSize int) (*CidrSet, error)
  • func (s *CidrSet) AllocateNext() (*net.IPNet, error)
  • func (s *CidrSet) InRange(cidr *net.IPNet) bool
  • func (s *CidrSet) IsAllocated(cidr *net.IPNet) (bool, error)
  • func (s *CidrSet) IsClusterCIDR(cidr netip.Prefix) bool
  • func (s *CidrSet) IsFull() bool
  • func (s *CidrSet) Occupy(cidr *net.IPNet) (err error)
  • func (s *CidrSet) Prefix() netip.Prefix
  • func (s *CidrSet) Release(cidr *net.IPNet) error
  • func (s *CidrSet) String() string

Variables

var (
	// ErrCIDRRangeNoCIDRsRemaining occurs when there is no more space
	// to allocate CIDR ranges.
	ErrCIDRRangeNoCIDRsRemaining = errors.New(
		"CIDR allocation failed; there are no remaining CIDRs left to allocate in the accepted range")
	// ErrCIDRSetSubNetTooBig occurs when the subnet mask size is too
	// big compared to the CIDR mask size.
	ErrCIDRSetSubNetTooBig = errors.New(
		"New CIDR set failed; the node CIDR size is too big")
	// ErrSubNetMaskSizeInvalid occurs when the subnet mask size  is invalid:
	// bigger than 32 for IPv4 and bigger than 128 for IPv6
	ErrSubNetMaskSizeInvalid = fmt.Errorf(
		"SubNetMask is invalid, should be lower or equal to %d for IPv4 and to %d for IPv6",
		maxSubNetMaskSizeIPv4, maxSubNetMaskSizeIPv6)
)

Types

type CidrSet

type CidrSet struct {
	lock.Mutex
	// contains filtered or unexported fields
}

CidrSet manages a set of CIDR ranges from which blocks of IPs can be allocated from.

func NewCIDRSet

func NewCIDRSet(clusterCIDR *net.IPNet, subNetMaskSize int) (*CidrSet, error)

NewCIDRSet creates a new CidrSet.

func (*CidrSet) AllocateNext

func (s *CidrSet) AllocateNext() (*net.IPNet, error)

AllocateNext allocates the next free CIDR range. This will set the range as occupied and return the allocated range.

func (*CidrSet) InRange

func (s *CidrSet) InRange(cidr *net.IPNet) bool

InRange returns true if the given CIDR is inside the range of the allocatable CidrSet.

func (*CidrSet) IsAllocated

func (s *CidrSet) IsAllocated(cidr *net.IPNet) (bool, error)

IsAllocated verifies if the given CIDR is allocated

func (*CidrSet) IsClusterCIDR

func (s *CidrSet) IsClusterCIDR(cidr netip.Prefix) bool

IsClusterCIDR returns true if the given CIDR is equal to this CidrSet's cluster CIDR.

func (*CidrSet) IsFull

func (s *CidrSet) IsFull() bool

IsFull returns true if CidrSet does not have any more available CIDRs.

func (*CidrSet) Occupy

func (s *CidrSet) Occupy(cidr *net.IPNet) (err error)

Occupy marks the given CIDR range as used. Occupy succeeds even if the CIDR range was previously used.

func (*CidrSet) Prefix

func (s *CidrSet) Prefix() netip.Prefix

Prefix returns the CidrSet's prefix.

func (*CidrSet) Release

func (s *CidrSet) Release(cidr *net.IPNet) error

Release releases the given CIDR range.

func (*CidrSet) String

func (s *CidrSet) String() string