Difference between revisions of "Terragrunt --help"

From wikieduonline
Jump to navigation Jump to search
(Created page with "<pre> DESCRIPTION: terragrunt - Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple Terraform modules, remote state, and locki...")
 
Line 1: Line 1:
−
<pre>
 
−
DESCRIPTION:
 
−
  terragrunt - Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple
 
−
  Terraform modules, remote state, and locking. For documentation, see https://github.com/gruntwork-io/terragrunt/.
 
  
−
USAGE:
+
DESCRIPTION:
−
  terragrunt <COMMAND>
+
    terragrunt - Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple
−
 
+
    Terraform modules, remote state, and locking. For documentation, see https://github.com/gruntwork-io/terragrunt/.
−
COMMANDS:
+
−
  run-all              Run a terraform command against a 'stack' by running the specified command in each subfolder. E.g., to run 'terragrunt apply' in each subfolder, use 'terragrunt run-all apply'.
+
USAGE:
−
  terragrunt-info      Emits limited terragrunt state on stdout and exits
+
    terragrunt <COMMAND>  
−
  validate-inputs      Checks if the terragrunt configured inputs align with the terraform defined variables.
+
−
  graph-dependencies    Prints the terragrunt dependency graph to stdout
+
COMMANDS:
−
  hclfmt                Recursively find terragrunt.hcl files and rewrite them into a canonical format.
+
    run-all              Run a terraform command against a 'stack' by running the specified command in each subfolder. E.g., to run 'terragrunt  
−
  aws-provider-patch    Overwrite settings on nested AWS providers to work around a Terraform bug (issue #13018)
+
apply' in each subfolder, use 'terragrunt run-all apply'.
−
  *                    Terragrunt forwards all other commands directly to Terraform
+
    terragrunt-info      Emits limited terragrunt state on stdout and exits
−
 
+
    validate-inputs      Checks if the terragrunt configured inputs align with the terraform defined variables.
−
GLOBAL OPTIONS:
+
    graph-dependencies    Prints the terragrunt dependency graph to stdout
−
  terragrunt-config                            Path to the Terragrunt config file. Default is terragrunt.hcl.
+
    hclfmt                Recursively find terragrunt.hcl files and rewrite them into a canonical format.
−
  terragrunt-tfpath                            Path to the Terraform binary. Default is terraform (on PATH).
+
    aws-provider-patch    Overwrite settings on nested AWS providers to work around a Terraform bug (issue #13018)
−
  terragrunt-no-auto-init                      Don't automatically run 'terraform init' during other terragrunt commands. You must run 'terragrunt init' manually.
+
    *                    Terragrunt forwards all other commands directly to Terraform  
−
  terragrunt-no-auto-retry                    Don't automatically re-run command in case of transient errors.
+
−
  terragrunt-non-interactive                  Assume "yes" for all prompts.
+
GLOBAL OPTIONS:
−
  terragrunt-working-dir                      The path to the Terraform templates. Default is current directory.
+
    terragrunt-config                            Path to the Terragrunt config file. Default is terragrunt.hcl.
−
  terragrunt-download-dir                      The path where to download Terraform code. Default is .terragrunt-cache in the working directory.
+
    terragrunt-tfpath                            Path to the Terraform binary. Default is terraform (on PATH).
−
  terragrunt-source                            Download Terraform configurations from the specified source into a temporary folder, and run Terraform in that temporary folder.
+
    terragrunt-no-auto-init                      Don't automatically run 'terraform init' during other terragrunt commands. You must run 'terragrunt  
−
  terragrunt-source-update                    Delete the contents of the temporary folder to clear out any old, cached source code before downloading new source code into it.
+
init' manually.
−
  terragrunt-iam-role                          Assume the specified IAM role before executing Terraform. Can also be set via the TERRAGRUNT_IAM_ROLE environment variable.
+
    terragrunt-no-auto-retry                    Don't automatically re-run command in case of transient errors.
−
  terragrunt-ignore-dependency-errors          *-all commands continue processing components even if a dependency fails.
+
    terragrunt-non-interactive                  Assume "yes" for all prompts.
−
  terragrunt-ignore-dependency-order          *-all commands will be run disregarding the dependencies
+
    terragrunt-working-dir                      The path to the Terraform templates. Default is current directory.
−
  terragrunt-ignore-external-dependencies      *-all commands will not attempt to include external dependencies
+
    terragrunt-download-dir                      The path where to download Terraform code. Default is .terragrunt-cache in the working directory.
−
  terragrunt-include-external-dependencies    *-all commands will include external dependencies
+
    terragrunt-source                            Download Terraform configurations from the specified source into a temporary folder, and run  
−
  terragrunt-parallelism <N>                  *-all commands parallelism set to at most N modules
+
Terraform in that temporary folder.
−
  terragrunt-exclude-dir                      Unix-style glob of directories to exclude when running *-all commands
+
    terragrunt-source-update                    Delete the contents of the temporary folder to clear out any old, cached source code before  
−
  terragrunt-include-dir                      Unix-style glob of directories to include when running *-all commands
+
downloading new source code into it.
−
  terragrunt-check                            Enable check mode in the hclfmt command.
+
    terragrunt-iam-role                          Assume the specified IAM role before executing Terraform. Can also be set via the  
−
  terragrunt-hclfmt-file                      The path to a single terragrunt.hcl file that the hclfmt command should run on.
+
TERRAGRUNT_IAM_ROLE environment variable.
−
  terragrunt-override-attr                    A key=value attribute to override in a provider block as part of the aws-provider-patch command. May be specified multiple times.
+
    terragrunt-ignore-dependency-errors          *-all commands continue processing components even if a dependency fails.
−
  terragrunt-debug                            Write terragrunt-debug.tfvars to working folder to help root-cause issues.
+
    terragrunt-ignore-dependency-order          *-all commands will be run disregarding the dependencies
−
  terragrunt-log-level                        Sets the logging level for Terragrunt. Supported levels: panic, fatal, error, warn (default), info, debug, trace.
+
    terragrunt-ignore-external-dependencies      *-all commands will not attempt to include external dependencies
−
 
+
    terragrunt-include-external-dependencies    *-all commands will include external dependencies
−
VERSION:
+
    terragrunt-parallelism <N>                  *-all commands parallelism set to at most N modules
−
  v0.29.0
+
    terragrunt-exclude-dir                      Unix-style glob of directories to exclude when running *-all commands
−
 
+
    terragrunt-include-dir                      Unix-style glob of directories to include when running *-all commands
−
AUTHOR(S):
+
    terragrunt-check                            Enable check mode in the hclfmt command.
−
  Gruntwork <www.gruntwork.io>
+
    terragrunt-hclfmt-file                      The path to a single terragrunt.hcl file that the hclfmt command should run on.
−
</pre>
+
    terragrunt-override-attr                    A key=value attribute to override in a provider block as part of the aws-provider-patch command.  
 +
May be specified multiple times.
 +
    terragrunt-debug                            Write terragrunt-debug.tfvars to working folder to help root-cause issues.
 +
    terragrunt-log-level                        Sets the logging level for Terragrunt. Supported levels: panic, fatal, error, warn (default), info,  
 +
debug, trace.  
 +
 +
VERSION:
 +
    v0.29.0
 +
 +
AUTHOR(S):
 +
    Gruntwork <www.gruntwork.io>
  
 
== See also ==
 
== See also ==

Revision as of 17:15, 26 April 2021

DESCRIPTION:
   terragrunt - Terragrunt is a thin wrapper for Terraform that provides extra tools for working with multiple
   Terraform modules, remote state, and locking. For documentation, see https://github.com/gruntwork-io/terragrunt/.

USAGE:
   terragrunt <COMMAND> 

COMMANDS:
   run-all               Run a terraform command against a 'stack' by running the specified command in each subfolder. E.g., to run 'terragrunt 
apply' in each subfolder, use 'terragrunt run-all apply'.
   terragrunt-info       Emits limited terragrunt state on stdout and exits
   validate-inputs       Checks if the terragrunt configured inputs align with the terraform defined variables.
   graph-dependencies    Prints the terragrunt dependency graph to stdout
   hclfmt                Recursively find terragrunt.hcl files and rewrite them into a canonical format.
   aws-provider-patch    Overwrite settings on nested AWS providers to work around a Terraform bug (issue #13018)
   *                     Terragrunt forwards all other commands directly to Terraform 

GLOBAL OPTIONS:
   terragrunt-config                            Path to the Terragrunt config file. Default is terragrunt.hcl.
   terragrunt-tfpath                            Path to the Terraform binary. Default is terraform (on PATH).
   terragrunt-no-auto-init                      Don't automatically run 'terraform init' during other terragrunt commands. You must run 'terragrunt 
init' manually.
   terragrunt-no-auto-retry                     Don't automatically re-run command in case of transient errors.
   terragrunt-non-interactive                   Assume "yes" for all prompts.
   terragrunt-working-dir                       The path to the Terraform templates. Default is current directory.
   terragrunt-download-dir                      The path where to download Terraform code. Default is .terragrunt-cache in the working directory.
   terragrunt-source                            Download Terraform configurations from the specified source into a temporary folder, and run 
Terraform in that temporary folder.
   terragrunt-source-update                     Delete the contents of the temporary folder to clear out any old, cached source code before 
downloading new source code into it.
   terragrunt-iam-role                          Assume the specified IAM role before executing Terraform. Can also be set via the 
TERRAGRUNT_IAM_ROLE environment variable.
   terragrunt-ignore-dependency-errors          *-all commands continue processing components even if a dependency fails.
   terragrunt-ignore-dependency-order           *-all commands will be run disregarding the dependencies
   terragrunt-ignore-external-dependencies      *-all commands will not attempt to include external dependencies
   terragrunt-include-external-dependencies     *-all commands will include external dependencies
   terragrunt-parallelism <N>                   *-all commands parallelism set to at most N modules
   terragrunt-exclude-dir                       Unix-style glob of directories to exclude when running *-all commands
   terragrunt-include-dir                       Unix-style glob of directories to include when running *-all commands
   terragrunt-check                             Enable check mode in the hclfmt command.
   terragrunt-hclfmt-file                       The path to a single terragrunt.hcl file that the hclfmt command should run on.
   terragrunt-override-attr                     A key=value attribute to override in a provider block as part of the aws-provider-patch command. 
May be specified multiple times.
   terragrunt-debug                             Write terragrunt-debug.tfvars to working folder to help root-cause issues.
   terragrunt-log-level                         Sets the logging level for Terragrunt. Supported levels: panic, fatal, error, warn (default), info, 
debug, trace. 

VERSION:
   v0.29.0

AUTHOR(S):
   Gruntwork <www.gruntwork.io>

See also

Retrieved from "https://www.wikieduonline.com/index.php?title=Terragrunt_--help&oldid=59368"

Advertising: