configbp

Documentation

Overview

Package configbp parses configurations per the baseplate spec.

Index

• Variables
• func ParseStrictFile(path string, ptr interface{}) error
• func ParseStrictYAML(reader io.Reader, ptr interface{}) error
• type Int64String
  • func (i *Int64String) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var BaseplateConfigPath = os.Getenv("BASEPLATE_CONFIG_PATH")

BaseplateConfigPath points to the default config file per baseplate.spec.

Functions

func ParseStrictFile

func ParseStrictFile(path string, ptr interface{}) error

ParseStrictFile parses configuration from the file at the given path.

Environment variables (e.g. $FOO and ${FOO}) are substituted from the environment before parsing. The configuration is parsed into each of the targets, which will typically be pointers to structs.

func ParseStrictYAML

func ParseStrictYAML(reader io.Reader, ptr interface{}) error

ParseStrictYAML parses YAML read from the given Reader.

Environment variables (e.g. $FOO and ${FOO}) are substituted from the environment before parsing. The configuration is parsed into each of the targets, which will typically be pointers to structs.

Types

type Int64String

type Int64String int64

Int64String is an int64 type that can be yaml deserialized from strings.

It's useful when the yaml config goes through helm, which could cause precision loss on large int64 numbers: https://github.com/helm/helm/issues/11045

func (*Int64String) UnmarshalYAML

func (i *Int64String) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler.