Skip to content

Commit

Permalink
chore(docs): update terraform backend guide (backport #3445) (#3446)
Browse files Browse the repository at this point in the history
This is an automatic backport of pull request #3445 done by
[Mergify](https://mergify.com).


---


<details>
<summary>Mergify commands and options</summary>

<br />

More conditions and actions can be found in the
[documentation](https://docs.mergify.com/).

You can also trigger Mergify actions by commenting on this pull request:

- `@Mergifyio refresh` will re-evaluate the rules
- `@Mergifyio rebase` will rebase this PR on its base branch
- `@Mergifyio update` will merge the base branch into this PR
- `@Mergifyio backport <destination>` will backport this PR on
`<destination>` branch

Additionally, on Mergify [dashboard](https://dashboard.mergify.com) you
can:

- look at your merge queues
- generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com
</details>

Co-authored-by: Chris Rybicki <[email protected]>
  • Loading branch information
mergify[bot] and Chriscbr authored Jul 14, 2023
1 parent d722833 commit bf4c3b8
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/docs/08-guides/01-terraform-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,11 @@ aws s3api create-bucket --bucket <bucket-name> --region <region> --create-bucket
This could be looking like the following when replacing the placeholder `<bucket-name>` and `<region>`

```sh
aws s3api create-bucket --bucket my-tfstate-bucket-with-a-uniue-name --region us-east-1 --create-bucket-configuration LocationConstraint=us-east-1
aws s3api create-bucket --bucket my-tfstate-bucket-with-a-uniue-name --region us-east-2 --create-bucket-configuration LocationConstraint=us-east-2
```

(If you are using us-east-1, you must omit the `--create-bucket-configuration` flag since it is the default region.)

## Step 2: Enable Versioning

To take advantage of the S3 backend's versioning capabilities, we must enable versioning on our bucket. Versioning allows us to preserve, retrieve, and restore every version of every object in our bucket. This will be particularly beneficial when dealing with Terraform's state file as it allows us to roll back to a previous state if needed.
Expand Down

0 comments on commit bf4c3b8

Please sign in to comment.