cable

Documentation

Index

• func AddDriver(name string, driverCreate DriverCreateFunc)
• func GetDefaultCableDriver() string
• func RecordConnection(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
• func RecordConnectionLatency(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
• func RecordDisconnected(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec)
• func RecordNoConnections()
• func RecordRxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
• func RecordTxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
• func SetDefaultCableDriver(driver string)
• type Driver
  • func NewDriver(localEndpoint *types.SubmarinerEndpoint, localCluster *types.SubmarinerCluster) (Driver, error)
• type DriverCreateFunc

Functions

func AddDriver

func AddDriver(name string, driverCreate DriverCreateFunc)

Adds a supported driver, prints a fatal error in the case of double registration.

func GetDefaultCableDriver

func GetDefaultCableDriver() string

Returns the default cable driver name.

func RecordConnection

func RecordConnection(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, status string, isNew bool)

func RecordConnectionLatency

func RecordConnectionLatency(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, latencySeconds float64)

func RecordDisconnected

func RecordDisconnected(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec)

func RecordNoConnections

func RecordNoConnections()

func RecordRxBytes

func RecordRxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, bytes int)

func RecordTxBytes

func RecordTxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, bytes int)

func SetDefaultCableDriver

func SetDefaultCableDriver(driver string)

Sets the default cable driver name, if it is not specified by user.

Types

type Driver

type Driver interface {
	// Init initializes the driver with any state it needs.
	Init() error

	// GetActiveConnections returns an array of all the active connections.
	GetActiveConnections() ([]v1.Connection, error)

	// GetConnections() returns an array of the existing connections, including status and endpoint info
	GetConnections() ([]v1.Connection, error)

	// ConnectToEndpoint establishes a connection to the given endpoint and returns a string
	// representation of the IP address of the target endpoint.
	ConnectToEndpoint(endpointInfo *natdiscovery.NATEndpointInfo) (string, error)

	// DisconnectFromEndpoint disconnects from the connection to the given endpoint.
	DisconnectFromEndpoint(endpoint *types.SubmarinerEndpoint) error

	// GetName returns driver's name
	GetName() string

	// Cleanup performs the necessary uninstallation.
	Cleanup() error
}

Driver is used by the ipsec engine to actually connect the tunnels.

func NewDriver

func NewDriver(localEndpoint *types.SubmarinerEndpoint, localCluster *types.SubmarinerCluster) (Driver, error)

Returns a new driver according the required Backend.

type DriverCreateFunc

type DriverCreateFunc func(localEndpoint *types.SubmarinerEndpoint, localCluster *types.SubmarinerCluster) (Driver, error)

Function prototype to create a new driver.