overlay

package

v1.10.3 Latest Latest Go to latest Published: Feb 6, 2026 License: MIT Imports: 23 Imported by: 4

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/slackhq/nebula

Links

Documentation ¶

Rendered for

Index ¶

Constants
type Device
type DeviceFactory
- func NewFdDeviceFromConfig(fd *int) DeviceFactory
type NameError
- func (e *NameError) Error() string
type Route
- func (r Route) Equal(t Route) bool
- func (r Route) String() string
type UserDevice

Constants ¶

View Source

const DefaultMTU = 1300

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Device ¶

type Device interface {
	io.ReadWriteCloser
	Activate() error
	Networks() []netip.Prefix
	Name() string
	RoutesFor(netip.Addr) routing.Gateways
	SupportsMultiqueue() bool
	NewMultiQueueReader() (io.ReadWriteCloser, error)
}

func NewDeviceFromConfig ¶

func NewDeviceFromConfig(c *config.C, l *logrus.Logger, vpnNetworks []netip.Prefix, routines int) (Device, error)

func NewUserDevice ¶ added in v1.8.0

func NewUserDevice(vpnNetworks []netip.Prefix) (Device, error)

func NewUserDeviceFromConfig ¶ added in v1.8.0

func NewUserDeviceFromConfig(c *config.C, l *logrus.Logger, vpnNetworks []netip.Prefix, routines int) (Device, error)

type DeviceFactory ¶ added in v1.8.0

type DeviceFactory func(c *config.C, l *logrus.Logger, vpnNetworks []netip.Prefix, routines int) (Device, error)

TODO: We may be able to remove routines

func NewFdDeviceFromConfig ¶ added in v1.8.0

func NewFdDeviceFromConfig(fd *int) DeviceFactory

type NameError ¶ added in v1.10.3

type NameError struct {
	Name       string
	Underlying error
}

func (*NameError) Error ¶ added in v1.10.3

func (e *NameError) Error() string

type Route ¶

type Route struct {
	MTU     int
	Metric  int
	Cidr    netip.Prefix
	Via     routing.Gateways
	Install bool
}

func (Route) Equal ¶ added in v1.9.0

func (r Route) Equal(t Route) bool

Equal determines if a route that could be installed in the system route table is equal to another Via is ignored since that is only consumed within nebula itself

func (Route) String ¶ added in v1.9.0

func (r Route) String() string

type UserDevice ¶ added in v1.8.0

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

func (*UserDevice) Activate ¶ added in v1.8.0

func (d *UserDevice) Activate() error

func (*UserDevice) Close ¶ added in v1.8.0

func (d *UserDevice) Close() error

func (*UserDevice) Name ¶ added in v1.8.0

func (d *UserDevice) Name() string

func (*UserDevice) Networks ¶ added in v1.10.0

func (d *UserDevice) Networks() []netip.Prefix

func (*UserDevice) NewMultiQueueReader ¶ added in v1.8.0

func (d *UserDevice) NewMultiQueueReader() (io.ReadWriteCloser, error)

func (*UserDevice) Pipe ¶ added in v1.8.0

func (d *UserDevice) Pipe() (*io.PipeReader, *io.PipeWriter)

func (*UserDevice) Read ¶ added in v1.8.0

func (d *UserDevice) Read(p []byte) (n int, err error)

func (*UserDevice) RoutesFor ¶ added in v1.10.0

func (d *UserDevice) RoutesFor(ip netip.Addr) routing.Gateways

func (*UserDevice) SupportsMultiqueue ¶ added in v1.10.0

func (d *UserDevice) SupportsMultiqueue() bool

func (*UserDevice) Write ¶ added in v1.8.0

func (d *UserDevice) Write(p []byte) (n int, err error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL