cableengine

Documentation

Index

• type Engine
  • func NewEngine(localCluster *types.SubmarinerCluster, localEndpoint *types.SubmarinerEndpoint) Engine

Types

type Engine

type Engine interface {
	// StartEngine performs any general set up work needed independent of any remote connections.
	StartEngine() error
	Stop()
	// InstallCable performs any set up work needed for connecting to given remote endpoint.
	// Once InstallCable completes, it should be possible to connect to remote
	// Pods or Services behind the given endpoint.
	InstallCable(remote *v1.Endpoint) error
	// RemoveCable disconnects the Engine from the given remote endpoint. Upon completion.
	// remote Pods and Service may not be accessible anymore.
	RemoveCable(remote *v1.Endpoint) error
	// ListCableConnections returns a list of cable connection, and the related status.
	ListCableConnections() ([]v1.Connection, error)
	// GetLocalEndpoint returns the local endpoint for this cable engine.
	GetLocalEndpoint() *types.SubmarinerEndpoint
	// GetHAStatus returns the HA status for this cable engine.
	GetHAStatus() v1.HAStatus
	// SetupNATDiscovery configures the handler for nat discovery of the endpoints.
	SetupNATDiscovery(natDiscovery natdiscovery.Interface)

	// Cleanup performs the necessary steps to uninstall the cable driver.
	Cleanup() error
}

Engine represents an implementation of some remote connectivity mechanism, such as a VPN gateway. An Engine cooperates with, and delegates work to, a cable.Driver for implementing a secure connection to remote clusters.

func NewEngine

func NewEngine(localCluster *types.SubmarinerCluster, localEndpoint *types.SubmarinerEndpoint) Engine

NewEngine creates a new Engine for the local cluster.