config

Documentation

Index

• Constants
• Variables
• func DefaultConfigPath(workingDir string) string
• func FindConfigFilesInPath(rootPath string) ([]string, error)
• func IsTerragruntConfigFile(path string) (bool, error)
• func ResolveTerragruntConfigString(terragruntConfigString string, include *IncludeConfig, ...) (resolved string, finalErr error)
• type CheckedTooManyParentFolders
  • func (err CheckedTooManyParentFolders) Error() string
• type CouldNotResolveTerragruntConfigInFile
  • func (err CouldNotResolveTerragruntConfigInFile) Error() string
• type EnvVar
• type IncludeConfig
• type IncludedConfigMissingPath
  • func (err IncludedConfigMissingPath) Error() string
• type InvalidFunctionParameters
  • func (err InvalidFunctionParameters) Error() string
• type InvalidInterpolationSyntax
  • func (err InvalidInterpolationSyntax) Error() string
• type LockConfig
• type ModuleDependencies
  • func (deps *ModuleDependencies) String() string
• type ParentTerragruntConfigNotFound
  • func (err ParentTerragruntConfigNotFound) Error() string
• type TerraformConfig
  • func (conf *TerraformConfig) String() string
• type TerraformExtraArguments
  • func (conf *TerraformExtraArguments) String() string
• type TerragruntConfig
  • func ParseConfigFile(configPath string, terragruntOptions *options.TerragruntOptions, ...) (*TerragruntConfig, error)
  • func ReadTerragruntConfig(terragruntOptions *options.TerragruntOptions) (*TerragruntConfig, error)
  • func (conf *TerragruntConfig) String() string
• type TooManyLevelsOfInheritance
  • func (err TooManyLevelsOfInheritance) Error() string
• type UnknownHelperFunction
  • func (err UnknownHelperFunction) Error() string

Constants

const DefaultTerragruntConfigPath = "terraform.tfvars"

const OldTerragruntConfigPath = ".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_GET_ENV_PARAMETERS_SYNTAX_REGEX = regexp.MustCompile(`\s*"(?P<env>[^=]+?)"\s*\,\s*"(?P<default>.*?)"\s*`)

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

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

var MAX_PARENT_FOLDERS_TO_CHECK = 100

Functions

func DefaultConfigPath

func DefaultConfigPath(workingDir string) string

Return the default path to use for the Terragrunt configuration file. The reason this is a method rather than a constant is that older versions of Terragrunt stored configuration in a different file. This method returns the path to the old configuration format if such a file exists and the new format otherwise.

func FindConfigFilesInPath

func FindConfigFilesInPath(rootPath string) ([]string, error)

Returns a list of all Terragrunt config files in the given path or any subfolder of the path. A file is a Terragrunt config file if it has a name as returned by the DefaultConfigPath method and contains Terragrunt config contents as returned by the IsTerragruntConfigFile method.

func IsTerragruntConfigFile

func IsTerragruntConfigFile(path string) (bool, error)

Returns true if the given path corresponds to file that could be a Terragrunt config file. A file could be a Terragrunt config file if:

1. The file exists 2. It is a .terragrunt file, which is the old Terragrunt-specific file format 3. The file contains HCL contents with a terragrunt = { ... } block

func ResolveTerragruntConfigString

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

Given a string value from a Terragrunt configuration, 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 CouldNotResolveTerragruntConfigInFile

type CouldNotResolveTerragruntConfigInFile string

func (CouldNotResolveTerragruntConfigInFile) Error

func (err CouldNotResolveTerragruntConfigInFile) Error() string

type EnvVar

type EnvVar struct {
	Name         string
	DefaultValue string
}

type IncludeConfig

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

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

type IncludedConfigMissingPath

type IncludedConfigMissingPath string

func (IncludedConfigMissingPath) Error

func (err IncludedConfigMissingPath) Error() string

type InvalidFunctionParameters

type InvalidFunctionParameters string

func (InvalidFunctionParameters) Error

func (err InvalidFunctionParameters) 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 ModuleDependencies

type ModuleDependencies struct {
	Paths []string `hcl:"paths"`
}

ModuleDependencies represents the paths to other Terraform modules that must be applied before the current module can be applied

func (*ModuleDependencies) String

func (deps *ModuleDependencies) String() string

type ParentTerragruntConfigNotFound

type ParentTerragruntConfigNotFound string

func (ParentTerragruntConfigNotFound) Error

func (err ParentTerragruntConfigNotFound) Error() string

type TerraformConfig

type TerraformConfig struct {
	ExtraArgs []TerraformExtraArguments `hcl:"extra_arguments"`
	Source    string                    `hcl:"source"`
}

TerraformConfig specifies where to find the Terraform configuration files

func (*TerraformConfig) String

func (conf *TerraformConfig) String() string

type TerraformExtraArguments

type TerraformExtraArguments struct {
	Name      string   `hcl:",key"`
	Arguments []string `hcl:"arguments,omitempty"`
	Commands  []string `hcl:"commands,omitempty"`
}

TerraformExtraArguments sets a list of arguments to pass to Terraform if command fits any in the `Commands` list

func (*TerraformExtraArguments) String

func (conf *TerraformExtraArguments) String() string

type TerragruntConfig

type TerragruntConfig struct {
	Terraform    *TerraformConfig
	Lock         locks.Lock
	RemoteState  *remote.RemoteState
	Dependencies *ModuleDependencies
}

TerragruntConfig represents a parsed and expanded configuration

func ParseConfigFile

func ParseConfigFile(configPath string, terragruntOptions *options.TerragruntOptions, include *IncludeConfig) (*TerragruntConfig, error)

Parse the Terragrunt config file at the given path. If the include parameter is not nil, then treat this as a config included in some other config file when resolving relative paths.

func ReadTerragruntConfig

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

Read the Terragrunt config file from its default location

func (*TerragruntConfig) String

func (conf *TerragruntConfig) String() string

type TooManyLevelsOfInheritance

type TooManyLevelsOfInheritance struct {
	ConfigPath             string
	FirstLevelIncludePath  string
	SecondLevelIncludePath string
}

func (TooManyLevelsOfInheritance) Error

func (err TooManyLevelsOfInheritance) Error() string

type UnknownHelperFunction

type UnknownHelperFunction string

func (UnknownHelperFunction) Error

func (err UnknownHelperFunction) Error() string