cfg

package

v1.2.1 Latest Latest Go to latest Published: Dec 22, 2023 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/TelefonicaTC2Tech/golium

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Load(path string, config interface{}) error
func LoadEnv(config interface{}) error
func LoadYaml(path string, config interface{}) error
type Config
type DirConfig
type LogConfig

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultConfig = Config{
	Suite:       "golium",
	Environment: "local",
	Dir: DirConfig{
		Config:       "./",
		Schemas:      "./schemas",
		Environments: "./environments",
	},
	Log: LogConfig{
		Directory: "./logs",
		Level:     "INFO",
		Encode:    false,
	},
}

DefaultConfig is the default configuration for golium. This default configuration can be overridden with environment variables.

Functions ¶

func Load ¶

func Load(path string, config interface{}) error

Load reads the configuration from a yml file (at path) and from environment variables.

func LoadEnv ¶

func LoadEnv(config interface{}) error

LoadEnv loads the environment variables into config struct.

func LoadYaml ¶

func LoadYaml(path string, config interface{}) error

LoadYaml reads a yaml file at path in the config struct.

Types ¶

type Config ¶

type Config struct {
	Suite       string    `yaml:"suite" envconfig:"SUITE"`
	Environment string    `yaml:"environment" envconfig:"ENVIRONMENT"`
	Dir         DirConfig `yaml:"dir"`
	Log         LogConfig `yaml:"log"`
}

Config contains the configuration for golium project.

type DirConfig ¶

type DirConfig struct {
	Config       string `yaml:"config" envconfig:"DIR_CONFIG"`
	Schemas      string `yaml:"schemas" envconfig:"DIR_SCHEMAS"`
	Environments string `yaml:"environments" envconfig:"DIR_ENVIRONMENTS"`
}

DirConfig to configure some configuration directories.

type LogConfig ¶

type LogConfig struct {
	Directory string `yaml:"directory" envconfig:"LOG_DIRECTORY"`
	Level     string `yaml:"level" envconfig:"LOG_LEVEL"`
	Encode    bool   `yaml:"encode" envconfig:"LOG_ENCODE"`
}

LogConfig to configure logging.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL