loader

README

loader

Loader is a library for loading configuration from various sources.

Documentation

Index

• func InnerPath(s string, v map[string]interface{}) interface{}
• func MapPath(s string, v interface{}) interface{}
• func SetLogToCtx(ctx context.Context, log Logger) context.Context
• type Cache
• type Call
• type Config
• type ConfigConsul
• type ConfigContent
• type ConfigDynamic
• type ConfigFile
• type ConfigStatic
• type ConfigVault
• type Configs
  • func (c Configs) Load(ctx context.Context, wg *sync.WaitGroup, cache *Cache, call Call) error
• type Data
  • func (d *Data) AddHold(k string, v interface{})
  • func (d *Data) Merge(v map[string]interface{})
• type Logger

Functions

func InnerPath

func InnerPath(s string, v map[string]interface{}) interface{}

func MapPath

func MapPath(s string, v interface{}) interface{}

func SetLogToCtx

func SetLogToCtx(ctx context.Context, log Logger) context.Context

Types

type Cache

type Cache struct {
	Consul   *consul.API
	Vault    *vault.API
	File     *file.API
	Template *templatex.Template
}

type Call

type Call func(context.Context, string, map[string]interface{})

type Config

type Config struct {
	// Name for export value, default is empty.
	Name       string
	Export     string
	FilePerm   string
	FolderPerm string
	Statics    []ConfigStatic
	Dynamics   []ConfigDynamic
}

type ConfigConsul

type ConfigConsul struct {
	// Name for export, default is empty.
	Name string
	// Path is the location in consul KV.
	Path string
	// PathPrefix default is empty.
	PathPrefix string
	// Raw to load as raw, don't mix with other loaders.
	Raw bool
	// Codec YAML,JSON,TOML default is YAML.
	Codec string
	// InnerPath is get the inner path from vault response, / separated as db/settings.
	// Cannot work with Raw.
	InnerPath string
	// Map is the wrapper map, / separated as db/settings.
	Map string
	// Template to run go template after the load.
	Template bool
	// base64 to decode the content.
	Base64 bool
}

type ConfigContent

type ConfigContent struct {
	// Name for export, default is empty.
	Name string
	// Codec YAML,JSON,TOML default is YAML.
	Codec   string
	Content string
	Raw     bool
	// InnerPath is get the inner path from vault response, / separated as db/settings.
	// Cannot work with Raw.
	InnerPath string
	// Map is the wrapper map, / separated as db/settings.
	Map string
	// Template to run go template after the load.
	Template bool
	// base64 to decode the content.
	Base64 bool
}

type ConfigDynamic

type ConfigDynamic struct {
	Consul *ConfigConsul
}

type ConfigFile

type ConfigFile struct {
	// Name for export, default is empty.
	Name string
	// Path is the file location, [toml, yml, yaml, json] supported.
	Path string
	// Raw to load as raw, don't mix with other loaders.
	Raw bool
	// InnerPath is get the inner path from vault response, / separated as db/settings.
	// Cannot work with Raw.
	InnerPath string
	// Map is the wrapper map, / separated as db/settings.
	Map string
	// Template to run go template after the load.
	Template bool
	// base64 to decode the content.
	Base64 bool
}

type ConfigStatic

type ConfigStatic struct {
	Consul  *ConfigConsul
	Vault   *ConfigVault
	File    *ConfigFile
	Content *ConfigContent
}

type ConfigVault

type ConfigVault struct {
	// Name for export, default is empty.
	Name string
	Path string
	// PathPrefix default is empty, path_prefix is must!
	PathPrefix string
	// AppRoleBasePath default is auth/approle/login, not need to set.
	AppRoleBasePath string
	// InnerPath is get the inner path from vault response, / separated as db/settings.
	InnerPath string
	// Map is the wrapper map, / separated as db/settings.
	Map string
	// Template to run go template after the load.
	Template bool
	// base64 to decode the content.
	Base64 bool
}

type Configs

type Configs []Config

func (Configs) Load

func (c Configs) Load(ctx context.Context, wg *sync.WaitGroup, cache *Cache, call Call) error

Load loads all configs to export location. If loads with dynamic config, cancel context to stop loading.

type Data

type Data struct {
	Map  map[string]interface{}
	Raw  []byte
	Hold map[string]interface{}
}

func (*Data) AddHold

func (d *Data) AddHold(k string, v interface{})

func (*Data) Merge

func (d *Data) Merge(v map[string]interface{})

type Logger

type Logger interface {
	Error(msg string, keysAndValues ...interface{})
	Warn(msg string, keysAndValues ...interface{})
	Info(msg string, keysAndValues ...interface{})
	Debug(msg string, keysAndValues ...interface{})
}