environment

Documentation

Index

• func GetConfigDir(logger log.Logger, configDir string) string
• func GetConfigFileName(logger log.Logger, configFileName string) string
• type StartupInfo
  • func GetStartupInfo(serviceKey string) StartupInfo
• type Variables
  • func NewVariables(logger log.Logger) *Variables
  • func (e *Variables) OverrideConfigMapValues(configMap map[string]any) (int, error)
  • func (e *Variables) OverrideConfiguration(serviceConfig any) (int, error)

Functions

func GetConfigDir

func GetConfigDir(logger log.Logger, configDir string) string

GetConfigDir get the config directory value from a Variables variable value (if it exists) or uses passed in value or default if previous result in blank.

func GetConfigFileName

func GetConfigFileName(logger log.Logger, configFileName string) string

GetConfigFileName gets the configuration filename value from a Variables variable value (if it exists) or uses passed in value.

Types

type StartupInfo

type StartupInfo struct {
	Duration int
	Interval int
}

StartupInfo provides the startup timer values which are applied to the StartupTimer created at boot.

func GetStartupInfo

func GetStartupInfo(serviceKey string) StartupInfo

GetStartupInfo gets the Service StartupInfo values from an Variables variable value (if it exists) or uses the default values.

type Variables

type Variables struct {
	// contains filtered or unexported fields
}

Variables is a receiver that holds Variables and encapsulates toml.Tree-based configuration field overrides. Assumes "_" embedded in Variables variable key separates sub-structs; e.g. foo_bar_baz might refer to

		type foo struct {
			bar struct {
         		baz string
 			}
		}

func NewVariables

func NewVariables(logger log.Logger) *Variables

NewVariables constructor reads/stores os.Environ() for use by Variables receiver methods.

func (*Variables) OverrideConfigMapValues

func (e *Variables) OverrideConfigMapValues(configMap map[string]any) (int, error)

func (*Variables) OverrideConfiguration

func (e *Variables) OverrideConfiguration(serviceConfig any) (int, error)

OverrideConfiguration method replaces values in the configuration for matching Variables variable keys. serviceConfig must be pointer to the service configuration.