Golang Microservice configuration module
Configuration module for microservices written on Go. Preserves corporate standards for services configuration.
Installation
Using go get
:
go get github.com/imdario/mergo
Using dep
:
dep ensure -add github.com/microparts/configuration-golang
Import in your configuration file
import (
"github.com/microparts/configuration-golang"
)
Usage
Some agreements:
- Configuration must be declared as struct and reveals yaml structure
- Default config folder:
./configuration
. If you need to override, pass your path in ReadConfig
function
- Default stage is
development
. To override, set STAGE
env variable
Code example:
package main
import (
"github.com/microparts/configuration-golang"
"gopkg.in/yaml.v2"
"log"
)
// Your app config structure. This must be related to yaml config file structure. Everything that is not
// in this struct will be passed and will not be processed.
// Keep in mind that inheritance must be implemented with `struct{}`
type ConfigStruct struct {
Log struct {
Level string `yaml:"level"`
Debug bool `yaml:"debug"`
Format string `yaml:"yaml"`
} `yaml:"log"`
Database struct {
Host string `yaml:"host"`
Port string `yaml:"port"`
User string `yaml:"user"`
Pass string `yaml:"password"`
Name string `yaml:"name"`
SslMode string `yaml:"sslMode"`
Logs bool `yaml:"logs"`
MigrateOnStart bool `yaml:"migrateOnStart"`
MigrationPath string `yaml:"migrationsPath"`
} `yaml:"db"`
Http struct {
Host string `yaml:"host"`
Port string `yaml:"port"`
} `yaml:"ws"`
}
func main() {
// Reader accept config path as param. Commonly it stored like STAGE in ENV.
configPath := config.GetEnv("CONFIG_PATH", "./configuration")
// Reading ALL config files in defaults configuration folder and recursively merge them with STAGE configs
configBytes, err := config.ReadConfigs(configPath)
if err != nil {
log.Fatalf("config reading error: %+v", err)
}
var Config ConfigStruct
// unmarshal config into Config structure
err = yaml.Unmarshal(configBytes, &Config)
if err != nil {
log.Fatalf("config unmarshal error: %+v", err)
}
}
License
The MIT License
Copyright © 2019 teamc.io, Inc. https://teamc.io
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.