README
¶
Config Package
Overview
The config package manages configurations in Go applications,
ensuring compatibility between config.yaml and setup.env.
setup.env is used to setup environment variables.
Note - When both environment variables and config.yaml settings are present, the package prioritizes environment variables, overriding equivalent settings in config.yaml.
Compatible configurations example
The below configurations are compatible in this project.
-
setup.envcontains:export LOGFILE_PATH=beetle.log -
config.yamlhas:logfile: path: ./beetle.log
How to use it
- Get a value using Viper
Note - It's just my preference. config.Init() can be used.
// Package main is the starting point of CM-Beetle
package main
import (
// other packages
"github.com/cloud-barista/cm-beetle/pkg/config"
)
func init() {
common.SystemReady = false
// Initialize the configuration from "config.yaml" file or environment variables
config.Init()
}
func main() {
// Application logic follows
}
Wrapping Up
This setup illustrates the package's ability to harmonize settings from both setup.env and config.yaml,
showcasing its versatility and ease of use.
Documentation
¶
Index ¶
- Variables
- func Init()
- func NVL(str string, def string) string
- type AllowConfig
- type ApiConfig
- type AuthConfig
- type AutoControlConfig
- type BeetleConfig
- type Config
- type LkvStoreConfig
- type LogfileConfig
- type NodeConfig
- type RetrievalConfig
- type SelfConfig
- type TumblebugApiConfig
- type TumblebugConfig
- type UiConfig
Constants ¶
This section is empty.
Variables ¶
var ( RuntimeConfig Config Beetle BeetleConfig Tumblebug TumblebugConfig )
Functions ¶
Types ¶
type AllowConfig ¶ added in v0.2.1
type AllowConfig struct {
Origins string `mapstructure:"origins"`
}
type ApiConfig ¶ added in v0.2.1
type ApiConfig struct {
Allow AllowConfig `mapstructure:"allow"`
Auth AuthConfig `mapstructure:"auth"`
Username string `mapstructure:"username"`
Password string `mapstructure:"password"`
}
type AuthConfig ¶ added in v0.2.1
type AutoControlConfig ¶ added in v0.2.1
type AutoControlConfig struct {
DurationMilliSec int `mapstructure:"duration_ms"`
}
type BeetleConfig ¶ added in v0.2.1
type BeetleConfig struct {
Root string `mapstructure:"root"`
Self SelfConfig `mapstructure:"self"`
API ApiConfig `mapstructure:"api"`
UI UiConfig `mapstructure:"ui"`
LKVStore LkvStoreConfig `mapstructure:"lkvstore"`
LogFile LogfileConfig `mapstructure:"logfile"`
LogLevel string `mapstructure:"loglevel"`
LogWriter string `mapstructure:"logwriter"`
Node NodeConfig `mapstructure:"node"`
AutoControl AutoControlConfig `mapstructure:"autocontrol"`
Tumblebug TumblebugConfig `mapstructure:"tumblebug"`
}
type Config ¶ added in v0.2.1
type Config struct {
Beetle BeetleConfig `mapstructure:"beetle"`
}
type LkvStoreConfig ¶ added in v0.2.1
type LkvStoreConfig struct {
Path string `mapstructure:"path"`
}
type LogfileConfig ¶ added in v0.2.1
type NodeConfig ¶ added in v0.2.1
type NodeConfig struct {
Env string `mapstructure:"env"`
}
type RetrievalConfig ¶ added in v0.5.8
type RetrievalConfig struct {
RequestsPerSec float64 `mapstructure:"requests_per_sec"`
MaxWaitSec int `mapstructure:"max_wait_sec"`
}
RetrievalConfig describes the rate limit CB-Tumblebug enforces on its retrieval APIs, so Beetle can pace its own calls to stay under it. This is not TB's global limit: TB caps those routes far more tightly. TB applies it per client IP, so it governs the whole Beetle process. State TB's actual limit in RequestsPerSec; Beetle subtracts its own margin. MaxWaitSec is how long a call may wait for a slot before giving up with 503. See pkg/client/tumblebug/call-pacer.go.
type SelfConfig ¶ added in v0.2.1
type SelfConfig struct {
Endpoint string `mapstructure:"endpoint"`
}
type TumblebugApiConfig ¶ added in v0.2.1
type TumblebugConfig ¶ added in v0.2.1
type TumblebugConfig struct {
Endpoint string `mapstructure:"endpoint"`
RestUrl string `mapstructure:"resturl"`
API TumblebugApiConfig `mapstructure:"api"`
Retrieval RetrievalConfig `mapstructure:"retrieval"`
}
Source Files