subnet

Documentation

Index

• func LeaseRenewer(ctx context.Context, m Manager, network string, lease *Lease)
• func WatchLeases(ctx context.Context, sm Manager, network string, receiver chan []Event)
• type Config
  • func ParseConfig(s string) (*Config, error)
• type EtcdConfig
• type EtcdManager
  • func (m *EtcdManager) AcquireLease(ctx context.Context, network string, attrs *LeaseAttrs) (*Lease, error)
  • func (m *EtcdManager) GetNetworkConfig(ctx context.Context, network string) (*Config, error)
  • func (m *EtcdManager) RenewLease(ctx context.Context, network string, lease *Lease) error
  • func (m *EtcdManager) WatchLeases(ctx context.Context, network string, cursor interface{}) (WatchResult, error)
• type Event
• type EventType
  • func (et EventType) MarshalJSON() ([]byte, error)
  • func (et *EventType) UnmarshalJSON(data []byte) error
• type Lease
  • func (l *Lease) Key() string
• type LeaseAttrs
• type Manager
  • func NewEtcdManager(config *EtcdConfig) (Manager, error)
  • func NewMockManager(ttlOverride uint64, config string) Manager
• type Registry
• type WatchResult

Functions

func LeaseRenewer

func LeaseRenewer(ctx context.Context, m Manager, network string, lease *Lease)

func WatchLeases

func WatchLeases(ctx context.Context, sm Manager, network string, receiver chan []Event)

WatchLeases performs a long term watch of the given network's subnet leases and communicates addition/deletion events on receiver channel. It takes care of handling "fall-behind" logic where the history window has advanced too far and it needs to diff the latest snapshot with its saved state and generate events

Types

type Config

type Config struct {
	Network   ip.IP4Net
	SubnetMin ip.IP4
	SubnetMax ip.IP4
	SubnetLen uint
	Backend   json.RawMessage `json:",omitempty"`
}

func ParseConfig

func ParseConfig(s string) (*Config, error)

type EtcdConfig

type EtcdConfig struct {
	Endpoints []string
	Keyfile   string
	Certfile  string
	CAFile    string
	Prefix    string
}

type EtcdManager

type EtcdManager struct {
	// contains filtered or unexported fields
}

func (*EtcdManager) AcquireLease

func (m *EtcdManager) AcquireLease(ctx context.Context, network string, attrs *LeaseAttrs) (*Lease, error)

func (*EtcdManager) GetNetworkConfig

func (m *EtcdManager) GetNetworkConfig(ctx context.Context, network string) (*Config, error)

func (*EtcdManager) RenewLease

func (m *EtcdManager) RenewLease(ctx context.Context, network string, lease *Lease) error

func (*EtcdManager) WatchLeases

func (m *EtcdManager) WatchLeases(ctx context.Context, network string, cursor interface{}) (WatchResult, error)

type Event

type Event struct {
	Type  EventType `json:"type"`
	Lease Lease     `json:"lease"`
}

type EventType

type EventType int

const (
	SubnetAdded EventType = iota
	SubnetRemoved
)

func (EventType) MarshalJSON

func (et EventType) MarshalJSON() ([]byte, error)

func (*EventType) UnmarshalJSON

func (et *EventType) UnmarshalJSON(data []byte) error

type Lease

type Lease struct {
	Subnet     ip.IP4Net
	Attrs      *LeaseAttrs
	Expiration time.Time
}

func (*Lease) Key

func (l *Lease) Key() string

type LeaseAttrs

type LeaseAttrs struct {
	PublicIP    ip.IP4
	BackendType string          `json:",omitempty"`
	BackendData json.RawMessage `json:",omitempty"`
}

type Manager

type Manager interface {
	GetNetworkConfig(ctx context.Context, network string) (*Config, error)
	AcquireLease(ctx context.Context, network string, attrs *LeaseAttrs) (*Lease, error)
	RenewLease(ctx context.Context, network string, lease *Lease) error
	WatchLeases(ctx context.Context, network string, cursor interface{}) (WatchResult, error)
}

func NewEtcdManager

func NewEtcdManager(config *EtcdConfig) (Manager, error)

func NewMockManager

func NewMockManager(ttlOverride uint64, config string) Manager

type Registry

type Registry interface {
	// contains filtered or unexported methods
}

type WatchResult

type WatchResult struct {
	// Either Events or Leases should be set.
	// If Leases are not empty, it means the cursor
	// was out of range and Snapshot contains the current
	// list of leases
	Events   []Event     `json:"events"`
	Snapshot []Lease     `json:"snapshot"`
	Cursor   interface{} `json:"cursor"`
}