terraform

Documentation

Index

• Constants
• Variables
• func CheckTerraformVersion(constraint string, terragruntOptions *options.TerragruntOptions) error
• func CheckTerragruntVersion(constraint string, terragruntOptions *options.TerragruntOptions) error
• func NewCommand(opts *options.TerragruntOptions) *cli.Command
• func PopulateTerraformVersion(terragruntOptions *options.TerragruntOptions) error
• func Run(opts *options.TerragruntOptions) error
• func RunWithTarget(opts *options.TerragruntOptions, target *Target) error
• func WriteTerragruntDebugFile(terragruntOptions *options.TerragruntOptions, ...) error
• type BackendNotDefined
  • func (err BackendNotDefined) Error() string
• type FileCopyGetter
  • func (g *FileCopyGetter) Get(dst string, u *url.URL) error
  • func (g *FileCopyGetter) GetFile(dst string, u *url.URL) error
• type InvalidTerraformVersion
  • func (err InvalidTerraformVersion) Error() string
• type InvalidTerraformVersionSyntax
  • func (err InvalidTerraformVersionSyntax) Error() string
• type InvalidTerragruntVersion
  • func (err InvalidTerragruntVersion) Error() string
• type MaxRetriesExceeded
  • func (err MaxRetriesExceeded) Error() string
• type MissingCommand
  • func (err MissingCommand) Error() string
• type ModuleIsProtected
  • func (err ModuleIsProtected) Error() string
• type NoTerraformFilesFound
  • func (path NoTerraformFilesFound) Error() string
• type Target
  • func NewTarget(point TargetPointType, callbackFunc TargetCallbackType) *Target
• type TargetCallbackType
• type TargetPointType
• type WorkingDirNotDir
  • func (err WorkingDirNotDir) Error() string
• type WorkingDirNotFound
  • func (err WorkingDirNotFound) Error() string
• type WrongTerraformCommand
  • func (name WrongTerraformCommand) Error() string

Constants

const (
	CommandNameInit                 = "init"
	CommandNameInitFromModule       = "init-from-module"
	CommandNamePlan                 = "plan"
	CommandNameApply                = "apply"
	CommandNameDestroy              = "destroy"
	CommandNameValidate             = "validate"
	CommandNameOutput               = "output"
	CommandNameProviders            = "providers"
	CommandNameLock                 = "lock"
	CommandNameTerragruntReadConfig = "terragrunt-read-config"
	NullTFVarsFile                  = ".terragrunt-null-vars.auto.tfvars.json"

	TerraformFlagNoColor = "-no-color"
)

const (
	CommandName = "terraform"
)

const DefaultTerraformVersionConstraint = ">= v0.12.0"

This uses the constraint syntax from https://github.com/hashicorp/go-version This version of Terragrunt was tested to work with Terraform 0.12.0 and above only

const MODULE_MANIFEST_NAME = ".terragrunt-module-manifest"

manifest for files copied from terragrunt module folder (i.e., the folder that contains the current terragrunt.hcl)

const SourceManifestName = ".terragrunt-source-manifest"

manifest for files copied from the URL specified in the terraform { source = "<URL>" } config

const TerraformExtensionGlob = "*.tf"

const TerragruntTFVarsFile = "terragrunt-debug.tfvars.json"

Variables

var ModuleRegex = regexp.MustCompile(`module[[:blank:]]+".+"`)

var TerraformCommandsThatDoNotNeedInit = []string{
	"version",
	"terragrunt-info",
	"graph-dependencies",
}

var TerraformCommandsThatUseState = []string{
	"init",
	"apply",
	"destroy",
	"env",
	"import",
	"graph",
	"output",
	"plan",
	"push",
	"refresh",
	"show",
	"taint",
	"untaint",
	"validate",
	"force-unlock",
	"state",
}

var TerraformVersionRegex = regexp.MustCompile(`Terraform (v?\d+\.\d+\.\d+).*`)

TerraformVersionRegex verifies that terraform --version output is in one of the following formats: - Terraform v0.9.5-dev (cad024a5fe131a546936674ef85445215bbc4226+CHANGES) - Terraform v0.13.0-beta2 - Terraform v0.12.27 We only make sure the "v#.#.#" part is present in the output.

Functions

func CheckTerraformVersion

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 CheckTerragruntVersion

func CheckTerragruntVersion(constraint string, terragruntOptions *options.TerragruntOptions) error

