Terragrunt supports operating in a mode referred to as “Experiment Mode”.
Experiment Mode is a set of controls that can be enabled to opt-in to experimental features before they’re stable. These features are subject to change and may be removed or altered at any time. They generally provide early access to new features or changes that are being considered for inclusion in future releases.
Those experiments will be documented here so that you know the following:
Sometimes, the criteria for an experiment to be considered stable is unknown, as there may not be a clear path to stabilization. In that case, this will be noted in the experiment documentation, and collaboration with the community will be encouraged to help determine the future of the experiment.
The simplest way to enable experiment mode is to set the experiment-mode flag.
This will enable experiment mode for all Terragrunt commands, for all experiments (note that this isn’t generally recommended, unless you are following Terragrunt development closely and are prepared for the possibility of breaking changes).
terragrunt plan --experiment-mode
You can also use the environment variable, which can be more useful in CI/CD pipelines:
TERRAGRUNT_EXPERIMENT_MODE='true' terragrunt plan
Instead of enabling experiment mode, you can also enable specific experiments by setting the experiment flag to a value that’s specific to a experiment. This can allow you to experiment with a specific unstable feature that you think might be useful to you.
terragrunt plan --experiment symlinks
Again, you can also use the environment variable, which can be more useful in CI/CD pipelines:
TERRAGRUNT_EXPERIMENT='symlinks' terragrunt plan
You can also enable multiple experiments at once with a comma delimited list.
TODO: Will add an example here once there’s more than one officially supported experiment. The existing experiments are scattered throughout configuration, so they need to be pulled into this system first.
The following strict mode controls are available:
Support symlink resolution for Terragrunt units.
By default, Terragrunt will ignore symlinks when determining which units it should run. By enabling this experiment, Terragrunt will resolve symlinks and add them to the list of units being run.
Provide your feedback on the Experiment: Symlinks discussion.
To stabilize this feature, the following need to be resolved, at a minimum:
Install
