config

Documentation

Index

• Constants
• Variables
• func ResolveTerragruntConfigString(terragruntConfigString string, include *IncludeConfig, ...) (resolved string, finalErr error)
• type CheckedTooManyParentFolders
  • func (err CheckedTooManyParentFolders) Error() string
• type IncludeConfig
• type IncludedConfigMissingPath
  • func (err IncludedConfigMissingPath) Error() string
• type InvalidInterpolationSyntax
  • func (err InvalidInterpolationSyntax) Error() string
• type LockConfig
• type ParentTerragruntConfigNotFound
  • func (err ParentTerragruntConfigNotFound) Error() string
• type TerragruntConfig
  • func ReadTerragruntConfig(terragruntOptions *options.TerragruntOptions) (*TerragruntConfig, error)
• type TooManyLevelsOfInheritance
  • func (err TooManyLevelsOfInheritance) Error() string
• type UnknownHelperFunction
  • func (err UnknownHelperFunction) Error() string

Constants

const DefaultTerragruntConfigPath = ".terragrunt"

Variables

var ErrLockNotFound = fmt.Errorf("no Lock implementation found")

ErrLockNotFound is the error returned if no Lock implementation could be found for the specified name

var HELPER_FUNCTION_SYNTAX_REGEX = regexp.MustCompile("\\$\\{(.*?)\\(\\)\\}")

var INTERPOLATION_SYNTAX_REGEX = regexp.MustCompile("\\$\\{.*?\\}")

var MAX_PARENT_FOLDERS_TO_CHECK = 100

Functions

func ResolveTerragruntConfigString

func ResolveTerragruntConfigString(terragruntConfigString string, include *IncludeConfig, terragruntOptions *options.TerragruntOptions) (resolved string, finalErr error)

Given a string value from a .terragrunt config file, parse the string, resolve any calls to helper functions using the syntax ${...}, and return the final value.

Types

type CheckedTooManyParentFolders

type CheckedTooManyParentFolders string

func (CheckedTooManyParentFolders) Error

func (err CheckedTooManyParentFolders) Error() string

type IncludeConfig

type IncludeConfig struct {
	Path string `hcl:"path"`
}

IncludeConfig represents the configuration settings for a parent .terragrunt file that you can "include" in a child .terragrunt file

type IncludedConfigMissingPath

type IncludedConfigMissingPath string

func (IncludedConfigMissingPath) Error

func (err IncludedConfigMissingPath) Error() string

type InvalidInterpolationSyntax

type InvalidInterpolationSyntax string

func (InvalidInterpolationSyntax) Error

func (err InvalidInterpolationSyntax) Error() string

type LockConfig

type LockConfig struct {
	Backend string            `hcl:"backend"`
	Config  map[string]string `hcl:"config"`
}

LockConfig represents generic configuration for Lock providers

type ParentTerragruntConfigNotFound

type ParentTerragruntConfigNotFound string

func (ParentTerragruntConfigNotFound) Error

func (err ParentTerragruntConfigNotFound) Error() string

type TerragruntConfig

type TerragruntConfig struct {
	Lock        locks.Lock
	RemoteState *remote.RemoteState
}

TerragruntConfig represents a parsed and expanded configuration

func ReadTerragruntConfig

func ReadTerragruntConfig(terragruntOptions *options.TerragruntOptions) (*TerragruntConfig, error)

ReadTerragruntConfig the Terragrunt config file from its default location

type TooManyLevelsOfInheritance

type TooManyLevelsOfInheritance string

func (TooManyLevelsOfInheritance) Error

func (err TooManyLevelsOfInheritance) Error() string

type UnknownHelperFunction

type UnknownHelperFunction string

func (UnknownHelperFunction) Error

func (err UnknownHelperFunction) Error() string