ipam

Documentation

Index

• type AddressRange
  • func (r *AddressRange) MarshalJSON() ([]byte, error)
  • func (r *AddressRange) String() string
  • func (r *AddressRange) UnmarshalJSON(data []byte) error
• type Allocator
  • func NewAllocator(lcDs, glDs datastore.DataStore) (*Allocator, error)
  • func (a *Allocator) DiscoverDelete(dType discoverapi.DiscoveryType, data interface{}) error
  • func (a *Allocator) DiscoverNew(dType discoverapi.DiscoveryType, data interface{}) error
  • func (a *Allocator) DumpDatabase() string
  • func (a *Allocator) GetDefaultAddressSpaces() (string, string, error)
  • func (a *Allocator) IsBuiltIn() bool
  • func (a *Allocator) ReleaseAddress(poolID string, address net.IP) error
  • func (a *Allocator) ReleasePool(poolID string) error
  • func (a *Allocator) RequestAddress(poolID string, prefAddress net.IP, opts map[string]string) (*net.IPNet, map[string]string, error)
  • func (a *Allocator) RequestPool(addressSpace, pool, subPool string, options map[string]string, v6 bool) (string, *net.IPNet, map[string]string, error)
• type PoolData
  • func (p *PoolData) CopyTo(dstP *PoolData) error
  • func (p *PoolData) MarshalJSON() ([]byte, error)
  • func (p *PoolData) String() string
  • func (p *PoolData) UnmarshalJSON(data []byte) error
• type SubnetKey
  • func (s *SubnetKey) FromString(str string) error
  • func (s *SubnetKey) String() string

Types

type AddressRange

type AddressRange struct {
	Sub        *net.IPNet
	Start, End uint64
}

AddressRange specifies first and last ip ordinal which identifies a range in a pool of addresses

func (*AddressRange) MarshalJSON

func (r *AddressRange) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the Range object

func (*AddressRange) String

func (r *AddressRange) String() string

String returns the string form of the AddressRange object

func (*AddressRange) UnmarshalJSON

func (r *AddressRange) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes data into the Range object

type Allocator

type Allocator struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Allocator provides per address space ipv4/ipv6 book keeping

func NewAllocator

func NewAllocator(lcDs, glDs datastore.DataStore) (*Allocator, error)

NewAllocator returns an instance of libnetwork ipam

func (*Allocator) DiscoverDelete

func (a *Allocator) DiscoverDelete(dType discoverapi.DiscoveryType, data interface{}) error

DiscoverDelete is a notification of no interest for the allocator

func (*Allocator) DiscoverNew

func (a *Allocator) DiscoverNew(dType discoverapi.DiscoveryType, data interface{}) error

DiscoverNew informs the allocator about a new global scope datastore

func (*Allocator) DumpDatabase

func (a *Allocator) DumpDatabase() string

DumpDatabase dumps the internal info

func (*Allocator) GetDefaultAddressSpaces

func (a *Allocator) GetDefaultAddressSpaces() (string, string, error)

GetDefaultAddressSpaces returns the local and global default address spaces

func (*Allocator) IsBuiltIn

func (a *Allocator) IsBuiltIn() bool

IsBuiltIn returns true for builtin drivers

func (*Allocator) ReleaseAddress

func (a *Allocator) ReleaseAddress(poolID string, address net.IP) error

ReleaseAddress releases the address from the specified pool ID

func (*Allocator) ReleasePool

func (a *Allocator) ReleasePool(poolID string) error

ReleasePool releases the address pool identified by the passed id

func (*Allocator) RequestAddress

func (a *Allocator) RequestAddress(poolID string, prefAddress net.IP, opts map[string]string) (*net.IPNet, map[string]string, error)

RequestAddress returns an address from the specified pool ID

func (*Allocator) RequestPool

func (a *Allocator) RequestPool(addressSpace, pool, subPool string, options map[string]string, v6 bool) (string, *net.IPNet, map[string]string, error)

RequestPool returns an address pool along with its unique id. addressSpace must be a valid address space name and must not be the empty string. If pool is the empty string then the default predefined pool for addressSpace will be used, otherwise pool must be a valid IP address and length in CIDR notation. If subPool is not empty, it must be a valid IP address and length in CIDR notation which is a sub-range of pool. subPool must be empty if pool is empty.

type PoolData

type PoolData struct {
	ParentKey SubnetKey
	Pool      *net.IPNet
	Range     *AddressRange `json:",omitempty"`
	RefCount  int
}

PoolData contains the configured pool data

func (*PoolData) CopyTo

func (p *PoolData) CopyTo(dstP *PoolData) error

CopyTo deep copies the pool data to the destination pooldata

func (*PoolData) MarshalJSON

func (p *PoolData) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON encoding of the PoolData object

func (*PoolData) String

func (p *PoolData) String() string

String returns the string form of the PoolData object

func (*PoolData) UnmarshalJSON

func (p *PoolData) UnmarshalJSON(data []byte) error

UnmarshalJSON decodes data into the PoolData object

type SubnetKey

type SubnetKey struct {
	AddressSpace string
	Subnet       string
	ChildSubnet  string
}

SubnetKey is the pointer to the configured pools in each address space

func (*SubnetKey) FromString

func (s *SubnetKey) FromString(str string) error

FromString populates the SubnetKey object reading it from string

func (*SubnetKey) String

func (s *SubnetKey) String() string

String returns the string form of the SubnetKey object