cli

Documentation

Index

• Constants
• Variables
• func CreateTerragruntCli(version string) *cli.App
• func ParseTerragruntOptions(cliContext *cli.Context) (*options.TerragruntOptions, error)
• type ArgMissingValue
  • func (err ArgMissingValue) Error() string
• type TerraformSource
  • func (src *TerraformSource) String() string
• type UnrecognizedCommand
  • func (commandName UnrecognizedCommand) Error() string

Constants

const CMD_ACQUIRE_LOCK = "acquire-lock"

const CMD_RELEASE_LOCK = "release-lock"

const CMD_SPIN_UP = "spin-up"

const CMD_TEAR_DOWN = "tear-down"

const OPT_NON_INTERACTIVE = "terragrunt-non-interactive"

const OPT_TERRAGRUNT_CONFIG = "terragrunt-config"

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 TERRAFORM_EXTENSION_GLOB = "*.tf"

Variables

var ALL_TERRAGRUNT_BOOLEAN_OPTS = []string{OPT_NON_INTERACTIVE, OPT_TERRAGRUNT_SOURCE_UPDATE}

var ALL_TERRAGRUNT_STRING_OPTS = []string{OPT_TERRAGRUNT_CONFIG, OPT_TERRAGRUNT_TFPATH, OPT_WORKING_DIR, OPT_TERRAGRUNT_SOURCE}

var CUSTOM_USAGE_TEXT = `` /* 1625-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.

var DontManuallyConfigureRemoteState = fmt.Errorf("Instead of manually using the 'remote config' command, define your remote state settings in .terragrunt and Terragrunt will automatically configure it for you (and all your team members) next time you run it.")

var MODULE_REGEX = regexp.MustCompile(`module ".+"`)

var MULTI_MODULE_COMMANDS = []string{CMD_SPIN_UP, CMD_TEAR_DOWN}

Functions

func CreateTerragruntCli

func CreateTerragruntCli(version string) *cli.App

Create the Terragrunt CLI App

func ParseTerragruntOptions

func ParseTerragruntOptions(cliContext *cli.Context) (*options.TerragruntOptions, error)

Parse command line options that are passed in for Terragrunt

Types

type ArgMissingValue

type ArgMissingValue string

func (ArgMissingValue) Error

func (err ArgMissingValue) Error() string

type TerraformSource

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

func (src *TerraformSource) String() string

type UnrecognizedCommand

type UnrecognizedCommand string

func (UnrecognizedCommand) Error

func (commandName UnrecognizedCommand) Error() string