config

Documentation

Index

• Constants
• func InConfigDir(filename string) string
• func Update(mutate func(cfg *Config) error) error
• type Config
  • func Start(updateHandler func(updated *Config)) (*Config, error)
  • func (cfg *Config) ApplyDefaults()
  • func (cfg *Config) GetVersion() int
  • func (cfg *Config) IsDownstream() bool
  • func (cfg *Config) IsUpstream() bool
  • func (cfg *Config) SetVersion(version int)

Constants

const (
	CloudConfigPollInterval = 1 * time.Minute
)

Functions

func InConfigDir

func InConfigDir(filename string) string

InConfigDir returns the path to the given filename inside of the configdir.

func Update

func Update(mutate func(cfg *Config) error) error

Update updates the configuration using the given mutator function.

Types

type Config

type Config struct {
	Version       int
	CloudConfig   string
	CloudConfigCA string
	Addr          string
	Role          string
	Country       string
	StatsAddr     string
	CpuProfile    string
	MemProfile    string
	Stats         *statreporter.Config
	Server        *server.ServerConfig
	Client        *client.ClientConfig
}

func Start

func Start(updateHandler func(updated *Config)) (*Config, error)

Start starts the configuration system.

func (*Config) ApplyDefaults

func (cfg *Config) ApplyDefaults()

ApplyDefaults implements the method from interface yamlconf.Config

ApplyDefaults populates default values on a Config to make sure that we have a minimum viable config for running. As new settings are added to flashlight, this function should be updated to provide sensible defaults for those settings.

func (*Config) GetVersion

func (cfg *Config) GetVersion() int

GetVersion implements the method from interface yamlconf.Config

func (*Config) IsDownstream

func (cfg *Config) IsDownstream() bool

func (*Config) IsUpstream

func (cfg *Config) IsUpstream() bool

func (*Config) SetVersion

func (cfg *Config) SetVersion(version int)

SetVersion implements the method from interface yamlconf.Config