Documentation ¶
Index ¶
- Constants
- Variables
- func DefaultWorkingAndDownloadDirs(terragruntConfigPath string) (string, string, error)
- func GetDefaultIAMAssumeRoleSessionName() string
- type IAMRoleOptions
- type TerraformImplementationType
- type TerragruntOptions
- func (opts *TerragruntOptions) AppendTerraformCliArgs(argsToAppend ...string)
- func (opts *TerragruntOptions) Clone(terragruntConfigPath string) *TerragruntOptions
- func (opts *TerragruntOptions) DataDir() string
- func (opts *TerragruntOptions) InsertTerraformCliArgs(argsToInsert ...string)
- func (opts *TerragruntOptions) OptionsFromContext(ctx context.Context) *TerragruntOptions
- func (opts *TerragruntOptions) TerraformDataDir() string
- type TerragruntOptionsFunc
Constants ¶
const ( DefaultMaxFoldersToCheck = 100 // no limits on parallelism by default (limited by GOPROCS) DefaultParallelism = math.MaxInt32 // TofuDefaultPath command to run tofu TofuDefaultPath = "tofu" // TerraformDefaultPath just takes terraform from the path TerraformDefaultPath = "terraform" // Default to naming it `terragrunt_rendered.json` in the terragrunt config directory. DefaultJSONOutName = "terragrunt_rendered.json" DefaultTFDataDir = ".terraform" DefaultIAMAssumeRoleDuration = 3600 )
const ContextKey ctxKey = iota
const DEFAULT_RETRY_MAX_ATTEMPTS = 3
const DEFAULT_RETRY_SLEEP_INTERVAL_SEC = 5 * time.Second
Variables ¶
var DEFAULT_RETRYABLE_ERRORS = []string{
"(?s).*Failed to load state.*tcp.*timeout.*",
"(?s).*Failed to load backend.*TLS handshake timeout.*",
"(?s).*Creating metric alarm failed.*request to update this alarm is in progress.*",
"(?s).*Error installing provider.*TLS handshake timeout.*",
"(?s).*Error configuring the backend.*TLS handshake timeout.*",
"(?s).*Error installing provider.*tcp.*timeout.*",
"(?s).*Error installing provider.*tcp.*connection reset by peer.*",
"NoSuchBucket: The specified bucket does not exist",
"(?s).*Error creating SSM parameter: TooManyUpdates:.*",
"(?s).*app.terraform.io.*: 429 Too Many Requests.*",
"(?s).*ssh_exchange_identification.*Connection closed by remote host.*",
"(?s).*Client\\.Timeout exceeded while awaiting headers.*",
"(?s).*Could not download module.*The requested URL returned error: 429.*",
"(?s).*net/http: TLS.*handshake timeout.*",
}
List of recurring transient errors encountered when calling terraform If any of these match, we'll retry the command
var (
DefaultWrappedPath = identifyDefaultWrappedExecutable()
)
var RunTerragruntCommandNotSet = fmt.Errorf("The RunTerragrunt option has not been set on this TerragruntOptions object")
var TERRAFORM_COMMANDS_WITH_SUBCOMMAND = []string{
"debug",
"force-unlock",
"state",
}
Functions ¶
func DefaultWorkingAndDownloadDirs ¶ added in v0.16.2
Get the default working and download directories for the given Terragrunt config path
func GetDefaultIAMAssumeRoleSessionName ¶ added in v0.35.1
func GetDefaultIAMAssumeRoleSessionName() string
Get the default IAM assume role session name.
Types ¶
type IAMRoleOptions ¶ added in v0.35.1
type IAMRoleOptions struct { // The ARN of an IAM Role to assume. Used when accessing AWS, both internally and through terraform. RoleARN string // The Web identity token. Used when RoleArn is also set to use AssumeRoleWithWebIdentity instead of AssumeRole. WebIdentityToken string // Duration of the STS Session when assuming the role. AssumeRoleDuration int64 // STS Session name when assuming the role. AssumeRoleSessionName string }
IAMRoleOptions represents options that are used by Terragrunt to assume an IAM role.
func MergeIAMRoleOptions ¶ added in v0.35.1
func MergeIAMRoleOptions(target IAMRoleOptions, source IAMRoleOptions) IAMRoleOptions
type TerraformImplementationType ¶ added in v0.52.0
type TerraformImplementationType string
const ( TerraformImpl TerraformImplementationType = "terraform" OpenTofuImpl TerraformImplementationType = "tofu" UnknownImpl TerraformImplementationType = "unknown" )
type TerragruntOptions ¶
type TerragruntOptions struct { // Location of the Terragrunt config file TerragruntConfigPath string // Location of the original Terragrunt config file. This is primarily useful when one Terragrunt config is being // read from another: e.g., if /terraform-code/terragrunt.hcl calls read_terragrunt_config("/foo/bar.hcl"), // and within bar.hcl, you call get_original_terragrunt_dir(), you'll get back /terraform-code. OriginalTerragruntConfigPath string // Version of terragrunt TerragruntVersion *version.Version // Location of the terraform binary TerraformPath string // Current Terraform command being executed by Terragrunt TerraformCommand string // Original Terraform command being executed by Terragrunt. Used to track command evolution as terragrunt chains // different commands together. For example, when retrieving dependencies, terragrunt will change the // TerraformCommand to `output` to run `terraform output`, which loses the context of the original command that was // run to fetch the dependency. This is a problem when mock_outputs is configured and we only allow mocks to be // returned on specific commands. // NOTE: For `xxx-all` commands, this will be set to the Terraform command, which would be `xxx`. For example, // if you run `apply-all` (which is a terragrunt command), this variable will be set to `apply`. OriginalTerraformCommand string // Terraform implementation tool (e.g. terraform, tofu) that terragrunt is wrapping TerraformImplementation TerraformImplementationType // Version of terraform (obtained by running 'terraform version') TerraformVersion *version.Version // Whether we should prompt the user for confirmation or always assume "yes" NonInteractive bool // Whether we should automatically run terraform init if necessary when executing other commands AutoInit bool // Whether we should automatically run terraform with -auto-apply in run-all mode. RunAllAutoApprove bool // CLI args that are intended for Terraform (i.e. all the CLI args except the --terragrunt ones) TerraformCliArgs []string // The working directory in which to run Terraform WorkingDir string // Basic log entry Logger *logrus.Entry // Disable Terragrunt colors DisableLogColors bool // Output Terragrunt logs in JSON format JsonLogFormat bool // Wrap Terraform logs in JSON format TerraformLogsToJson bool // Log level LogLevel logrus.Level // Raw log level value LogLevelStr string // ValidateStrict mode for the validate-inputs command ValidateStrict bool // Environment variables at runtime Env map[string]string // Download Terraform configurations from the specified source location into a temporary folder and run // Terraform in that temporary folder Source string // Map to replace terraform source locations. This will replace occurrences of the given source with the target // value. SourceMap map[string]string // If set to true, delete the contents of the temporary folder before downloading Terraform source code into it SourceUpdate bool // Download Terraform configurations specified in the Source parameter into this folder DownloadDir string // IAM Role options set from command line. This is used to differentiate between the options set from the config and // CLI. OriginalIAMRoleOptions IAMRoleOptions // IAM Role options that should be used when authenticating to AWS. IAMRoleOptions IAMRoleOptions // If set to true, continue running *-all commands even if a dependency has errors. This is mostly useful for 'output-all <some_variable>'. See https://github.com/gruntwork-io/terragrunt/issues/193 IgnoreDependencyErrors bool // If set to true, ignore the dependency order when running *-all command. IgnoreDependencyOrder bool // If set to true, skip any external dependencies when running *-all commands IgnoreExternalDependencies bool // If set to true, apply all external dependencies when running *-all commands IncludeExternalDependencies bool // If you want stdout to go somewhere other than os.stdout Writer io.Writer // If you want stderr to go somewhere other than os.stderr ErrWriter io.Writer // When searching the directory tree, this is the max folders to check before exiting with an error. This is // exposed here primarily so we can set it to a low value at test time. MaxFoldersToCheck int // Whether we should automatically retry errored Terraform commands AutoRetry bool // Maximum number of times to retry errors matching RetryableErrors RetryMaxAttempts int // The duration in seconds to wait before retrying RetrySleepIntervalSec time.Duration // RetryableErrors is an array of regular expressions with RE2 syntax (https://github.com/google/re2/wiki/Syntax) that qualify for retrying RetryableErrors []string // Unix-style glob of directories to exclude when running *-all commands ExcludeDirs []string // Unix-style glob of directories to include when running *-all commands IncludeDirs []string // If set to true, do not include dependencies when processing IncludeDirs (unless they are in the included dirs) StrictInclude bool // Parallelism limits the number of commands to run concurrently during *-all commands Parallelism int // Enable check mode, by default it's disabled. Check bool // Show diff, by default it's disabled. Diff bool // The file which hclfmt should be specifically run on HclFile string // The file path that terragrunt should use when rendering the terragrunt.hcl config as json. JSONOut string // When used with `run-all`, restrict the modules in the stack to only those that include at least one of the files // in this list. ModulesThatInclude []string // A command that can be used to run Terragrunt with the given options. This is useful for running Terragrunt // multiple times (e.g. when spinning up a stack of Terraform modules). The actual command is normally defined // in the cli package, which depends on almost all other packages, so we declare it here so that other // packages can use the command without a direct reference back to the cli package (which would create a // circular dependency). RunTerragrunt func(ctx context.Context, opts *TerragruntOptions) error // True if terragrunt should run in debug mode, writing terragrunt-debug.tfvars to working folder to help // root-cause issues. Debug bool // Attributes to override in AWS provider nested within modules as part of the aws-provider-patch command. See that // command for more info. AwsProviderPatchOverrides map[string]string // True if is required to show dependent modules and confirm action CheckDependentModules bool // This is an experimental feature, used to speed up dependency processing by getting the output from the state FetchDependencyOutputFromState bool // Enables caching of includes during partial parsing operations. UsePartialParseConfigCache bool // Include fields metadata in render-json RenderJsonWithMetadata bool // Prefix for shell commands' outputs OutputPrefix string // Controls if a module prefix will be prepended to TF outputs IncludeModulePrefix bool // Fail execution if is required to create S3 bucket FailIfBucketCreationRequired bool // Controls if s3 bucket should be updated or skipped DisableBucketUpdate bool // Disables validation terraform command DisableCommandValidation bool // Variables for usage in scaffolding. ScaffoldVars []string // Files with variables to be used in modules scaffolding. ScaffoldVarFiles []string // Root directory for graph command. GraphRoot string // Disable listing of dependent modules in render json output JsonDisableDependentModules bool // Enables Terragrunt's provider caching. ProviderCache bool // The path to store unpacked providers. The file structure is the same as terraform plugin cache dir. ProviderCacheDir string // The Token for authentication to the Terragrunt Provider Cache server. ProviderCacheToken string // The hostname of the Terragrunt Provider Cache server. ProviderCacheHostname string // The port of the Terragrunt Provider Cache server. ProviderCachePort int // The list of remote registries to cached by Terragrunt Provider Cache server. ProviderCacheRegistryNames []string // Folder to store output files. OutputFolder string // Folder to store JSON representation of output files. JsonOutputFolder string // The command and arguments that can be used to fetch authentication configurations. // Terragrunt invokes this command before running tofu/terraform operations for each working directory. AuthProviderCmd string }
TerragruntOptions represents options that configure the behavior of the Terragrunt program
func NewTerragruntOptions ¶ added in v0.6.0
func NewTerragruntOptions() *TerragruntOptions
Create a new TerragruntOptions object with reasonable defaults for real usage
func NewTerragruntOptionsForTest ¶ added in v0.6.0
func NewTerragruntOptionsForTest(terragruntConfigPath string, options ...TerragruntOptionsFunc) (*TerragruntOptions, error)
Create a new TerragruntOptions object with reasonable defaults for test usage
func NewTerragruntOptionsWithConfigPath ¶ added in v0.48.7
func NewTerragruntOptionsWithConfigPath(terragruntConfigPath string) (*TerragruntOptions, error)
func (*TerragruntOptions) AppendTerraformCliArgs ¶ added in v0.13.0
func (opts *TerragruntOptions) AppendTerraformCliArgs(argsToAppend ...string)
Appends the given argsToAppend after the current TerraformCliArgs
func (*TerragruntOptions) Clone ¶ added in v0.6.0
func (opts *TerragruntOptions) Clone(terragruntConfigPath string) *TerragruntOptions
Create a copy of this TerragruntOptions, but with different values for the given variables. This is useful for creating a TerragruntOptions that behaves the same way, but is used for a Terraform module in a different folder.
func (*TerragruntOptions) DataDir ¶ added in v0.20.1
func (opts *TerragruntOptions) DataDir() string
DataDir returns the Terraform data directory prepended with the working directory path, or just the Terraform data directory if it is an absolute path.
func (*TerragruntOptions) InsertTerraformCliArgs ¶ added in v0.13.0
func (opts *TerragruntOptions) InsertTerraformCliArgs(argsToInsert ...string)
Inserts the given argsToInsert after the terraform command argument, but before the remaining args
func (*TerragruntOptions) OptionsFromContext ¶ added in v0.48.7
func (opts *TerragruntOptions) OptionsFromContext(ctx context.Context) *TerragruntOptions
OptionsFromContext tries to retrieve options from context, otherwise, returns its own instance.
func (*TerragruntOptions) TerraformDataDir ¶ added in v0.23.24
func (opts *TerragruntOptions) TerraformDataDir() string
TerraformDataDir returns Terraform data directory (.terraform by default, overridden by $TF_DATA_DIR envvar)
type TerragruntOptionsFunc ¶ added in v0.59.3
type TerragruntOptionsFunc func(*TerragruntOptions)
TerragruntOptionsFunc is a functional option type used to pass options in certain integration tests
func WithIAMRoleARN ¶ added in v0.59.3
func WithIAMRoleARN(arn string) TerragruntOptionsFunc
WithRoleARN adds the provided role ARN to IamRoleOptions
func WithIAMWebIdentityToken ¶ added in v0.59.3
func WithIAMWebIdentityToken(token string) TerragruntOptionsFunc
WithIAMWebIdentityToken adds the provided WebIdentity token to IamRoleOptions