config

Documentation

Index

• Constants
• Variables
• func GenerateNodeID(ctx context.Context, nodeNameProviderType string) (string, error)
• func KeyAsEnvVar(key string) string
• func MigrateV1(in v1types.BacalhauConfig) (types.Bacalhau, error)
• type Config
  • func New(opts ...Option) (*Config, error)
  • func (c *Config) ConfigFileUsed() string
  • func (c *Config) Get(key string) any
  • func (c *Config) Load(path string) error
  • func (c *Config) Merge(path string) error
  • func (c *Config) Paths() []string
  • func (c *Config) Unmarshal(out interface{}) error
• type Option
  • func WithDefault(cfg interface{}) Option
  • func WithEnvironmentVariables(ev map[string][]string) Option
  • func WithFlags(flags map[string][]*pflag.Flag) Option
  • func WithPaths(path ...string) Option
  • func WithValues(values map[string]any) Option

Constants

const (
	DefaultFileName = "config.yaml"
)

Variables

var (
	DecoderHook = viper.DecodeHook(mapstructure.TextUnmarshallerHookFunc())
)

Functions

func GenerateNodeID

func GenerateNodeID(ctx context.Context, nodeNameProviderType string) (string, error)

func KeyAsEnvVar

func KeyAsEnvVar(key string) string

KeyAsEnvVar returns the environment variable corresponding to a config key

func MigrateV1

func MigrateV1(in v1types.BacalhauConfig) (types.Bacalhau, error)

Types

type Config

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

func New

func New(opts ...Option) (*Config, error)

New returns a configuration with the provided options applied. If no options are provided, the returned config contains only the default values.

func (*Config) ConfigFileUsed

func (c *Config) ConfigFileUsed() string

func (*Config) Get

func (c *Config) Get(key string) any

func (*Config) Load

func (c *Config) Load(path string) error

Load reads in the configuration file specified by `path` overriding any previously set configuration with the values from the read config file. Load returns an error if the file cannot be read.

func (*Config) Merge

func (c *Config) Merge(path string) error

Merge merges a new configuration file specified by `path` with the existing config. Merge returns an error if the file cannot be read

func (*Config) Paths

func (c *Config) Paths() []string

Paths returns the paths to the configuration files merged from lower index to higher index

func (*Config) Unmarshal

func (c *Config) Unmarshal(out interface{}) error

Unmarshal returns the current configuration. Unmarshal returns an error if the configuration cannot be unmarshalled.

type Option

type Option = func(s *Config)

func WithDefault

func WithDefault(cfg interface{}) Option

WithDefault sets the default config to be used when no values are provided.

func WithEnvironmentVariables

func WithEnvironmentVariables(ev map[string][]string) Option

func WithFlags

func WithFlags(flags map[string][]*pflag.Flag) Option

func WithPaths

func WithPaths(path ...string) Option

WithPaths sets paths to configuration files to be loaded paths to configuration files merged from [0] to [N] e.g. file at index 1 overrides index 0, index 2 overrides index 1 and 0, etc.

func WithValues

func WithValues(values map[string]any) Option

WithValues sets values to be injected into the config, taking precedence over all other options.