Skip to content

Commit 97848f2

Browse files
authored
Update README.md
1 parent c87e8f4 commit 97848f2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,19 @@ Terraform module for deploying infrastructure components to run CometML.
1717
- Within terraform.tfvars, set your module toggles to enable the desired infrastructure components and set any related inputs
1818
- Provision the resources: `terraform apply`
1919

20+
**A note on state management:**
21+
- This configuration stores the Terraform state locally by default. To store the state file remotely in S3, a `backend` block can be nested within the `terraform` block inside comet-infrastructure/versions.tf. Below is an example of such a configuration:
22+
```
23+
terraform {
24+
backend "s3" {
25+
bucket = "mybucket"
26+
key = "path/to/my/key"
27+
region = "us-east-1"
28+
}
29+
}
30+
```
31+
- More on state management in S3 can be found [here](https://developer.hashicorp.com/terraform/language/settings/backends/s3)
32+
2033
## Requirements
2134

2235
| Name | Version |

0 commit comments

Comments
 (0)