ecu

Documentation

Overview

Package ecu implements the Seesaw v2 ECU component, which provides an externally accessible interface to monitor and control the Seesaw Node.

Index

• type ECU
  • func NewECU(cfg *ECUConfig) *ECU
  • func (e *ECU) Run()
  • func (e *ECU) Shutdown()
• type ECUConfig
  • func DefaultECUConfig() ECUConfig
• type SeesawECU
  • func (s *SeesawECU) BGPNeighbors(ctx *ipc.Context, reply *quagga.Neighbors) error
  • func (s *SeesawECU) Backends(ctx *ipc.Context, reply *int) error
  • func (s *SeesawECU) ClusterStatus(ctx *ipc.Context, reply *seesaw.ClusterStatus) error
  • func (s *SeesawECU) ConfigReload(ctx *ipc.Context, reply *int) error
  • func (s *SeesawECU) ConfigSource(args *ipc.ConfigSource, oldSource *string) error
  • func (s *SeesawECU) ConfigStatus(ctx *ipc.Context, reply *seesaw.ConfigStatus) error
  • func (s *SeesawECU) Failover(ctx *ipc.Context, reply *int) error
  • func (s *SeesawECU) HAStatus(ctx *ipc.Context, status *seesaw.HAStatus) error
  • func (s *SeesawECU) OverrideBackend(args *ipc.Override, reply *int) error
  • func (s *SeesawECU) OverrideDestination(args *ipc.Override, reply *int) error
  • func (s *SeesawECU) OverrideVserver(args *ipc.Override, reply *int) error
  • func (s *SeesawECU) VLANs(ctx *ipc.Context, reply *seesaw.VLANs) error
  • func (s *SeesawECU) Vservers(ctx *ipc.Context, reply *seesaw.VserverMap) error

Types

type ECU

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

ECU contains the data necessary to run the Seesaw v2 ECU.

func NewECU

func NewECU(cfg *ECUConfig) *ECU

NewECU returns an initialised ECU struct.

func (*ECU) Run

func (e *ECU) Run()

Run starts the ECU.

func (*ECU) Shutdown

func (e *ECU) Shutdown()

Shutdown notifies the ECU to shutdown.

type ECUConfig

type ECUConfig struct {
	CACertsFile    string
	ControlAddress string
	ECUCertFile    string
	ECUKeyFile     string
	EngineSocket   string
	MonitorAddress string
	UpdateInterval time.Duration
}

ECUConfig provides configuration details for a Seesaw ECU.

func DefaultECUConfig

func DefaultECUConfig() ECUConfig

DefaultECUConfig returns the default ECU configuration.

type SeesawECU

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

SeesawECU provides the RPC interface to the Seesaw ECU.

func (*SeesawECU) BGPNeighbors

func (s *SeesawECU) BGPNeighbors(ctx *ipc.Context, reply *quagga.Neighbors) error

BGPNeighbors returns a list of the BGP neighbors that we are peering with.

func (*SeesawECU) Backends

func (s *SeesawECU) Backends(ctx *ipc.Context, reply *int) error

Backends returns a list of currently configured Backends.

func (*SeesawECU) ClusterStatus

func (s *SeesawECU) ClusterStatus(ctx *ipc.Context, reply *seesaw.ClusterStatus) error

ClusterStatus returns status information about this Seesaw Cluster.

func (*SeesawECU) ConfigReload

func (s *SeesawECU) ConfigReload(ctx *ipc.Context, reply *int) error

ConfigReload requests a configuration reload.

func (*SeesawECU) ConfigSource

func (s *SeesawECU) ConfigSource(args *ipc.ConfigSource, oldSource *string) error

ConfigSource requests the configuration source be changed to the specified source. The name of the original source is returned.

func (*SeesawECU) ConfigStatus

func (s *SeesawECU) ConfigStatus(ctx *ipc.Context, reply *seesaw.ConfigStatus) error

ConfigStatus returns status information about this Seesaw's current configuration.

func (*SeesawECU) Failover

func (s *SeesawECU) Failover(ctx *ipc.Context, reply *int) error

Failover requests the Seesaw Engine to relinquish master state.

func (*SeesawECU) HAStatus

func (s *SeesawECU) HAStatus(ctx *ipc.Context, status *seesaw.HAStatus) error

HAStatus returns the current HA status from the Seesaw Engine.

func (*SeesawECU) OverrideBackend

func (s *SeesawECU) OverrideBackend(args *ipc.Override, reply *int) error

OverrideBackend requests that the specified BackendOverride be applied.

func (*SeesawECU) OverrideDestination

func (s *SeesawECU) OverrideDestination(args *ipc.Override, reply *int) error

OverrideDestination requests that the specified DestinationOverride be applied.

func (*SeesawECU) OverrideVserver

func (s *SeesawECU) OverrideVserver(args *ipc.Override, reply *int) error

OverrideVserver requests that the specified VserverOverride be applied.

func (*SeesawECU) VLANs

func (s *SeesawECU) VLANs(ctx *ipc.Context, reply *seesaw.VLANs) error

VLANs returns a list of currently configured VLANs.

func (*SeesawECU) Vservers

func (s *SeesawECU) Vservers(ctx *ipc.Context, reply *seesaw.VserverMap) error

Vservers returns a list of currently configured vservers.