Skip to content

Commit d3949bc

Browse files
doc: Adding guidance on pinning provider version in our index.md docs (#3640)
* Adding guidance on pinning provider version in our index.md docs * apply suggestion
1 parent 3242004 commit d3949bc

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/index.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@ The provider needs to be configured with the proper credentials before it can be
55

66
Use the navigation to the left to read about the available provider resources and data sources.
77

8-
You may want to consider pinning the [provider version](https://www.terraform.io/docs/configuration/providers.html#provider-versions) to ensure you have a chance to review and prepare for changes.
9-
Speaking of changes, see [CHANGELOG](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/CHANGELOG.md) for current version information.
10-
11-
For the best experience, we recommend using the latest [HashiCorp Terraform Core Version](https://github.com/hashicorp/terraform). For more details see [HashiCorp Terraform Version Compatibility Matrix](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs#hashicorp-terraform-versionhttpswwwterraformiodownloadshtml-compatibility-matrix).
8+
See [CHANGELOG](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/CHANGELOG.md) for current version information.
129

1310
## Example Usage
1411

@@ -20,6 +17,13 @@ provider "mongodbatlas" {
2017
}
2118
# Create the resources
2219
```
20+
21+
### Provider and terraform version constraints
22+
23+
We recommend that you pin your Atlas [provider version](https://developer.hashicorp.com/terraform/language/providers/requirements#version) to at least the [major version](#versioning-strategy) (e.g. `~> 2.0`) to avoid accidental upgrades to incompatible new versions. Starting on `2.0.0`, the [MongoDB Atlas Provider Versioning Policy](#mongodb-atlas-provider-versioning-policy) ensures that minor and patch versions do not include [Breaking Changes](#definition-of-breaking-changes).
24+
25+
For Terraform version, we recommend that you use the latest [HashiCorp Terraform Core Version](https://github.com/hashicorp/terraform). For more details see [HashiCorp Terraform Version Compatibility Matrix](#hashicorp-terraform-version-compatibility-matrix).
26+
2327
## Configure Atlas Programmatic Access
2428

2529
In order to set up authentication with the MongoDB Atlas provider, you must generate a programmatic API key for MongoDB Atlas with the appropriate [role](https://docs.atlas.mongodb.com/reference/user-roles/).

0 commit comments

Comments
 (0)