cable

Documentation

Index

• func AddDriver(name string, driverCreate DriverCreateFunc)
• func GetDefaultCableDriver() string
• func SetDefaultCableDriver(driver string)
• type Driver
  • func NewDriver(localSubnets []string, localEndpoint types.SubmarinerEndpoint) (Driver, error)
• type DriverCreateFunc

Functions

func AddDriver

func AddDriver(name string, driverCreate DriverCreateFunc)

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

func GetDefaultCableDriver

func GetDefaultCableDriver() string

Returns the default cable driver name

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 for the given cluster.
	GetActiveConnections(clusterID string) ([]string, 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(endpoint types.SubmarinerEndpoint) (string, error)

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

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

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

func NewDriver

func NewDriver(localSubnets []string, localEndpoint types.SubmarinerEndpoint) (Driver, error)

Returns a new driver according the required Backend

type DriverCreateFunc

type DriverCreateFunc func(localSubnets []string, localEndpoint types.SubmarinerEndpoint) (Driver, error)

Function prototype to create a new driver