model

Documentation

Index

• Variables
• type Model
  • func NewEtcdModel(etcd *clientv3.Client) Model
  • func NewMock() Model

Variables

var (
	// ErrConflicted is returned when storage operation conflicted.
	ErrConflicted = errors.New("conflicted")

	// ErrPoolExists is returned when a pool of the same name already exists.
	ErrPoolExists = errors.New("pool already exists")

	// ErrUsedSubnet is returned when the subnet is already in use.
	ErrUsedSubnet = errors.New("subnet in use")

	// ErrOutOfBlocks is returned when target freeList is empty.
	ErrOutOfBlocks = errors.New("out of address blocks")

	// ErrBlockIsFull is returned when all IP addresses in a block are allocated.
	ErrBlockIsFull = errors.New("block is full")

	// ErrNotFound is returned when a key does not exist.
	ErrNotFound = errors.New("not found")
)

Types

type Model

type Model interface {
	// GetAllocatedIPs returns allocated IP addresses for a block
	// The return value is a map whose keys are those passed to AllocateIP().
	GetAllocatedIPs(ctx context.Context, block *net.IPNet) (map[string]net.IP, error)

	// AllocateIP allocates new IP address from AddressBlock
	// Multiple goroutines cannot use this concurrently.
	//
	// When no more IP address can be allocated in block, ErrBlockIsFull will be returned.
	AllocateIP(ctx context.Context, block *net.IPNet, key string) (net.IP, error)

	// FreeIP deletes allocated IP
	FreeIP(ctx context.Context, block *net.IPNet, ip net.IP) error

	// GetMyBlocks retrieves all acquired blocks for a node.
	// The return value is a map whose keys are pool names.
	GetMyBlocks(ctx context.Context, node string) (map[string][]*net.IPNet, error)

	// AcquireBlock acquires a block from the free list for node.
	//
	// When the pool has no more free blocks, ErrOutOfBlocks will be returned.
	AcquireBlock(ctx context.Context, node, poolName string) (*net.IPNet, error)

	// ReleaseBlock releases a block and returns it to the free list.
	ReleaseBlock(ctx context.Context, node, poolName string, block *net.IPNet) error

	// AddPool adds a new address pool.
	// name must match this regexp: ^[a-z][a-z0-9_.-]*$
	AddPool(ctx context.Context, name string, subnet *net.IPNet, blockSize int) error

	// AddSubnet adds a subnet to an existing pool.
	AddSubnet(ctx context.Context, name string, n *net.IPNet) error

	// ListPools lists all pools.
	ListPools(ctx context.Context) (map[string]*coil.AddressPool, error)

	// GetPool gets pool.
	//
	// If named pool does not exist, ErrNotFound will be returned.
	GetPool(ctx context.Context, name string) (*coil.AddressPool, error)

	// GetAssignments returns block assignment information of a subnet.
	GetAssignments(ctx context.Context, name string, subnet *net.IPNet) (*coil.BlockAssignment, error)

	// RemovePool removes pool.
	RemovePool(ctx context.Context, name string) error
}

Model defines interfaces to access coil database.

func NewEtcdModel

func NewEtcdModel(etcd *clientv3.Client) Model

NewEtcdModel returns a Model that works on etcd.

func NewMock

func NewMock() Model

NewMock returns a mock model for testing.