Skip to content

Commit 57435a4

Browse files
Add details for terragrunt native state management (#1015)
Will be in private beta this week (mid-Jan), GA soon (but not yet).
1 parent 06dad67 commit 57435a4

File tree

5 files changed

+17
-2
lines changed

5 files changed

+17
-2
lines changed
255 KB
Loading

docs/vendors/terraform/terragrunt.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ Whether a Terraform stack is using Terragrunt or not is controlled by the presen
1111

1212
If present, all workloads will use `terragrunt` instead of `terraform` as the main command. Since the Terragrunt API is a superset of Terraform's, this is completely transparent to the end user.
1313

14+
!!! info
15+
Spacelift is working to enable [native state management](../terragrunt/limitations.md#state-management) for Terragrunt. The `terragrunt` label will be deprecated.
16+
1417
Terragrunt is installed on our [standard runner image](../../integrations/docker.md#standard-runner-image). If you're not using our runner image, you can [install Terragrunt separately](https://terragrunt.gruntwork.io/docs/getting-started/install/#install-terragrunt){: rel="nofollow"}.
1518

1619
During the _Initialization_ phase we're showing you the exact binary that will process your job, along with its location:

docs/vendors/terragrunt/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Managing Terragrunt Stacks through Spacelift.
44
# Terragrunt
55

66
!!! warning
7-
Terragrunt support is currently in **beta** and has some important limitations to take into consideration. Please see our documentation [here](limitations.md) for more information.
7+
Terragrunt support is currently in **beta** and has some important [limitations](./limitations.md) to take into consideration.
88

99
## Why use Terragrunt?
1010

docs/vendors/terragrunt/getting-started.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Creating your first Terragrunt Stack with Spacelift, step by step.
55
# Getting Started
66

77
!!! warning
8-
Terragrunt support is currently in **beta** and has some important limitations to take into consideration. Please see our documentation [here](limitations.md) for more information.
8+
Terragrunt support is currently in **beta** and has some important [limitations](./limitations.md) to take into consideration.
99

1010
This documentation will be using an example repository Spacelift provides [here](https://github.com/spacelift-io-examples/terragrunt-examples){: rel="nofollow"}. This repository contains two different examples, but in this guide we will use the single-stack example.
1111

@@ -27,10 +27,19 @@ On the **Connect to source code** screen, Select **Raw Git** as your Provider, a
2727

2828
Pressing continue on this page will take you through to the vendor configuration page.
2929

30+
!!! info
31+
Spacelift is working to enable native state management for Terragrunt, which will be available for private beta in mid-January. Contact your customer representative or Spacelift support for more information.
32+
3033
This page has quite a few options but the ones that we will be using for this example are as follows:
3134

3235
![Stack Creation - Choose vendor](../../assets/screenshots/terragrunt/getting-started/backend.png)
3336

37+
### Native state management option (beta)
38+
39+
If you are part of the Terragrunt native state management beta, you will see a _Manage state_ slider. Enable it to allow Spacelift to manage the Terragrunt state.
40+
41+
![Terragrunt native state management option](<../../assets/screenshots/terragrunt-native-state-management.png>)
42+
3443
Press **Create & continue** to finish the backend configuration and move through to defining stack behavior. For this example nothing else needs to be configured, so you can click on **Skip to summary** and then click on **Confirm** to finish creating your stack.
3544

3645
## Deploying the stack

docs/vendors/terragrunt/limitations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: Details about all limitations when using Terragrunt stacks in space
66

77
## State management
88

9+
!!! info
10+
Spacelift is working to enable native state management for Terragrunt, which will be available for private beta in mid-January. Contact your customer representative or Spacelift support for more information.
11+
912
Terragrunt is a great tool for organizing your state management configuration and allows you to easily define how you manage your state across multiple projects. However, It is not currently possible when using Terragrunt's run-all functionality to relate state files to projects in a consistent manner. For this reason Spacelift does not support storing state for Terragrunt based stacks, and you will need to maintain your own remote state backend configuration.
1013

1114
## Terragrunt mocked outputs

0 commit comments

Comments
 (0)