config

Documentation

Index

• Variables
• func SerializeConfig(cfg *Config) ([]byte, error)
• type Config
  • func Load() *Config
  • func ParseConfig(cfgFile string) (*Config, error)
  • func (c *Config) GetConfigFile() string
  • func (c *Config) Reload()
• type Sidecar

Variables

var (
	File string
)

Functions

func SerializeConfig

func SerializeConfig(cfg *Config) ([]byte, error)

Types

type Config

type Config struct {
	File             string             `yaml:",omitempty"`
	WorkingDirectory string             `yaml:"workdir,omitempty"`
	Excludes         []string           `yaml:"excludes"`
	Pipeline         []string           `yaml:"pipeline"`
	Growl            bool               `yaml:"growl,omitempty"`
	Server           string             `yaml:"server,omitempty"`
	Sidecars         map[string]Sidecar `yaml:"sidecars,omitempty"`
}

Config is the root cfg object

func Load

func Load() *Config

Load bootstraps the cfg object with the cfg file.

func ParseConfig

func ParseConfig(cfgFile string) (*Config, error)

ParseConfig reads and parses a cfg file.

func (*Config) GetConfigFile

func (c *Config) GetConfigFile() string

Returns the loaded cfg file name.

func (*Config) Reload

func (c *Config) Reload()

Reloads this configuration. It will panic if an error occurs.

type Sidecar

type Sidecar struct {
	Image       string            `yaml:"image"`
	Environment map[string]string `yaml:"env,omitempty"`
	Script      string            `yaml:"script,omitempty"`
	Volumes     map[string]string `yaml:"volumes,omitempty"`
}

Sidecar defines a background ("sidecar") service that is kept running