README
¶
Terragrunt
Terragrunt is a flexible orchestration tool that allows Infrastructure as Code written in OpenTofu/Terraform to scale.
Please see the following for more info, including install instructions and complete documentation:
- Terragrunt Website
- Getting started with Terragrunt
- Terragrunt Documentation
- Contributing to Terragrunt
- Commercial Support
Join the Discord!
Join our community for discussions, support, and contributions:
License
This code is released under the MIT License. See LICENSE.txt.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package awshelper provides helper functions for working with AWS services.
|
Package awshelper provides helper functions for working with AWS services. |
|
Package cli configures the Terragrunt CLI app and its commands.
|
Package cli configures the Terragrunt CLI app and its commands. |
|
commands
Package commands represents CLI commands.
|
Package commands represents CLI commands. |
|
commands/aws-provider-patch
Package awsproviderpatch provides the `aws-provider-patch` command.
|
Package awsproviderpatch provides the `aws-provider-patch` command. |
|
commands/catalog
Package catalog provides the ability to interact with a catalog of OpenTofu/Terraform modules via the `terragrunt catalog` command.
|
Package catalog provides the ability to interact with a catalog of OpenTofu/Terraform modules via the `terragrunt catalog` command. |
|
commands/catalog/module
Package module provides a struct to represent an OpenTofu/Terraform module.
|
Package module provides a struct to represent an OpenTofu/Terraform module. |
|
commands/catalog/tui
Package tui provides a text-based user interface for the Terragrunt catalog command.
|
Package tui provides a text-based user interface for the Terragrunt catalog command. |
|
commands/catalog/tui/command
Package command provides the implementation of the terragrunt scaffold command This command is used to scaffold a new Terragrunt unit in the current directory.
|
Package command provides the implementation of the terragrunt scaffold command This command is used to scaffold a new Terragrunt unit in the current directory. |
|
commands/catalog/tui/components/buttonbar
Package buttonbar provides a bubbletea component that displays an inline list of buttons.
|
Package buttonbar provides a bubbletea component that displays an inline list of buttons. |
|
commands/common
Package common provides common code that are used by many commands.
|
Package common provides common code that are used by many commands. |
|
commands/common/graph
Package graph provides the `graph` feature for Terragrunt.
|
Package graph provides the `graph` feature for Terragrunt. |
|
commands/common/runall
Package runall provides the feature that runs a terraform command against a 'stack' by running the specified command in each subfolder.
|
Package runall provides the feature that runs a terraform command against a 'stack' by running the specified command in each subfolder. |
|
commands/exec
Package exec provides the ability to execute a command using Terragrunt, via the `terragrunt exec -- command_name` command.
|
Package exec provides the ability to execute a command using Terragrunt, via the `terragrunt exec -- command_name` command. |
|
commands/find
Package find provides the ability to find Terragrunt configurations in your codebase via the `terragrunt find` command.
|
Package find provides the ability to find Terragrunt configurations in your codebase via the `terragrunt find` command. |
|
commands/graph
Package graph provides the `graph` command for Terragrunt.
|
Package graph provides the `graph` command for Terragrunt. |
|
commands/graph-dependencies
Package graphdependencies provides the command to print the terragrunt dependency graph to stdout.
|
Package graphdependencies provides the command to print the terragrunt dependency graph to stdout. |
|
commands/hclfmt
Package hclfmt provides the hclfmt command for formatting HCL files.
|
Package hclfmt provides the hclfmt command for formatting HCL files. |
|
commands/hclvalidate
Package hclvalidate provides the `hclvalidate` command for Terragrunt.
|
Package hclvalidate provides the `hclvalidate` command for Terragrunt. |
|
commands/help
Package help represents the help CLI command that works the same as the `--help` flag.
|
Package help represents the help CLI command that works the same as the `--help` flag. |
|
commands/info
Package info represents list of info commands that display various Terragrunt settings.
|
Package info represents list of info commands that display various Terragrunt settings. |
|
commands/info/strict
Package strict represents CLI command that displays Terragrunt's strict control settings.
|
Package strict represents CLI command that displays Terragrunt's strict control settings. |
|
commands/list
Package list provides the ability to list Terragrunt configurations in your codebase via the `terragrunt list` command.
|
Package list provides the ability to list Terragrunt configurations in your codebase via the `terragrunt list` command. |
|
commands/output-module-groups
Package outputmodulegroups provides a command to output groups of modules ordered by command (apply or destroy) as a list of list in JSON (useful for CI use cases).
|
Package outputmodulegroups provides a command to output groups of modules ordered by command (apply or destroy) as a list of list in JSON (useful for CI use cases). |
|
commands/render-json
Package renderjson provides the command to render the final terragrunt config, with all variables, includes, and functions resolved, as json.
|
Package renderjson provides the command to render the final terragrunt config, with all variables, includes, and functions resolved, as json. |
|
commands/run
Package run contains the logic for interacting with OpenTofu/Terraform.
|
Package run contains the logic for interacting with OpenTofu/Terraform. |
|
commands/run-all
Package runall provides the `run-all` command that runs a terraform command against a 'stack' by running the specified command in each subfolder.
|
Package runall provides the `run-all` command that runs a terraform command against a 'stack' by running the specified command in each subfolder. |
|
commands/run/creds
Package creds provides a way to obtain credentials through different providers and set them to `opts.Env`.
|
Package creds provides a way to obtain credentials through different providers and set them to `opts.Env`. |
|
commands/run/creds/providers
Package providers defines the interface for a provider.
|
Package providers defines the interface for a provider. |
|
commands/run/creds/providers/amazonsts
Package amazonsts provides a credentials provider that obtains credentials by making API requests to Amazon STS.
|
Package amazonsts provides a credentials provider that obtains credentials by making API requests to Amazon STS. |
|
commands/run/creds/providers/externalcmd
Package externalcmd provides a provider that runs an external command that returns a json string with credentials.
|
Package externalcmd provides a provider that runs an external command that returns a json string with credentials. |
|
commands/scaffold
Package scaffold provides the command to scaffold a new Terragrunt module.
|
Package scaffold provides the command to scaffold a new Terragrunt module. |
|
commands/stack
Package stack provides the command to stack.
|
Package stack provides the command to stack. |
|
commands/terragrunt-info
Package terragruntinfo provides the command to emit limited terragrunt state on stdout and exits.
|
Package terragruntinfo provides the command to emit limited terragrunt state on stdout and exits. |
|
commands/validate-inputs
Package validateinputs provides the command to validate the inputs of a Terragrunt configuration file against the variables defined in OpenTofu/Terraform configuration files.
|
Package validateinputs provides the command to validate the inputs of a Terragrunt configuration file against the variables defined in OpenTofu/Terraform configuration files. |
|
commands/version
Package version represents the version CLI command that works the same as the `--version` flag.
|
Package version represents the version CLI command that works the same as the `--version` flag. |
|
flags
Package flags provides tools that are used by all commands to create deprecation flags with strict controls.
|
Package flags provides tools that are used by all commands to create deprecation flags with strict controls. |
|
flags/global
Package global provides CLI global flags.
|
Package global provides CLI global flags. |
|
Package codegen contains routines for generating terraform code
|
Package codegen contains routines for generating terraform code |
|
Package config provides functionality for parsing Terragrunt configuration files.
|
Package config provides functionality for parsing Terragrunt configuration files. |
|
hclparse
Package hclparse provides a wrapper around the HCL2 parser to handle diagnostics and errors in a more user-friendly way.
|
Package hclparse provides a wrapper around the HCL2 parser to handle diagnostics and errors in a more user-friendly way. |
|
Package configstack contains the logic for managing a stack of Terraform modules (i.e.
|
Package configstack contains the logic for managing a stack of Terraform modules (i.e. |
|
Package dynamodb provides utilities for working with DynamoDB tables, such as creating and deleting tables.
|
Package dynamodb provides utilities for working with DynamoDB tables, such as creating and deleting tables. |
|
Package engine provides the pluggable IaC engine for Terragrunt.
|
Package engine provides the pluggable IaC engine for Terragrunt. |
|
internal
|
|
|
Package options provides a set of options that configure the behavior of the Terragrunt program.
|
Package options provides a set of options that configure the behavior of the Terragrunt program. |
|
Package pkg is a collection of common libraries that are used across the application.
|
Package pkg is a collection of common libraries that are used across the application. |
|
log
Package log provides a leveled logger with structured logging support.
|
Package log provides a leveled logger with structured logging support. |
|
log/format
Package format implements a custom format logs
|
Package format implements a custom format logs |
|
log/format/options
Package options represents a set of placeholders options.
|
Package options represents a set of placeholders options. |
|
log/format/placeholders
Package placeholders represents a set of placeholders for formatting various log values.
|
Package placeholders represents a set of placeholders for formatting various log values. |
|
log/writer
Package writer provides a writer that redirects Write requests to configured logger and level.
|
Package writer provides a writer that redirects Write requests to configured logger and level. |
|
Package remote contains code for configuring remote state storage.
|
Package remote contains code for configuring remote state storage. |
|
Package shell provides functions to run shell commands and Terraform commands.
|
Package shell provides functions to run shell commands and Terraform commands. |
|
Package telemetry provides a way to collect telemetry from function execution - metrics and traces.
|
Package telemetry provides a way to collect telemetry from function execution - metrics and traces. |
|
Package test provides integration tests for Terragrunt.
|
Package test provides integration tests for Terragrunt. |
|
helpers
Package helpers provides helper functions for tests.
|
Package helpers provides helper functions for tests. |
|
Package tf contains functions and routines for interacting with OpenTofu/Terraform.
|
Package tf contains functions and routines for interacting with OpenTofu/Terraform. |
|
cache
Package cache provides a private OpenTofu/Terraform provider cache server.
|
Package cache provides a private OpenTofu/Terraform provider cache server. |
|
cache/controllers
Package controllers provides the implementation of the controller for the provider endpoints.
|
Package controllers provides the implementation of the controller for the provider endpoints. |
|
cache/handlers
Package handlers provides the interfaces and common implementations for handling provider requests.
|
Package handlers provides the interfaces and common implementations for handling provider requests. |
|
cache/helpers
Package helpers provides utility functions for working with HTTP requests and responses.
|
Package helpers provides utility functions for working with HTTP requests and responses. |
|
cache/middleware
Package middleware provides a set of middleware for the Terragrunt provider cache server.
|
Package middleware provides a set of middleware for the Terragrunt provider cache server. |
|
cache/models
Package models provides the data structures used to represent Terraform providers and their details.
|
Package models provides the data structures used to represent Terraform providers and their details. |
|
cache/router
Package router provides a simple wrapper around the echo framework to create a REST API.
|
Package router provides a simple wrapper around the echo framework to create a REST API. |
|
cache/services
Package services provides services that can be run in the background.
|
Package services provides services that can be run in the background. |
|
cliconfig
Package cliconfig provides methods to create an OpenTofu/Terraform CLI configuration file.
|
Package cliconfig provides methods to create an OpenTofu/Terraform CLI configuration file. |
|
getproviders
Package getproviders provides an interface for getting providers.
|
Package getproviders provides an interface for getting providers. |
|
Package tflint embeds execution of tflint, which is under an MPL license, and you can find its source code at https://github.com/terraform-linters/tflint
|
Package tflint embeds execution of tflint, which is under an MPL license, and you can find its source code at https://github.com/terraform-linters/tflint |
|
Package util provides utility functions for Terragrunt.
|
Package util provides utility functions for Terragrunt. |
Click to show internal directories.
Click to hide internal directories.