config

Documentation

Index

• func LocalIP() (net.IP, error)
• func LocalIPString() string
• type AuthScheme
• type BGP
• type BGPPeer
• type BasicAuth
• type CertSource
• type Circonus
• type Config
  • func Load(args, environ []string) (cfg *Config, err error)
• type Consul
• type ConsulTlS
• type Custom
• type File
• type FlagSet
  • func NewFlagSet(name string, errorHandling flag.ErrorHandling) *FlagSet
  • func (f *FlagSet) FloatSliceVar(p *[]float64, name string, value []float64, usage string)
  • func (f *FlagSet) IsSet(name string) bool
  • func (f *FlagSet) ParseFlags(args, environ, prefixes []string, p *properties.Properties) error
  • func (f *FlagSet) StringSliceVar(p *[]string, name string, value []string, usage string)
• type Listen
• type Log
• type Metrics
• type Prometheus
• type Proxy
• type Registry
• type RoutingTable
• type Runtime
• type STSHeader
• type Source
• type Static
• type Tracing
• type UI

Functions

func LocalIP

func LocalIP() (net.IP, error)

LocalIP tries to determine a non-loopback address for the local machine

func LocalIPString

func LocalIPString() string

Types

type AuthScheme

type AuthScheme struct {
	Name  string
	Type  string
	Basic BasicAuth
}

type BGP

type BGP struct {
	BGPEnabled        bool
	Asn               uint
	AnycastAddresses  []string
	RouterID          string
	ListenPort        int
	ListenAddresses   []string
	Peers             []BGPPeer
	EnableGRPC        bool
	GRPCListenAddress string
	GRPCTLS           bool
	CertFile          string
	KeyFile           string
	GOBGPDCfgFile     string
	NextHop           string
}

type BGPPeer

type BGPPeer struct {
	NeighborAddress string
	NeighborPort    uint
	Asn             uint
	MultiHop        bool
	MultiHopLength  uint
	Password        string
}

type BasicAuth

type BasicAuth struct {
	Realm   string
	File    string
	Refresh time.Duration
	ModTime time.Time // the htpasswd file last modification time
}

type CertSource

type CertSource struct {
	Name            string
	Type            string
	CertPath        string
	KeyPath         string
	ClientCAPath    string
	CAUpgradeCN     string
	Refresh         time.Duration
	Header          http.Header
	VaultFetchToken string
}

type Circonus

type Circonus struct {
	APIKey        string
	APIApp        string
	APIURL        string
	CheckID       string
	BrokerID      string
	SubmissionURL string
}

type Config

type Config struct {
	Proxy                Proxy
	Registry             Registry
	Listen               []Listen
	Log                  Log
	Metrics              Metrics
	UI                   UI
	Runtime              Runtime
	Tracing              Tracing
	ProfileMode          string
	ProfilePath          string
	Insecure             bool
	GlobMatchingDisabled bool
	GlobCacheSize        int
	BGP                  BGP
}

func Load

func Load(args, environ []string) (cfg *Config, err error)

type Consul

type Consul struct {
	Addr               string
	Scheme             string
	Token              string
	KVPath             string
	NoRouteHTMLPath    string
	TagPrefix          string
	Register           bool
	ServiceAddr        string
	ServiceName        string
	ServiceTags        []string
	ServiceStatus      []string
	CheckInterval      time.Duration
	CheckTimeout       time.Duration
	CheckScheme        string
	CheckTLSSkipVerify bool
	ChecksRequired     string
	ServiceMonitors    int
	TLS                ConsulTlS
	PollInterval       time.Duration
	RequireConsistent  bool
	AllowStale         bool
}

type ConsulTlS

type ConsulTlS struct {
	KeyFile            string
	CertFile           string
	CAFile             string
	CAPath             string
	InsecureSkipVerify bool
}

type Custom

type Custom struct {
	Host               string
	Path               string
	QueryParams        string
	Scheme             string
	CheckTLSSkipVerify bool
	PollInterval       time.Duration
	NoRouteHTML        string
	Timeout            time.Duration
}

type File

type File struct {
	NoRouteHTMLPath string
	RoutesPath      string
}

type FlagSet

type FlagSet struct {
	flag.FlagSet
	// contains filtered or unexported fields
}

-- FlagSet

func NewFlagSet

func NewFlagSet(name string, errorHandling flag.ErrorHandling) *FlagSet

func (*FlagSet) FloatSliceVar

func (f *FlagSet) FloatSliceVar(p *[]float64, name string, value []float64, usage string)

func (*FlagSet) IsSet

func (f *FlagSet) IsSet(name string) bool

IsSet returns true if a variable was set via any mechanism.

func (*FlagSet) ParseFlags

func (f *FlagSet) ParseFlags(args, environ, prefixes []string, p *properties.Properties) error

ParseFlags parses command line arguments and provides fallback values from environment variables and config file values. Environment variables are case-insensitive and can have either of the provided prefixes.

func (*FlagSet) StringSliceVar

func (f *FlagSet) StringSliceVar(p *[]string, name string, value []string, usage string)

type Listen

type Listen struct {
	Addr               string
	Proto              string
	ReadTimeout        time.Duration
	WriteTimeout       time.Duration
	IdleTimeout        time.Duration
	CertSource         CertSource
	StrictMatch        bool
	TLSMinVersion      uint16
	TLSMaxVersion      uint16
	TLSCiphers         []uint16
	ProxyProto         bool
	ProxyHeaderTimeout time.Duration
	Refresh            time.Duration
}

type Log

type Log struct {
	AccessFormat string
	AccessTarget string
	RoutesFormat string
	Level        string
}

type Metrics

type Metrics struct {
	Target        string
	Prefix        string
	Names         string
	Interval      time.Duration
	Timeout       time.Duration
	Retry         time.Duration
	GraphiteAddr  string
	StatsDAddr    string
	DogstatsdAddr string
	Circonus      Circonus
	Prometheus    Prometheus
}

type Prometheus

type Prometheus struct {
	Subsystem string
	Path      string
	Buckets   []float64
}

type Proxy

type Proxy struct {
	Strategy              string
	Matcher               string
	NoRouteStatus         int
	MaxConn               int
	ShutdownWait          time.Duration
	DeregisterGracePeriod time.Duration
	DialTimeout           time.Duration
	ResponseHeaderTimeout time.Duration
	KeepAliveTimeout      time.Duration
	IdleConnTimeout       time.Duration
	FlushInterval         time.Duration
	GlobalFlushInterval   time.Duration
	LocalIP               string
	ClientIPHeader        string
	TLSHeader             string
	TLSHeaderValue        string
	GZIPContentTypes      *regexp.Regexp
	RequestID             string
	STSHeader             STSHeader
	AuthSchemes           map[string]AuthScheme
	GRPCMaxRxMsgSize      int
	GRPCMaxTxMsgSize      int
}

type Registry

type Registry struct {
	Backend string
	Static  Static
	File    File
	Consul  Consul
	Custom  Custom
	Timeout time.Duration
	Retry   time.Duration
}

type RoutingTable

type RoutingTable struct {
	Source Source
}

type Runtime

type Runtime struct {
	GOGC       int
	GOMAXPROCS int
}

type STSHeader

type STSHeader struct {
	MaxAge     int
	Subdomains bool
	Preload    bool
}

type Source

type Source struct {
	LinkEnabled bool
	NewTab      bool
	Scheme      string
	Host        string
	Port        string
}

type Static

type Static struct {
	NoRouteHTML string
	Routes      string
}

type Tracing

type Tracing struct {
	TracingEnabled bool
	CollectorType  string
	ConnectString  string
	ServiceName    string
	Topic          string
	SamplerRate    float64
	SpanHost       string
	SpanName       string
	TraceID128Bit  bool
}

type UI

type UI struct {
	Listen       Listen
	Color        string
	Title        string
	Access       string
	RoutingTable RoutingTable
}