options

Documentation

Index

• type Options
  • func New() *Options
  • func SetDefaults(name string, options *Options, metadata yamlx.KeyLookup) (*Options, error)
  • func (o *Options) Clone() *Options

Types

type Options

type Options struct {
	// MechanismName indicates the name of the load balancing mechanism
	MechanismName string `yaml:"mechanism,omitempty"`
	// Pool provides the list of backend names to be used by the load balancer
	Pool []string `yaml:"pool,omitempty"`
	// HealthyFloor is the minimum health check status value to be considered Available in the pool
	// -1 : all pool members are Available regardless of health check status
	//  0 (default) : pool members with status of unknown (0) or healthy (1) are Available
	//  1 : only pool members with status of healthy (1) are Available
	// unknown means the first hc hasn't returned yet,
	// or (more likely) HealthCheck Interval on target backend is not set
	HealthyFloor int `yaml:"healthy_floor,omitempty"`
	// OutputFormat accompanies the tsmerge Mechanism to indicate the provider output format
	// options include any valid time seres backend like prometheus, influxdb or clickhouse
	OutputFormat string `yaml:"output_format,omitempty"`
	// FGRStatusCodes provides an explicit list of status codes considered "good" when using
	// the First Good Response (fgr) methodology. By default, any code < 400 is good.
	FGRStatusCodes []int `yaml:"fgr_status_codes"`
	//
	// synthetic values
	FgrCodesLookup map[int]interface{} `yaml:"-"`
}

Options defines options for ALBs

func New

func New() *Options

New returns a New Options object with the default values

func SetDefaults

func SetDefaults(name string, options *Options, metadata yamlx.KeyLookup) (*Options, error)

SetDefaults iterates the provided Options, and overlays user-set values onto the default Options

func (*Options) Clone

func (o *Options) Clone() *Options

Clone returns a perfect copy of the Options