tunnel

Documentation

Overview

Package tunnel specifies the interface that has to be implemented by the different vpn technologies.

Index

• Variables
• func AddDriver(name string, driverCreate DriverCreateFunc)
• type Config
• type Driver
• type DriverCreateFunc

Variables

var Drivers = map[string]DriverCreateFunc{}

Drivers static map of supported drivers.

Functions

func AddDriver

func AddDriver(name string, driverCreate DriverCreateFunc)

AddDriver adds a supported driver to the drivers map, prints a fatal error in the case of double registration.

Types

type Config

type Config struct {
	MTU           int
	ListeningPort int
}

Config configuration for tunnel drivers passed during the creation.

type Driver

type Driver interface {
	Init() error

	ConnectToEndpoint(ctx context.Context, tep *netv1alpha1.TunnelEndpoint, updateStatus conncheck.UpdateFunc) (*netv1alpha1.Connection, error)

	DisconnectFromEndpoint(tep *netv1alpha1.TunnelEndpoint) error

	GetLink() netlink.Link

	Close() error

	prometheus.Collector
}

Driver the interface needed to be implemented by new vpn drivers.

type DriverCreateFunc

type DriverCreateFunc func(k8sClientset k8s.Interface, namespace string, config Config) (Driver, error)

DriverCreateFunc function prototype to create a new driver.