siderolink

Documentation

Overview

Package siderolink provides controllers which manage file resources.

Index

• Constants
• type ConfigController
  • func (ctrl *ConfigController) Inputs() []controller.Input
  • func (ctrl *ConfigController) Name() string
  • func (ctrl *ConfigController) Outputs() []controller.Output
  • func (ctrl *ConfigController) Run(ctx context.Context, r controller.Runtime, _ *zap.Logger) error
• type ManagerController
  • func (ctrl *ManagerController) Inputs() []controller.Input
  • func (ctrl *ManagerController) Name() string
  • func (ctrl *ManagerController) Outputs() []controller.Output
  • func (ctrl *ManagerController) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) error
• type StatusController
  • func (ctrl *StatusController) Inputs() []controller.Input
  • func (ctrl *StatusController) Name() string
  • func (ctrl *StatusController) Outputs() []controller.Output
  • func (ctrl *StatusController) Run(ctx context.Context, r controller.Runtime, _ *zap.Logger) error
• type UserspaceWireguardController
  • func (ctrl *UserspaceWireguardController) Inputs() []controller.Input
  • func (ctrl *UserspaceWireguardController) Name() string
  • func (ctrl *UserspaceWireguardController) Outputs() []controller.Output
  • func (ctrl *UserspaceWireguardController) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) error
• type WireguardClient

Constants

const DefaultStatusUpdateInterval = 30 * time.Second

DefaultStatusUpdateInterval is the default interval between status updates.

Types

type ConfigController

type ConfigController struct {
	Cmdline      *procfs.Cmdline
	V1Alpha1Mode v1alpha1runtime.Mode
}

ConfigController interacts with SideroLink API and brings up the SideroLink Wireguard interface.

func (*ConfigController) Inputs

func (ctrl *ConfigController) Inputs() []controller.Input

Inputs implements controller.Controller interface.

func (*ConfigController) Name

func (ctrl *ConfigController) Name() string

Name implements controller.Controller interface.

func (*ConfigController) Outputs

func (ctrl *ConfigController) Outputs() []controller.Output

Outputs implements controller.Controller interface.

func (*ConfigController) Run

func (ctrl *ConfigController) Run(ctx context.Context, r controller.Runtime, _ *zap.Logger) error

Run implements controller.Controller interface.

type ManagerController

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

ManagerController interacts with SideroLink API and brings up the SideroLink Wireguard interface.

func (*ManagerController) Inputs

func (ctrl *ManagerController) Inputs() []controller.Input

Inputs implements controller.Controller interface.

func (*ManagerController) Name

func (ctrl *ManagerController) Name() string

Name implements controller.Controller interface.

func (*ManagerController) Outputs

func (ctrl *ManagerController) Outputs() []controller.Output

Outputs implements controller.Controller interface.

func (*ManagerController) Run

func (ctrl *ManagerController) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) error

Run implements controller.Controller interface.

type StatusController

type StatusController struct {
	// WGClientFunc is a function that returns a WireguardClient.
	//
	// When nil, it defaults to an actual Wireguard client.
	WGClientFunc func() (WireguardClient, error)

	// Interval is the time between peer status checks.
	//
	// When zero, it defaults to DefaultStatusUpdateInterval.
	Interval time.Duration
}

StatusController reports siderolink status.

func (*StatusController) Inputs

func (ctrl *StatusController) Inputs() []controller.Input

Inputs implements controller.Controller interface.

func (*StatusController) Name

func (ctrl *StatusController) Name() string

Name implements controller.Controller interface.

func (*StatusController) Outputs

func (ctrl *StatusController) Outputs() []controller.Output

Outputs implements controller.Controller interface.

func (*StatusController) Run

func (ctrl *StatusController) Run(ctx context.Context, r controller.Runtime, _ *zap.Logger) error

Run implements controller.Controller interface.

type UserspaceWireguardController

type UserspaceWireguardController struct {
	RelayRetryTimeout time.Duration
	DebugDataStream   bool
}

UserspaceWireguardController imlements a controller that manages a Wireguard over GRPC tunnel in userspace.

func (*UserspaceWireguardController) Inputs

func (ctrl *UserspaceWireguardController) Inputs() []controller.Input

Inputs implements controller.Controller interface.

func (*UserspaceWireguardController) Name

func (ctrl *UserspaceWireguardController) Name() string

Name implements controller.Controller interface.

func (*UserspaceWireguardController) Outputs

func (ctrl *UserspaceWireguardController) Outputs() []controller.Output

Outputs implements controller.Controller interface.

func (*UserspaceWireguardController) Run

func (ctrl *UserspaceWireguardController) Run(ctx context.Context, r controller.Runtime, logger *zap.Logger) error

Run implements controller.Controller interface.

type WireguardClient

type WireguardClient interface {
	Device(string) (*wgtypes.Device, error)
	Close() error
}

WireguardClient allows mocking Wireguard client.