Check that the currently running Terragrunt version meets the specified version constraint and return an error if it doesn't

func NewCommand

func NewCommand(opts *options.TerragruntOptions) *cli.Command

func PopulateTerraformVersion

func PopulateTerraformVersion(terragruntOptions *options.TerragruntOptions) error

Populate the currently installed version of Terraform into the given terragruntOptions

func Run

func Run(opts *options.TerragruntOptions) error

Run downloads terraform source if necessary, then runs terraform with the given options and CLI args. This will forward all the args and extra_arguments directly to Terraform.

func RunWithTarget

func RunWithTarget(opts *options.TerragruntOptions, target *Target) error

func WriteTerragruntDebugFile

func WriteTerragruntDebugFile(terragruntOptions *options.TerragruntOptions, terragruntConfig *config.TerragruntConfig) error

WriteTerragruntDebugFile will create a tfvars file that can be used to invoke the terraform module in the same way that terragrunt invokes the module, so that you can debug issues with the terragrunt config.

Types

type BackendNotDefined

type BackendNotDefined struct {
	Opts        *options.TerragruntOptions
	BackendType string
}

func (BackendNotDefined) Error

func (err BackendNotDefined) Error() string

type FileCopyGetter

type FileCopyGetter struct {
	getter.FileGetter

	// List of glob paths that should be included in the copy. This can be used to override the default behavior of
	// Terragrunt, which will skip hidden folders.
	IncludeInCopy []string
}

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.

func (*FileCopyGetter) Get

func (g *FileCopyGetter) Get(dst string, u *url.URL) error

The original FileGetter does NOT know how to do folder copying (it only does symlinks), so we provide a copy implementation here

func (*FileCopyGetter) GetFile

func (g *FileCopyGetter) GetFile(dst string, u *url.URL) error

The original FileGetter already knows how to do file copying so long as we set the Copy flag to true, so just delegate to it

type InvalidTerraformVersion

type InvalidTerraformVersion struct {
	CurrentVersion     *version.Version
	VersionConstraints version.Constraints
}

func (InvalidTerraformVersion) Error

func (err InvalidTerraformVersion) Error() string

type InvalidTerraformVersionSyntax

type InvalidTerraformVersionSyntax string

func (InvalidTerraformVersionSyntax) Error

func (err InvalidTerraformVersionSyntax) Error() string

type InvalidTerragruntVersion

type InvalidTerragruntVersion struct {
	CurrentVersion     *version.Version
	VersionConstraints version.Constraints
}

func (InvalidTerragruntVersion) Error

func (err InvalidTerragruntVersion) Error() string

type MaxRetriesExceeded

type MaxRetriesExceeded struct {
	Opts *options.TerragruntOptions
}

func (MaxRetriesExceeded) Error

func (err MaxRetriesExceeded) Error() string

type MissingCommand

type MissingCommand struct{}

func (MissingCommand) Error

func (err MissingCommand) Error() string

type ModuleIsProtected

type ModuleIsProtected struct {
	Opts *options.TerragruntOptions
}

func (ModuleIsProtected) Error

func (err ModuleIsProtected) Error() string

type NoTerraformFilesFound

type NoTerraformFilesFound string

func (NoTerraformFilesFound) Error

func (path NoTerraformFilesFound) Error() string

type Target

type Target struct {
	// contains filtered or unexported fields
}

func NewTarget

func NewTarget(point TargetPointType, callbackFunc TargetCallbackType) *Target

type TargetCallbackType

type TargetCallbackType func(opts *options.TerragruntOptions, config *config.TerragruntConfig) error

type TargetPointType

type TargetPointType byte

const (
	TargetPointParseConfig TargetPointType = iota + 1
	TargetPointDownloadSource
	TargetPointGenerateConfig
	TargetPointInitCommand
)

type WorkingDirNotDir

type WorkingDirNotDir struct {
	Source string
	Dir    string
}

func (WorkingDirNotDir) Error

func (err WorkingDirNotDir) Error() string

type WorkingDirNotFound

type WorkingDirNotFound struct {
	Source string
	Dir    string
}

func (WorkingDirNotFound) Error

func (err WorkingDirNotFound) Error() string

type WrongTerraformCommand

type WrongTerraformCommand string

func (WrongTerraformCommand) Error

func (name WrongTerraformCommand) Error() string