Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: HashiCorp Terraform Version Compatibility Matrix #1969

Merged
merged 12 commits into from
Feb 23, 2024
Merged

doc: HashiCorp Terraform Version Compatibility Matrix #1969

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
4223529
HashiCorp Compatibility Matrix Updates
Zuhairahmed Feb 21, 2024
06bf2f8
Update README.md
Zuhairahmed Feb 21, 2024
86dc0ff
Update index.html.markdown
Zuhairahmed Feb 21, 2024
fd541a0
Update README.md
Zuhairahmed Feb 21, 2024
78e7124
Update index.html.markdown
Zuhairahmed Feb 21, 2024
d904874
Update index.html.markdown
Zuhairahmed Feb 21, 2024
cd51048
Update README.md
Zuhairahmed Feb 21, 2024
09997f0
Update index.html.markdown
Zuhairahmed Feb 21, 2024
8ea2bc5
Create 1.16.0-upgrade-guide.html.markdown
Zuhairahmed Feb 22, 2024
ade3d26
Update 1.16.0-upgrade-guide.html.markdown
Zuhairahmed Feb 22, 2024
b73dc35
Update website/docs/guides/1.16.0-upgrade-guide.html.markdown
Zuhairahmed Feb 22, 2024
ad5c36b
Update website/docs/index.html.markdown
Zuhairahmed Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,21 @@ Bugs should be filed under the Issues section of this repo.

Feature requests can be submitted at https://feedback.mongodb.com/forums/924145-atlas - just select the Terraform plugin as the category or vote for an already suggested feature.

## Requirements
- [Terraform Version](https://www.terraform.io/downloads.html) While we support minimum of HashiCorp Terraform version 1.0+ (as we have migrated to [Plugin Protocol Version 6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6)), for your safety we strongly recommend only consuming versions of Terraform that are currently receiving Security/Maintenance Updates. For latest Terraform versions see: https://endoflife.date/terraform
## Requirements
- [HashiCorp Terraform Version](https://www.terraform.io/downloads.html) Compatibility Matrix

| HashiCorp Terraform Release | HashiCorp Terraform Release Date | HashiCorp Terraform Full Support End Date | MongoDB Atlas Support End Date |
Copy link
Member

@lantoli lantoli Feb 21, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

i would probably have the table only in one place and make reference to it, e.g. to: https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

makes sense, updated

|:-------:|:------------:|:------------:|:------------:|
| 1.7.x | 2024-01-17 | 2026-01-31 | 2026-01-31 |
| 1.6.x | 2023-10-04 | 2025-10-31 | 2025-10-31 |
| 1.5.x | 2023-06-12 | 2025-06-30 | 2025-06-30 |
| 1.4.x | 2023-03-08 | 2025-03-31 | 2025-03-31 |
| 1.3.x | 2022-09-21 | 2024-09-30 | 2024-09-30 |
| 1.2.x | 2022-05-18 | 2024-05-31 | 2024-05-31 |

For the safety of our users, we require only consuming versions of HashiCorp Terraform that are currently receiving Security / Maintenance Updates. For more details see [Support Period and End-of-Life (EOL) Policy](https://support.hashicorp.com/hc/en-us/articles/360021185113-Support-Period-and-End-of-Life-EOL-Policy).
For latest HashiCorp Terraform versions see [here](https://endoflife.date/terraform ).

- [Go Version](https://golang.org/doc/install) 1.21 (to build the provider plugin)

## Using the Provider
Expand Down
20 changes: 13 additions & 7 deletions website/docs/index.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,13 +179,19 @@ In addition to [generic `provider` arguments](https://www.terraform.io/docs/conf

For more information on configuring and managing programmatic API Keys see the [MongoDB Atlas Documentation](https://docs.atlas.mongodb.com/tutorial/manage-programmatic-access/index.html).

## HashiCorp Terraform Version Requirement
| MongoDB Atlas Provider version | Required Terraform version |
| ------------- | ------------- |
| `1.12.0` and above | `1.0+` |
| below `1.12.0` | `0.13+` |

* While we support minimum of HashiCorp Terraform version 1.0+ (as we have migrated to [Plugin Protocol Version 6](https://developer.hashicorp.com/terraform/plugin/terraform-plugin-protocol#protocol-version-6)), for your safety we strongly recommend only consuming versions of Terraform that are currently receiving Security/Maintenance Updates. For latest Terraform versions see: https://endoflife.date/terraform
## [HashiCorp Terraform Version](https://www.terraform.io/downloads.html) Compatibility Matrix
Copy link
Member

Choose a reason for hiding this comment

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

my feeling is that this info is very below in the page but i suppose it doesn't fit more above

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

played around with the spacing, hope this helps with readability

Copy link
Collaborator

Choose a reason for hiding this comment

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

[q] do we plan to include a mention in our next release guide about the Compatibility matrix to notify users? Or would the changelog suffice?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Suggest we mention in both places with link to Terraform Docs. Added additional commit with updates to upcoming Upgrade Guide. ChangeLog will be pulled in automatically from the ChangeLog auto-generation, will also manually adjust as needed when we get there.


| HashiCorp Terraform Release | HashiCorp Terraform Release Date | HashiCorp Terraform Full Support End Date | MongoDB Atlas Support End Date |
|:-------:|:------------:|:------------:|:------------:|
| 1.7.x | 2024-01-17 | 2026-01-31 | 2026-01-31 |
| 1.6.x | 2023-10-04 | 2025-10-31 | 2025-10-31 |
| 1.5.x | 2023-06-12 | 2025-06-30 | 2025-06-30 |
| 1.4.x | 2023-03-08 | 2025-03-31 | 2025-03-31 |
| 1.3.x | 2022-09-21 | 2024-09-30 | 2024-09-30 |
| 1.2.x | 2022-05-18 | 2024-05-31 | 2024-05-31 |
marcosuma marked this conversation as resolved.
Show resolved Hide resolved

For the safety of our users, we require only consuming versions of HashiCorp Terraform that are currently receiving Security / Maintenance Updates. For more details see [Support Period and End-of-Life (EOL) Policy](https://support.hashicorp.com/hc/en-us/articles/360021185113-Support-Period-and-End-of-Life-EOL-Policy).
For latest HashiCorp Terraform versions see [here](https://endoflife.date/terraform ).
Zuhairahmed marked this conversation as resolved.
Show resolved Hide resolved

## Supported OS and Architectures
As per [HashiCorp's recommendations](https://developer.hashicorp.com/terraform/registry/providers/os-arch), we fully support the following operating system / architecture combinations:
Expand Down