Documentation ¶
Index ¶
- Constants
- Variables
- func CheckTerraformVersion(constraint string, terragruntOptions *options.TerragruntOptions) error
- func CreateTerragruntCli(version string, writer io.Writer, errwriter io.Writer) *cli.App
- func ParseTerragruntOptions(cliContext *cli.Context) (*options.TerragruntOptions, error)
- func PopulateTerraformVersion(terragruntOptions *options.TerragruntOptions) error
- type ArgMissingValue
- type ArgumentNotAllowed
- type BackendNotDefined
- type FileCopyGetter
- type InitNeededButDisabled
- type InvalidTerraformVersion
- type InvalidTerraformVersionSyntax
- type MaxRetriesExceeded
- type ModuleIsProtected
- type NoTerraformFilesFound
- type TerraformSource
- type TerragruntInfoGroup
- type UnrecognizedCommand
Constants ¶
const CMD_APPLY_ALL = "apply-all"
const CMD_DESTROY_ALL = "destroy-all"
const CMD_HCLFMT = "hclfmt"
const CMD_INIT = "init"
const CMD_INIT_FROM_MODULE = "init-from-module"
const CMD_OUTPUT_ALL = "output-all"
const CMD_PLAN_ALL = "plan-all"
const CMD_SPIN_UP = "spin-up"
CMD_SPIN_UP is deprecated.
const CMD_TEAR_DOWN = "tear-down"
CMD_TEAR_DOWN is deprecated.
const CMD_TERRAGRUNT_INFO = "terragrunt-info"
const CMD_VALIDATE_ALL = "validate-all"
const DEFAULT_TERRAFORM_VERSION_CONSTRAINT = ">= v0.12.0"
This uses the constraint syntax from https://github.com/hashicorp/go-version This version of Terragrunt only works with Terraform 0.12.0 and above
const MODULE_MANIFEST_NAME = ".terragrunt-module-manifest"
manifest for files coped from terragrunt module folder (i.e., the folder that contains the current terragrunt.hcl)
const OPT_DOWNLOAD_DIR = "terragrunt-download-dir"
const OPT_NON_INTERACTIVE = "terragrunt-non-interactive"
const OPT_TERRAGRUNT_CHECK = "terragrunt-check"
const OPT_TERRAGRUNT_CONFIG = "terragrunt-config"
const OPT_TERRAGRUNT_EXCLUDE_DIR = "terragrunt-exclude-dir"
const OPT_TERRAGRUNT_IAM_ROLE = "terragrunt-iam-role"
const OPT_TERRAGRUNT_IGNORE_DEPENDENCY_ERRORS = "terragrunt-ignore-dependency-errors"
const OPT_TERRAGRUNT_IGNORE_EXTERNAL_DEPENDENCIES = "terragrunt-ignore-external-dependencies"
const OPT_TERRAGRUNT_INCLUDE_DIR = "terragrunt-include-dir"
const OPT_TERRAGRUNT_NO_AUTO_INIT = "terragrunt-no-auto-init"
const OPT_TERRAGRUNT_NO_AUTO_RETRY = "terragrunt-no-auto-retry"
const OPT_TERRAGRUNT_SOURCE = "terragrunt-source"
const OPT_TERRAGRUNT_SOURCE_UPDATE = "terragrunt-source-update"
const OPT_TERRAGRUNT_TFPATH = "terragrunt-tfpath"
const OPT_WORKING_DIR = "terragrunt-working-dir"
const SOURCE_MANIFEST_NAME = ".terragrunt-source-manifest"
manifest for files copied from the URL specified in the terraform { source = "<URL>" } config
const TERRAFORM_EXTENSION_GLOB = "*.tf"
Variables ¶
var ALL_TERRAGRUNT_BOOLEAN_OPTS = []string{OPT_NON_INTERACTIVE, OPT_TERRAGRUNT_SOURCE_UPDATE, OPT_TERRAGRUNT_IGNORE_DEPENDENCY_ERRORS, OPT_TERRAGRUNT_IGNORE_EXTERNAL_DEPENDENCIES, OPT_TERRAGRUNT_NO_AUTO_INIT, OPT_TERRAGRUNT_NO_AUTO_RETRY, OPT_TERRAGRUNT_CHECK}
var ALL_TERRAGRUNT_STRING_OPTS = []string{OPT_TERRAGRUNT_CONFIG, OPT_TERRAGRUNT_TFPATH, OPT_WORKING_DIR, OPT_DOWNLOAD_DIR, OPT_TERRAGRUNT_SOURCE, OPT_TERRAGRUNT_IAM_ROLE, OPT_TERRAGRUNT_EXCLUDE_DIR, OPT_TERRAGRUNT_INCLUDE_DIR}
var CUSTOM_USAGE_TEXT = `` /* 2798-byte string literal not displayed */
Since Terragrunt is just a thin wrapper for Terraform, and we don't want to repeat every single Terraform command in its definition, we don't quite fit into the model of any Go CLI library. Fortunately, urfave/cli allows us to override the whole template used for the Usage Text.
TODO: this description text has copy/pasted versions of many Terragrunt constants, such as command names and file names. It would be easy to make this code DRY using fmt.Sprintf(), but then it's hard to make the text align nicely. Write some code to take generate this help text automatically, possibly leveraging code that's part of urfave/cli.
var DEPRECATED_COMMANDS = map[string]string{ CMD_SPIN_UP: CMD_APPLY_ALL, CMD_TEAR_DOWN: CMD_DESTROY_ALL, }
DEPRECATED_COMMANDS is a map of deprecated commands to the commands that replace them.
var MODULE_REGEX = regexp.MustCompile(`module[[:blank:]]+".+"`)
var MULTI_MODULE_COMMANDS = []string{CMD_APPLY_ALL, CMD_DESTROY_ALL, CMD_OUTPUT_ALL, CMD_PLAN_ALL, CMD_VALIDATE_ALL}
var TERRAFORM_COMMANDS_THAT_DO_NOT_NEED_INIT = []string{
"version",
"terragrunt-info",
}
var TERRAFORM_COMMANDS_THAT_USE_STATE = []string{
"init",
"apply",
"destroy",
"env",
"import",
"graph",
"output",
"plan",
"push",
"refresh",
"show",
"taint",
"untaint",
"validate",
"force-unlock",
"state",
}
var TERRAFORM_HELP_FLAGS = []string{
"--help",
"-help",
"-h",
}
The supported flags to show help of terraform commands
var TERRAFORM_VERSION_REGEX = regexp.MustCompile("Terraform (v?[\\d\\.]+)(?:-dev)?(?: .+)?")
The terraform --version output is of the format: Terraform v0.9.5-dev (cad024a5fe131a546936674ef85445215bbc4226+CHANGES) where -dev and (commitid+CHANGES) is for custom builds or if TF_LOG is set for debug purposes
Functions ¶
func CheckTerraformVersion ¶ added in v0.12.5
func CheckTerraformVersion(constraint string, terragruntOptions *options.TerragruntOptions) error
Check that the currently installed Terraform version works meets the specified version constraint and return an error if it doesn't
func CreateTerragruntCli ¶
Create the Terragrunt CLI App
func ParseTerragruntOptions ¶ added in v0.6.0
func ParseTerragruntOptions(cliContext *cli.Context) (*options.TerragruntOptions, error)
Parse command line options that are passed in for Terragrunt
func PopulateTerraformVersion ¶ added in v0.13.0
func PopulateTerraformVersion(terragruntOptions *options.TerragruntOptions) error
Populate the currently installed version of Terraform into the given terragruntOptions
Types ¶
type ArgMissingValue ¶ added in v0.6.0
type ArgMissingValue string
func (ArgMissingValue) Error ¶ added in v0.6.0
func (err ArgMissingValue) Error() string
type ArgumentNotAllowed ¶ added in v0.13.0
func (ArgumentNotAllowed) Error ¶ added in v0.13.0
func (err ArgumentNotAllowed) Error() string
type BackendNotDefined ¶ added in v0.13.5
type BackendNotDefined struct { Opts *options.TerragruntOptions BackendType string }
func (BackendNotDefined) Error ¶ added in v0.13.5
func (err BackendNotDefined) Error() string
type FileCopyGetter ¶ added in v0.19.1
type FileCopyGetter struct {
getter.FileGetter
}
A custom getter.Getter implementation that uses file copying instead of symlinks. Symlinks are faster and use less disk space, but they cause issues in Windows and with infinite loops, so we copy files/folders instead.
type InitNeededButDisabled ¶ added in v0.13.0
type InitNeededButDisabled string
func (InitNeededButDisabled) Error ¶ added in v0.13.0
func (err InitNeededButDisabled) Error() string
type InvalidTerraformVersion ¶ added in v0.12.5
type InvalidTerraformVersion struct { CurrentVersion *version.Version VersionConstraints version.Constraints }
func (InvalidTerraformVersion) Error ¶ added in v0.12.5
func (err InvalidTerraformVersion) Error() string
type InvalidTerraformVersionSyntax ¶ added in v0.12.5
type InvalidTerraformVersionSyntax string
func (InvalidTerraformVersionSyntax) Error ¶ added in v0.12.5
func (err InvalidTerraformVersionSyntax) Error() string
type MaxRetriesExceeded ¶ added in v0.17.0
type MaxRetriesExceeded struct {
Opts *options.TerragruntOptions
}
func (MaxRetriesExceeded) Error ¶ added in v0.17.0
func (err MaxRetriesExceeded) Error() string
type ModuleIsProtected ¶ added in v0.16.4
type ModuleIsProtected struct {
Opts *options.TerragruntOptions
}
func (ModuleIsProtected) Error ¶ added in v0.16.4
func (err ModuleIsProtected) Error() string
type NoTerraformFilesFound ¶ added in v0.16.0
type NoTerraformFilesFound string
func (NoTerraformFilesFound) Error ¶ added in v0.16.0
func (path NoTerraformFilesFound) Error() string
type TerraformSource ¶ added in v0.9.7
type TerraformSource struct { // A canonical version of RawSource, in URL format CanonicalSourceURL *url.URL // The folder where we should download the source to DownloadDir string // The folder in DownloadDir that should be used as the working directory for Terraform WorkingDir string // The path to a file in DownloadDir that stores the version number of the code VersionFile string }
This struct represents information about Terraform source code that needs to be downloaded
func (*TerraformSource) String ¶ added in v0.9.7
func (src *TerraformSource) String() string
type TerragruntInfoGroup ¶ added in v0.18.5
type TerragruntInfoGroup struct { ConfigPath string DownloadDir string IamRole string TerraformBinary string TerraformCommand string WorkingDir string }
Struct is output as JSON by 'terragrunt-info':
type UnrecognizedCommand ¶ added in v0.6.0
type UnrecognizedCommand string
func (UnrecognizedCommand) Error ¶ added in v0.6.0
func (commandName UnrecognizedCommand) Error() string