Skip to content

backend/s3: Document need to reconfigure backend when updating Terraform#34098

Merged
gdavison merged 6 commits intomainfrom
s3/d-reconfigure
Oct 30, 2023
Merged

backend/s3: Document need to reconfigure backend when updating Terraform#34098
gdavison merged 6 commits intomainfrom
s3/d-reconfigure

Conversation

@gdavison
Copy link
Copy Markdown
Contributor

@gdavison gdavison commented Oct 16, 2023

Because of changes to the S3 Backend schema, some users are reporting that they need to reconfigure their backend when updating to Terraform 1.6, even if they have made no changes. Add this to the Upgrade Guide and S3 Backend documentation.

Relates #34022

Target Release

1.6.2

Draft CHANGELOG entry

Documentation change

@gdavison gdavison added documentation backend/s3 1.6-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged labels Oct 16, 2023
@ghost
Copy link
Copy Markdown

ghost commented Oct 17, 2023

@gdavison there's a typo on line 19 of website/docs/language/settings/backends/s3.mdx, and the same on line 142 of website/docs/language/upgrade-guides/index.mdx: "Becuase".

Previously, the configuration to assume the IAM role `arn:aws:iam::123456789012:role/example` with a session name `example-session` and a session duration of 15 minutes was:

```hcl
terraform {
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this example show backend S3 block?

terraform {
  backend "s3" {
    assume_role  {
        role_arn     = "arn:aws:iam::123456789012:role/example"
        session_name = "example-session"
        duration     = "15m"
    }
  }
}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good catch

Co-authored-by: Jared Baker <jar-b@users.noreply.github.com>
Copy link
Copy Markdown
Member

@jar-b jar-b left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Copy link
Copy Markdown
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating this information. I made some suggestions that are mostly around consistency with our style guide.

@trujillo-adam trujillo-adam added the tw-reviewed Technical Writing has reviewed this PR. label Oct 23, 2023
@gdavison
Copy link
Copy Markdown
Contributor Author

Thanks to #34108, users do not need to reconfigure the backend. Leaving the deprecation documentation

@gdavison gdavison merged commit e131a9c into main Oct 30, 2023
@gdavison gdavison deleted the s3/d-reconfigure branch October 30, 2023 21:57
@github-actions
Copy link
Copy Markdown
Contributor

Reminder for the merging maintainer: if this is a user-visible change, please update the changelog on the appropriate release branch.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Dec 7, 2023

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 7, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

1.6-backport If you add this label to a PR before merging, backport-assistant will open a new PR once merged backend/s3 documentation tw-reviewed Technical Writing has reviewed this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants