envoy

Documentation

Index

• Variables
• func NewRuntime(options ...RuntimeOption) (binary.FetchRunner, error)
• type Config
  • func NewConfig(options ...func(*Config)) *Config
  • func (c *Config) GetAdminAddress() string
• type Mode
  • func ParseMode(s string) Mode
• type Runtime
  • func (r *Runtime) AlreadyDownloaded(key *manifest.Key) bool
  • func (r *Runtime) AppendArgs(args []string)
  • func (r *Runtime) BinaryStore() string
  • func (r *Runtime) DebugStore() string
  • func (r *Runtime) Fetch(key *manifest.Key, binaryLocation string) error
  • func (r *Runtime) FetchAndRun(reference string, args []string) error
  • func (r *Runtime) GetPid() (int, error)
  • func (r *Runtime) RegisterDone()
  • func (r *Runtime) RegisterPreStart(f ...func(binary.Runner) error)
  • func (r *Runtime) RegisterPreTermination(f ...func(binary.Runner) error)
  • func (r *Runtime) RegisterWait(delta int)
  • func (r *Runtime) Run(key *manifest.Key, args []string) error
  • func (r *Runtime) RunPath(path string, args []string) error
  • func (r *Runtime) SaveConfig(name, config string) (string, error)
  • func (r *Runtime) SendSignal(s os.Signal)
  • func (r *Runtime) SetStderr(fn func(io.Writer) io.Writer)
  • func (r *Runtime) SetStdout(fn func(io.Writer) io.Writer)
  • func (r *Runtime) Status() int
  • func (r *Runtime) Wait(state int)
  • func (r *Runtime) WaitWithContext(ctx context.Context, state int)
• type RuntimeOption
  • func (o RuntimeOption) And(opts ...RuntimeOption) RuntimeOptions
  • func (o RuntimeOption) AndAll(opts RuntimeOptions) RuntimeOptions
• type RuntimeOptions
  • func (o RuntimeOptions) And(opts ...RuntimeOption) RuntimeOptions
  • func (o RuntimeOptions) AndAll(opts RuntimeOptions) RuntimeOptions

Variables

var SupportedModes = []string{string(LoadBalancer)}

SupportedModes indicate the modes that are current supported by GetEnvoy

Functions

func NewRuntime

func NewRuntime(options ...RuntimeOption) (binary.FetchRunner, error)

NewRuntime creates a new Runtime with the local file storage set to the home directory

Types

type Config

type Config struct {
	XDSAddress     string
	Mode           Mode
	IPAddresses    []string
	ALSAddresss    string
	DrainDuration  *durationpb.Duration
	ConnectTimeout *durationpb.Duration
	AdminAddress   string
	AdminPort      int32
	StatNameLength int32
}

Config store Envoy config information for use by bootstrap and arg mutators

func NewConfig

func NewConfig(options ...func(*Config)) *Config

NewConfig creates and mutates a config object based on passed params

func (*Config) GetAdminAddress

func (c *Config) GetAdminAddress() string

GetAdminAddress returns a host:port formatted address of the Envoy admin listener.

type Mode

type Mode string

Mode is the mode Envoy should run in

const (
	// Sidecar instructs Envoy to run as a sidecar
	Sidecar Mode = "sidecar"
	// LoadBalancer instructs Envoy to run as a loadbalancer (e.g. gateway)
	LoadBalancer Mode = "loadbalancer"
)

func ParseMode

func ParseMode(s string) Mode

ParseMode converts the passed string into a valid mode or empty string

type Runtime

type Runtime struct {
	RootDir string

	TmplDir string
	Config  *Config

	WorkingDir string
	IO         ioutil.StdStreams
	// contains filtered or unexported fields
}

Runtime manages an Envoy lifecycle including fetching (if necessary) and running

func (*Runtime) AlreadyDownloaded

func (r *Runtime) AlreadyDownloaded(key *manifest.Key) bool

AlreadyDownloaded returns true if there is a cached Envoy binary matching the passed Key

func (*Runtime) AppendArgs

func (r *Runtime) AppendArgs(args []string)

AppendArgs appends the passed args to the child process' args

func (*Runtime) BinaryStore

func (r *Runtime) BinaryStore() string

BinaryStore returns the location at which the runtime instance persists binaries Getters typically aren't idiomatic Go, however, this one is deliberately part of the fetcher interface

func (*Runtime) DebugStore

func (r *Runtime) DebugStore() string

DebugStore returns the location at which the runtime instance persists debug data for this given instance Getters typically aren't idiomatic Go, however, this one is deliberately part of the runner interface

func (*Runtime) Fetch

func (r *Runtime) Fetch(key *manifest.Key, binaryLocation string) error

Fetch downloads an Envoy binary from the passed location

func (*Runtime) FetchAndRun

func (r *Runtime) FetchAndRun(reference string, args []string) error

FetchAndRun downloads an Envoy binary, if necessary, and runs it.

func (*Runtime) GetPid

func (r *Runtime) GetPid() (int, error)

GetPid returns the pid of the child process

func (*Runtime) RegisterDone

func (r *Runtime) RegisterDone()

RegisterDone informs the runtime that you have completed It is a wrapper around sync.WaitGroup.Done()

func (*Runtime) RegisterPreStart

func (r *Runtime) RegisterPreStart(f ...func(binary.Runner) error)

RegisterPreStart registers the passed functions to be run before Envoy has started

func (*Runtime) RegisterPreTermination

func (r *Runtime) RegisterPreTermination(f ...func(binary.Runner) error)

RegisterPreTermination registers the passed functions to be run after Envoy has started and just before GetEnvoy instructs Envoy to terminate

func (*Runtime) RegisterWait

func (r *Runtime) RegisterWait(delta int)

RegisterWait informs the runtime it needs to wait for you to complete It is a wrapper around sync.WaitGroup.Add()

func (*Runtime) Run

func (r *Runtime) Run(key *manifest.Key, args []string) error

Run execs the binary defined by the key with the args passed It is a blocking function that can only be terminated via SIGINT

func (*Runtime) RunPath

func (r *Runtime) RunPath(path string, args []string) error

RunPath execs the binary at the path with the args passed It is a blocking function that can only be terminated via SIGINT

func (*Runtime) SaveConfig

func (r *Runtime) SaveConfig(name, config string) (string, error)

SaveConfig saves configuration string in getenvoy directory.

func (*Runtime) SendSignal

func (r *Runtime) SendSignal(s os.Signal)

SendSignal sends a signal to the parent process

func (*Runtime) SetStderr

func (r *Runtime) SetStderr(fn func(io.Writer) io.Writer)

SetStderr writes the stderr of Envoy to the passed writer

func (*Runtime) SetStdout

func (r *Runtime) SetStdout(fn func(io.Writer) io.Writer)

SetStdout writes the stdout of Envoy to the passed writer

func (*Runtime) Status

func (r *Runtime) Status() int

Status indicates the state of the child process

func (*Runtime) Wait

func (r *Runtime) Wait(state int)

Wait blocks until the child process reaches the state passed Note: It does not guarantee that it is in the specified state just that it has reached it

func (*Runtime) WaitWithContext

func (r *Runtime) WaitWithContext(ctx context.Context, state int)

WaitWithContext blocks until the child process reaches the state passed or the context is canceled Note: It does not guarantee that it is in the specified state just that it has reached it

type RuntimeOption

type RuntimeOption func(*Runtime)

RuntimeOption represents a configuration option to NewRuntime.

func (RuntimeOption) And

func (o RuntimeOption) And(opts ...RuntimeOption) RuntimeOptions

And returns a combined list of configuration options.

func (RuntimeOption) AndAll

func (o RuntimeOption) AndAll(opts RuntimeOptions) RuntimeOptions

AndAll returns a combined list of configuration options.

type RuntimeOptions

type RuntimeOptions []RuntimeOption

RuntimeOptions represents a list of configuration options to NewRuntime.

func (RuntimeOptions) And

func (o RuntimeOptions) And(opts ...RuntimeOption) RuntimeOptions

And returns a combined list of configuration options.

func (RuntimeOptions) AndAll

func (o RuntimeOptions) AndAll(opts RuntimeOptions) RuntimeOptions

AndAll returns a combined list of configuration options.