encapsulation

Documentation

Index

• type Encapsulator
  • func NewCilium(strategy Strategy) Encapsulator
  • func NewFlannel(strategy Strategy) Encapsulator
  • func NewIPIP(strategy Strategy) Encapsulator
• type Noop
  • func (n Noop) CleanUp() error
  • func (n Noop) Gw(_, _, _ net.IP, _ *net.IPNet) net.IP
  • func (n Noop) Index() int
  • func (n Noop) Init(_ int) error
  • func (n Noop) LocalIP() net.IP
  • func (n Noop) Rules(_ []*net.IPNet) iptables.RuleSet
  • func (n Noop) Set(_ *net.IPNet) error
  • func (n Noop) Strategy() Strategy
• type Strategy

Types

type Encapsulator

type Encapsulator interface {
	CleanUp() error
	Gw(net.IP, net.IP, net.IP, *net.IPNet) net.IP
	Index() int
	Init(int) error
	// LocalIP returns the local overlay IP that should be advertised
	// to other nodes. For Cilium, this is the IP of the cilium_host interface.
	LocalIP() net.IP
	Rules([]*net.IPNet) iptables.RuleSet
	Set(*net.IPNet) error
	Strategy() Strategy
}

Encapsulator can: * configure the encapsulation interface; * determine the gateway IP corresponding to a node; * get the encapsulation interface index; * set the interface IP address; * return the required IPTables rules; * return the encapsulation strategy; and * clean up any changes applied to the backend.

func NewCilium

func NewCilium(strategy Strategy) Encapsulator

NewCilium returns an encapsulator that uses IPIP tunnels routed through Cilium's VxLAN overlay.

func NewFlannel

func NewFlannel(strategy Strategy) Encapsulator

NewFlannel returns an encapsulator that uses Flannel.

func NewIPIP

func NewIPIP(strategy Strategy) Encapsulator

NewIPIP returns an encapsulator that uses IPIP.

type Noop

type Noop Strategy

Noop is an encapsulation that does nothing.

func (Noop) CleanUp

func (n Noop) CleanUp() error

CleanUp will also do nothing.

func (Noop) Gw

func (n Noop) Gw(_, _, _ net.IP, _ *net.IPNet) net.IP

Gw will also do nothing.

func (Noop) Index

func (n Noop) Index() int

Index will also do nothing.

func (Noop) Init

func (n Noop) Init(_ int) error

Init will also do nothing.

func (Noop) LocalIP

func (n Noop) LocalIP() net.IP

LocalIP will also do nothing.

func (Noop) Rules

func (n Noop) Rules(_ []*net.IPNet) iptables.RuleSet

Rules will also do nothing.

func (Noop) Set

func (n Noop) Set(_ *net.IPNet) error

Set will also do nothing.

func (Noop) Strategy

func (n Noop) Strategy() Strategy

Strategy will finally do nothing.

type Strategy

type Strategy string

Strategy identifies which packets within a location should be encapsulated.

const (
	// Never indicates that no packets within a location
	// should be encapsulated.
	Never Strategy = "never"
	// CrossSubnet indicates that only packets that
	// traverse subnets within a location should be encapsulated.
	CrossSubnet Strategy = "crosssubnet"
	// Always indicates that all packets within a location
	// should be encapsulated.
	Always Strategy = "always"
)