cli

Documentation

Index

• func CheckTerraformVersion(constraint string, terragruntOptions *options.TerragruntOptions) error
• func CreateTerragruntCli(version string, writer, errwriter io.Writer) *cli.App
• func ParseTerragruntOptions(cliContext *cli.Context) (*options.TerragruntOptions, error)
• func PrintDoc(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)
• func PrintVersions(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)
• type ErrArgMissingValue
  • func (err ErrArgMissingValue) Error() string
• type ErrInvalidTerraformVersion
  • func (err ErrInvalidTerraformVersion) Error() string
• type ErrInvalidTerraformVersionSyntax
  • func (err ErrInvalidTerraformVersionSyntax) Error() string
• type TerraformSource
  • func (src *TerraformSource) String() string

Functions

func CheckTerraformVersion

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

CheckTerraformVersion checks that the currently installed Terraform version works meets the specified version constraint and returns an error if it doesn't

func CreateTerragruntCli

func CreateTerragruntCli(version string, writer, errwriter io.Writer) *cli.App

CreateTerragruntCli creates the Terragrunt CLI App.

func ParseTerragruntOptions

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

ParseTerragruntOptions parses command line options that are passed in for Terragrunt

func PrintDoc

func PrintDoc(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)

PrintDoc prints the contextual documentation relative to the current project

func PrintVersions

func PrintVersions(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)

PrintVersions prints the version of all configured underlying tools

Types

type ErrArgMissingValue

type ErrArgMissingValue string

ErrArgMissingValue indicates that there is a missing argument value

func (ErrArgMissingValue) Error

func (err ErrArgMissingValue) Error() string

type ErrInvalidTerraformVersion

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

ErrInvalidTerraformVersion indicates that the Terraform version is not compatible with this version of Terragrunt

func (ErrInvalidTerraformVersion) Error

func (err ErrInvalidTerraformVersion) Error() string

type ErrInvalidTerraformVersionSyntax

type ErrInvalidTerraformVersionSyntax string

ErrInvalidTerraformVersionSyntax indicates that we cannot retrieve the terraform version

func (ErrInvalidTerraformVersionSyntax) Error

func (err ErrInvalidTerraformVersionSyntax) 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
}

TerraformSource represents information about Terraform source code that needs to be downloaded

func (*TerraformSource) String

func (src *TerraformSource) String() string