tunnel

Documentation

Index

• type Opts
• type Status
• type Tunnel
  • func NewTunnel(opts Opts) (*Tunnel, error)
  • func (t *Tunnel) IsReady() (bool, string)
  • func (t *Tunnel) Run() error
  • func (t *Tunnel) Status() Status

Types

type Opts

type Opts struct {
	PoolSize    int
	DialTimeout time.Duration

	URL *url.URL

	EnvoySocket string

	TLSEnabled bool
}

Opts are the options for configuring a Tunnel.

type Status

type Status struct {
	URL         string `json:"url"`
	SizeDesired int    `json:"size_desired"`
	SizeCurrent int    `json:"size_current"`
}

Status is the current status of the Tunnel.

type Tunnel

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

Tunnel establishes a TCP connection between the proxy (running remotely) and Envoy (running alongside the agent).

func NewTunnel

func NewTunnel(opts Opts) (*Tunnel, error)

NewTunnel instantiates a new Tunnel.

func (*Tunnel) IsReady

func (t *Tunnel) IsReady() (bool, string)

IsReady returns true if the channel is ready. If not, it returns a message describing why it is not ready.

func (*Tunnel) Run

func (t *Tunnel) Run() error

Run is a blocking command that: - creates a connection to:

• the local Envoy socket
• the connect proxy in the Global Controller

- bridges the connections

func (*Tunnel) Status

func (t *Tunnel) Status() Status

Status returns the current status of the Tunnel.