pool

Documentation

Index

• Constants
• func IPBlockAnnotationExists(node *v1.Node) bool
• func RemoveIPBlockAnnotation(node *v1.Node)
• func SetIPBlockAnnotation(node *v1.Node, pools map[string]*Pool) error
• type ConfigReader
  • func NewConfigReader(node *v1.Node) (ConfigReader, error)
• type ExclusionRange
• type Manager
  • func NewManager() Manager
• type Pool
  • func (p *Pool) String() string
• type Route

Constants

const (
	IPBlocksAnnotation = "ipam.nvidia.com/ip-blocks"
)

Functions

func IPBlockAnnotationExists

func IPBlockAnnotationExists(node *v1.Node) bool

IPBlockAnnotationExists returns true if ip-block annotation exist

func RemoveIPBlockAnnotation

func RemoveIPBlockAnnotation(node *v1.Node)

RemoveIPBlockAnnotation removes annotation with ip-block from the node object

func SetIPBlockAnnotation

func SetIPBlockAnnotation(node *v1.Node, pools map[string]*Pool) error

SetIPBlockAnnotation serialize IP pools settings for the node and add this info as annotation

Types

type ConfigReader

type ConfigReader interface {
	// GetPoolByKey returns IPPool for the provided pool name or nil if pool doesn't exist
	GetPoolByKey(key string) *Pool
	// GetPools returns map with information about all pools
	GetPools() map[string]*Pool
}

ConfigReader is an interface to which provides access to the pool configuration

func NewConfigReader

func NewConfigReader(node *v1.Node) (ConfigReader, error)

type ExclusionRange

type ExclusionRange struct {
	StartIP string `json:"startIP"`
	EndIP   string `json:"endIP"`
}

ExclusionRange contains range of IP to exclude from the allocation

type Manager

type Manager interface {
	ConfigReader
	// Update Pool's config from IPPool CR
	UpdatePool(key string, pool *Pool)
	// Remove Pool's config by key
	RemovePool(key string)
}

Manager provide access to pools configuration

func NewManager

func NewManager() Manager

NewManager create and initialize new manager instance

type Pool

type Pool struct {
	Name           string           `json:"-"`
	Subnet         string           `json:"subnet"`
	StartIP        string           `json:"startIP"`
	EndIP          string           `json:"endIP"`
	Gateway        string           `json:"gateway"`
	Exclusions     []ExclusionRange `json:"exclusions"`
	Routes         []Route          `json:"routes"`
	DefaultGateway bool             `json:"defaultGateway"`
}

Pool represents generic pool configuration

func (*Pool) String

func (p *Pool) String() string

String return string representation of the IPPool config

type Route

type Route struct {
	Dst string `json:"dst"`
}

Route contains a destination CIDR to be added as static route via gateway