orchestrator

Documentation

Index

• type ConstellationInfo
• type GroupInfo
• type Host
• type ISL
• type Link
  • func (l Link) String() string
• type MachineConfig
• type MachineID
  • func (m MachineID) String() string
• type MachineState
• type MachinesState
• type NetworkState
  • func (n NetworkState) String() string
• type NodeIDInfo
• type NodeInfo
• type Orchestrator
  • func New(vb VirtualizationBackend) *Orchestrator
  • func (o *Orchestrator) GetResources() (availcpus uint32, availram uint64, err error)
  • func (o *Orchestrator) InfoGetConstellation() (ConstellationInfo, error)
  • func (o *Orchestrator) InfoGetGroup(group uint8) (GroupInfo, error)
  • func (o *Orchestrator) InfoGetIPAddressByID(id MachineID) (net.IP, error)
  • func (o *Orchestrator) InfoGetIPAddressByName(name string) (net.IP, error)
  • func (o *Orchestrator) InfoGetNodeByID(id MachineID) (NodeInfo, error)
  • func (o *Orchestrator) InfoGetNodeByIP(ip net.IP) (NodeInfo, error)
  • func (o *Orchestrator) InfoGetNodeByName(name string) (NodeInfo, error)
  • func (o *Orchestrator) InfoGetNodeNameByID(id MachineID) (string, error)
  • func (o *Orchestrator) InfoGetPath(source, destination MachineID) (PathInfo, error)
  • func (o *Orchestrator) Initialize(machineList map[MachineID]MachineConfig, machineHosts map[MachineID]Host, ...) error
  • func (o *Orchestrator) Stop() error
  • func (o *Orchestrator) Update(s *State) error
• type PathInfo
• type SegmentInfo
• type State
• type VirtualizationBackend

Types

type ConstellationInfo

type ConstellationInfo struct {
	Groups []GroupInfo
}

type GroupInfo

type GroupInfo struct {
	Group uint8
	Nodes []NodeInfo
}

type Host

type Host uint8

type ISL

type ISL struct {
	// Latency in microseconds
	Latency uint32
	// Bandwidth in bytes per second
	Bandwidth uint64
}

type Link

type Link struct {
	// Blocked is true if the link is blocked
	Blocked bool
	// Latency in microseconds
	LatencyUs uint32
	// Bandwidth in kilobytes per second
	BandwidthKbps uint64

	// used for path reconstruction
	Next MachineID
}

func (Link) String

func (l Link) String() string

type MachineConfig

type MachineConfig struct {
	VCPUCount uint8
	// RAM in bytes
	RAM uint64
	// DiskSize in bytes
	DiskSize uint64
	// DiskImage is the path to the disk image
	DiskImage string
	// Kernel is the path to the kernel
	Kernel string
	// BootParams are the additional boot parameters
	BootParams []string
}

type MachineID

type MachineID struct {
	// is 0 for ground stations
	Group uint8
	Id    uint32
}

func (MachineID) String

func (m MachineID) String() string

type MachineState

type MachineState uint8

const (
	STOPPED MachineState = iota
	ACTIVE
)

type MachinesState

type MachinesState map[MachineID]MachineState

type NetworkState

type NetworkState map[MachineID]map[MachineID]*Link

func (NetworkState) String

func (n NetworkState) String() string

type NodeIDInfo

type NodeIDInfo struct {
	ID   MachineID
	Name string
}

type NodeInfo

type NodeInfo struct {
	ID     NodeIDInfo
	Active bool
}

type Orchestrator

type Orchestrator struct {
	// State is the description of the desired state of the emulation (as determined by simulation)
	State
	// contains filtered or unexported fields
}

func New

func New(vb VirtualizationBackend) *Orchestrator

func (*Orchestrator) GetResources

func (o *Orchestrator) GetResources() (availcpus uint32, availram uint64, err error)

func (*Orchestrator) InfoGetConstellation

func (o *Orchestrator) InfoGetConstellation() (ConstellationInfo, error)

func (*Orchestrator) InfoGetGroup

func (o *Orchestrator) InfoGetGroup(group uint8) (GroupInfo, error)

func (*Orchestrator) InfoGetIPAddressByID

func (o *Orchestrator) InfoGetIPAddressByID(id MachineID) (net.IP, error)

func (*Orchestrator) InfoGetIPAddressByName

func (o *Orchestrator) InfoGetIPAddressByName(name string) (net.IP, error)

func (*Orchestrator) InfoGetNodeByID

func (o *Orchestrator) InfoGetNodeByID(id MachineID) (NodeInfo, error)

func (*Orchestrator) InfoGetNodeByIP

func (o *Orchestrator) InfoGetNodeByIP(ip net.IP) (NodeInfo, error)

func (*Orchestrator) InfoGetNodeByName

func (o *Orchestrator) InfoGetNodeByName(name string) (NodeInfo, error)

func (*Orchestrator) InfoGetNodeNameByID

func (o *Orchestrator) InfoGetNodeNameByID(id MachineID) (string, error)

func (*Orchestrator) InfoGetPath

func (o *Orchestrator) InfoGetPath(source, destination MachineID) (PathInfo, error)

func (*Orchestrator) Initialize

func (o *Orchestrator) Initialize(machineList map[MachineID]MachineConfig, machineHosts map[MachineID]Host, machineNames map[MachineID]string) error

func (*Orchestrator) Stop

func (o *Orchestrator) Stop() error

func (*Orchestrator) Update

func (o *Orchestrator) Update(s *State) error

type PathInfo

type PathInfo struct {
	Source        MachineID
	Target        MachineID
	LatencyUs     uint32
	BandwidthKbps uint64
	Segments      []SegmentInfo
	Blocked       bool
}

type SegmentInfo

type SegmentInfo struct {
	Source        MachineID
	Target        MachineID
	LatencyUs     uint32
	BandwidthKbps uint64
}

type State

type State struct {
	NetworkState
	MachinesState
}

type VirtualizationBackend

type VirtualizationBackend interface {
	RegisterMachine(machine MachineID, name string, host Host, config MachineConfig) error
	BlockLink(source MachineID, target MachineID) error
	UnblockLink(source MachineID, target MachineID) error
	SetLatency(source MachineID, target MachineID, latency uint32) error
	SetBandwidth(source MachineID, target MachineID, bandwidth uint64) error
	StopMachine(machine MachineID) error
	StartMachine(machine MachineID) error
	GetIPAddress(id MachineID) (net.IPNet, error)
	ResolveIPAddress(ip net.IP) (MachineID, error)
	Stop() error
}