config

Documentation

Overview

Package config contains the code to load and resolve the Hiera configuration

Index

• Constants
• Variables
• func New(configPath string) api.Config
• func NewGlob(pattern string) api.Location
• func NewMappedPaths(sourceVar, key, template string) api.Location
• func NewPath(original string) api.Location
• func NewURI(original string) api.Location

Constants

const FileName = `hiera.yaml`

FileName is the default file name for the Hiera configuration file.

Variables

var FunctionKeys = []string{string(api.KindDataDig), string(api.KindDataHash), string(api.KindLookupKey)}

FunctionKeys are the valid keys to use when defining a function in a hierarchy entry

var LocationKeys = []string{
	string(api.LcPath), `paths`,
	string(api.LcGlob), `globs`,
	string(api.LcURI), `uris`,
	string(api.LcMappedPaths)}

LocationKeys are the valid keys to use when defining locations in a hierarchy entry

var ReservedOptionKeys = []string{string(api.LcPath), string(api.LcURI)}

ReservedOptionKeys are the option keys that are reserved by Hiera

Functions

func New

func New(configPath string) api.Config

New creates a new unresolved Config from the given path. If the path does not exist, the default config is returned.

func NewGlob

func NewGlob(pattern string) api.Location

NewGlob returns a glob Location

func NewMappedPaths

func NewMappedPaths(sourceVar, key, template string) api.Location

NewMappedPaths returns a Location that initially consist of three strings:

sourceVar: Name of variable that contains an array of strings

key: Variable name to use when resolving template

template: Template containing interpolation of the key

func NewPath

func NewPath(original string) api.Location

NewPath returns a path Location

func NewURI

func NewURI(original string) api.Location

NewURI returns a URI Location