Documentation ¶
Index ¶
- Constants
- 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 PrintDoc(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)
- func PrintVersions(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)
- type ErrArgMissingValue
- type ErrInvalidTerraformVersion
- type ErrInvalidTerraformVersionSyntax
- type TerraformSource
Constants ¶
const ( OptTerragruntIgnoreDependencyErrors = "terragrunt-ignore-dependency-errors" OptLoggingLevel = "terragrunt-logging-level" OptFlushDelay = "terragrunt-flush-delay" OptNbWorkers = "terragrunt-workers" OptAWSProfile = "profile" )
Constant used to define the command line options
Variables ¶
This section is empty.
Functions ¶
func CheckTerraformVersion ¶ added in v0.12.5
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 ¶
CreateTerragruntCli creates the Terragrunt CLI App.
func ParseTerragruntOptions ¶ added in v0.6.0
func ParseTerragruntOptions(cliContext *cli.Context) (*options.TerragruntOptions, error)
ParseTerragruntOptions parses command line options that are passed in for Terragrunt
func PrintDoc ¶ added in v1.0.0
func PrintDoc(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)
PrintDoc prints the contextual documentation relative to the current project
func PrintVersions ¶ added in v1.0.0
func PrintVersions(terragruntOptions *options.TerragruntOptions, conf *config.TerragruntConfig)
PrintVersions prints the version of all configured underlying tools
Types ¶
type ErrArgMissingValue ¶ added in v1.0.0
type ErrArgMissingValue string
ErrArgMissingValue indicates that there is a missing argument value
func (ErrArgMissingValue) Error ¶ added in v1.0.0
func (err ErrArgMissingValue) Error() string
type ErrInvalidTerraformVersion ¶ added in v1.0.0
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 ¶ added in v1.0.0
func (err ErrInvalidTerraformVersion) Error() string
type ErrInvalidTerraformVersionSyntax ¶ added in v1.0.0
type ErrInvalidTerraformVersionSyntax string
ErrInvalidTerraformVersionSyntax indicates that we cannot retrieve the terraform version
func (ErrInvalidTerraformVersionSyntax) Error ¶ added in v1.0.0
func (err ErrInvalidTerraformVersionSyntax) 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 }
TerraformSource represents information about Terraform source code that needs to be downloaded
func (*TerraformSource) String ¶ added in v0.9.7
func (src *TerraformSource) String() string