sidecar

Documentation

Index

• Constants
• Variables
• func GetRunners() []string
• func Run(runnerName string) error
• type DockerNetwork
  • func (dn *DockerNetwork) Close() error
  • func (dn *DockerNetwork) ConfigureNetwork(ctx context.Context, cfg *sync.NetworkConfig) error
  • func (dn *DockerNetwork) ListActive() []string
  • func (dn *DockerNetwork) ListAvailable() []string
• type DockerReactor
  • func (d *DockerReactor) Close() error
  • func (d *DockerReactor) Handle(globalctx context.Context, handler InstanceHandler) error
• type Instance
  • func NewInstance(ctx context.Context, runenv *runtime.RunEnv, hostname string, network Network) (*Instance, error)
  • func (inst *Instance) Close() error
• type InstanceHandler
• type K8sNetwork
  • func (n *K8sNetwork) Close() error
  • func (n *K8sNetwork) ConfigureNetwork(ctx context.Context, cfg *sync.NetworkConfig) error
  • func (n *K8sNetwork) ListActive() []string
• type K8sReactor
  • func (d *K8sReactor) Close() error
  • func (d *K8sReactor) Handle(ctx context.Context, handler InstanceHandler) error
• type NetlinkLink
  • func NewNetlinkLink(handle *netlink.Handle, link netlink.Link) (*NetlinkLink, error)
  • func (l *NetlinkLink) AddrAdd(ip *net.IPNet) error
  • func (l *NetlinkLink) AddrDel(ip *net.IPNet) error
  • func (l *NetlinkLink) Down() error
  • func (l *NetlinkLink) ListV4() ([]*net.IPNet, error)
  • func (l *NetlinkLink) ListV6() ([]*net.IPNet, error)
  • func (l *NetlinkLink) Shape(shape sync.LinkShape) error
  • func (l *NetlinkLink) Up() error
• type Network
• type Reactor
  • func NewDockerReactor() (Reactor, error)
  • func NewK8sReactor() (Reactor, error)

Constants

const (
	EnvRedisHost = "REDIS_HOST"
)

Variables

var PublicAddr = net.ParseIP("1.1.1.1")

PublicAddr points to an IP address in the public range. It helps us discover the IP address of the gateway (i.e. the Docker host) on the control network (the learned route will be via the control network because, at this point, the only network that's attached to the container is the control network).

Sidecar doesn't whitelist traffic to public addresses, but it special-cases traffic between the container and the host, so that pprof, metrics and other ports can be exposed to the Docker host.

Functions

func GetRunners

func GetRunners() []string

GetRunners lists the available sidecar environments.

func Run

func Run(runnerName string) error

Run runs the sidecar in the given runner environment.

Types

type DockerNetwork

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

func (*DockerNetwork) Close

func (dn *DockerNetwork) Close() error

func (*DockerNetwork) ConfigureNetwork

func (dn *DockerNetwork) ConfigureNetwork(ctx context.Context, cfg *sync.NetworkConfig) error

func (*DockerNetwork) ListActive

func (dn *DockerNetwork) ListActive() []string

func (*DockerNetwork) ListAvailable

func (dn *DockerNetwork) ListAvailable() []string

type DockerReactor

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

func (*DockerReactor) Close

func (d *DockerReactor) Close() error

func (*DockerReactor) Handle

func (d *DockerReactor) Handle(globalctx context.Context, handler InstanceHandler) error

type Instance

type Instance struct {
	logging.Logging

	Hostname string
	Watcher  *sync.Watcher
	Writer   *sync.Writer
	RunEnv   *runtime.RunEnv
	Network  Network
}

Instance is a test instance as seen by the sidecar.

func NewInstance

func NewInstance(ctx context.Context, runenv *runtime.RunEnv, hostname string, network Network) (*Instance, error)

NewInstance constructs a new test instance handle.

func (*Instance) Close

func (inst *Instance) Close() error

Close closes the instance. It should not be used after closing.

type InstanceHandler

type InstanceHandler func(context.Context, *Instance) error

type K8sNetwork

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

func (*K8sNetwork) Close

func (n *K8sNetwork) Close() error

func (*K8sNetwork) ConfigureNetwork

func (n *K8sNetwork) ConfigureNetwork(ctx context.Context, cfg *sync.NetworkConfig) error

func (*K8sNetwork) ListActive

func (n *K8sNetwork) ListActive() []string

type K8sReactor

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

func (*K8sReactor) Close

func (d *K8sReactor) Close() error

func (*K8sReactor) Handle

func (d *K8sReactor) Handle(ctx context.Context, handler InstanceHandler) error

type NetlinkLink

type NetlinkLink struct {
	netlink.Link
	// contains filtered or unexported fields
}

NetlinkLink abstracts operations over a network interface.

NetlinkLink shapes the egress traffic on the link using TC. To do so, it configures the following TC tree:

[________HTB Qdisc_________] - root
   0 |      1 |     n | ...  - queue; 0 is the default.
[HTB Class]                  - bandwidth (rate limiting)
     |
[Netem Qdisc]                - latency, jitter, etc. (per-packet attributes)

At the moment, only one queue is supported. When support for multiple subnets is added, additional classes/queues will be added per-subnet.

NetlinkLink also supports setting the network device up/down and changing the IP address.

NOTE: Not all run environments will react well to the IP address changing. Don't use this feature with docker.

func NewNetlinkLink

func NewNetlinkLink(handle *netlink.Handle, link netlink.Link) (*NetlinkLink, error)

NewNetlinkLink constructs a new netlink link handle.

func (*NetlinkLink) AddrAdd

func (l *NetlinkLink) AddrAdd(ip *net.IPNet) error

AddrAdd adds an address to the link.

NOTE: This won't work in docker; use docker connect/disconnect.

func (*NetlinkLink) AddrDel

func (l *NetlinkLink) AddrDel(ip *net.IPNet) error

AddrDel removes an address from the link.

NOTE: This won't work in docker; use docker connect/disconnect.

func (*NetlinkLink) Down

func (l *NetlinkLink) Down() error

Down takes the link down.

func (*NetlinkLink) ListV4

func (l *NetlinkLink) ListV4() ([]*net.IPNet, error)

ListV4 lists all IPv4 addresses associated with the link.

func (*NetlinkLink) ListV6

func (l *NetlinkLink) ListV6() ([]*net.IPNet, error)

ListV6 lists all IPv6 addresses associated with the link.

func (*NetlinkLink) Shape

func (l *NetlinkLink) Shape(shape sync.LinkShape) error

Shape applies the link "shape" to the link, setting the bandwidth, latency, jitter, etc.

func (*NetlinkLink) Up

func (l *NetlinkLink) Up() error

Up sets the link up.

type Network

type Network interface {
	io.Closer

	ConfigureNetwork(ctx context.Context, cfg *sync.NetworkConfig) error
	ListActive() []string
}

Network is a test instance's network, as seen by the sidecar.

Sidecar runners must implement this interface.

type Reactor

type Reactor interface {
	io.Closer

	Handle(context.Context, InstanceHandler) error
}

func NewDockerReactor

func NewDockerReactor() (Reactor, error)

func NewK8sReactor

func NewK8sReactor() (Reactor, error)