Documentation
¶
Index ¶
- Constants
- Variables
- func ResolveTerragruntConfigString(terragruntConfigString string, include *IncludeConfig, ...) (resolved string, finalErr error)
- type CheckedTooManyParentFolders
- type EnvVar
- type IncludeConfig
- type IncludedConfigMissingPath
- type InvalidFunctionParameters
- type InvalidInterpolationSyntax
- type LockConfig
- type ModuleDependencies
- type ParentTerragruntConfigNotFound
- type TerraformConfig
- type TerragruntConfig
- type TooManyLevelsOfInheritance
- type UnknownHelperFunction
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_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 ResolveTerragruntConfigString ¶ added in v0.4.0
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 ¶ added in v0.4.0
type CheckedTooManyParentFolders string
func (CheckedTooManyParentFolders) Error ¶ added in v0.4.0
func (err CheckedTooManyParentFolders) Error() string
type IncludeConfig ¶ added in v0.4.0
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 ¶ added in v0.4.0
type IncludedConfigMissingPath string
func (IncludedConfigMissingPath) Error ¶ added in v0.4.0
func (err IncludedConfigMissingPath) Error() string
type InvalidFunctionParameters ¶ added in v0.9.1
type InvalidFunctionParameters string
func (InvalidFunctionParameters) Error ¶ added in v0.9.1
func (err InvalidFunctionParameters) Error() string
type InvalidInterpolationSyntax ¶ added in v0.4.0
type InvalidInterpolationSyntax string
func (InvalidInterpolationSyntax) Error ¶ added in v0.4.0
func (err InvalidInterpolationSyntax) Error() string
type LockConfig ¶ added in v0.1.0
LockConfig represents generic configuration for Lock providers
type ModuleDependencies ¶ added in v0.6.0
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 ¶ added in v0.9.4
func (deps *ModuleDependencies) String() string
type ParentTerragruntConfigNotFound ¶ added in v0.4.0
type ParentTerragruntConfigNotFound string
func (ParentTerragruntConfigNotFound) Error ¶ added in v0.4.0
func (err ParentTerragruntConfigNotFound) Error() string
type TerraformConfig ¶ added in v0.9.4
type TerraformConfig struct {
Source string `hcl:"source"`
}
TerraformConfig specifies where to find the Terraform configuration files
func (*TerraformConfig) String ¶ added in v0.9.4
func (conf *TerraformConfig) 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 ¶ added in v0.6.0
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 ¶ added in v0.9.4
func (conf *TerragruntConfig) String() string
type TooManyLevelsOfInheritance ¶ added in v0.4.0
type TooManyLevelsOfInheritance string
func (TooManyLevelsOfInheritance) Error ¶ added in v0.4.0
func (err TooManyLevelsOfInheritance) Error() string
type UnknownHelperFunction ¶ added in v0.4.0
type UnknownHelperFunction string
func (UnknownHelperFunction) Error ¶ added in v0.4.0
func (err UnknownHelperFunction) Error() string
Source Files