config

Documentation

Index

• func LoadConfigFile(dataStruct interface{}, meta *Metadata, configFilePath string) error
• func SaveConfigFile(data interface{}, configFilePath string) error
• type GenericConfigFile
• type Metadata

Functions

func LoadConfigFile

func LoadConfigFile(dataStruct interface{}, meta *Metadata, configFilePath string) error

LoadConfigFile reads, parses and validates specified configuration file.

func SaveConfigFile

func SaveConfigFile(data interface{}, configFilePath string) error

SaveConfigFile validates, serializes and saves configuration to a file.

Types

type GenericConfigFile

type GenericConfigFile struct {
	// Meta stores metadata of the config file (such as a path).
	Meta Metadata `yaml:"-"`
	// APIVersion can be used to handle more than one config file format
	APIVersion string `yaml:"apiVersion"`
	// Kind of the config file
	Kind string `yaml:"kind"`
}

type Metadata

type Metadata struct {
	Path   string
	Exists bool
}

Metadata contains context and additional info for configuration files.