Skip to content

Commit 28ffc56

Browse files
Guide and minor main page changes for 1.1.0 (#609)
* Guide and minor main page changes for 1.1.0 * spelling error * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/index.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/index.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/index.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> * Improves based on docs review Clarify the resources are deprecated and that they will be removed later. * Update website/docs/guides/1.1.0-upgrade-guide.html.markdown Co-authored-by: John Williams <[email protected]> Co-authored-by: John Williams <[email protected]>
1 parent 89a8b5f commit 28ffc56

File tree

2 files changed

+56
-37
lines changed

2 files changed

+56
-37
lines changed

website/docs/guides/1.1.0-upgrade-guide.html.markdown

Lines changed: 45 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,73 +8,90 @@ MongoDB Atlas Provider 1.1.0: Upgrade and Information Guide
88

99
# MongoDB Atlas Provider 1.1.0: Upgrade and Information Guide
1010

11-
The Terraform MongoDB Atlas Provider version 1.0.0 has a number of new and exciting features and changes.
11+
The Terraform MongoDB Atlas Provider version 1.1.0 has a number of new and exciting features and changes.
1212

13-
* Cloud Backup Snapshot replaces the now deprecated Cloud Provider Snapshot.
14-
* Cloud Backup Snapshot Restore Job replaces the now deprecated Cloud Provider Snapshot Restore Job.
13+
New Features:
1514

16-
1.1.0 also includes general improvements and bug fixes. See the [CHANGELOG](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/CHANGELOG.md) for more specific information.
15+
* You can now manage multi-cloud deployments with [`mongodbatlas_advanced_clusters`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/advanced_clusters).
16+
* You can now manage invitations with
17+
[`mongodbatlas_org_invitation`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/org_invitation) and [`mongodbatlas_project_invitation`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/project_invitation).
18+
* You can now use `project_owner_id` to set a default owner of projects that you create with [`mongodbatlas_project`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/project).
19+
* [`mongodbatlas_privatelink_endpoint`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/privatelink_endpoint) and [`mongodbatlas_privatelink_endpoint_service`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/privatelink_endpoint_service) now support private endpoints on Google Cloud with Private Service Connect.
20+
* You can now set `with_default_alerts_settings` to `false` to disable the default alerts when you create projects with [`mongodbatlas_project`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/project).
21+
* [`mongodbatlas_search_index`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/search_index) now supports synonyms.
22+
* You can now create Atlas Serverless deployments (available as a preview feature) with [`mongodbatlas_serverless_instance`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/serverless_instance).
1723

18-
## Migration from Cloud Provider Snapshot to Cloud Backup Snapshot
24+
Changes:
1925

20-
There are two possible options to upgrade from v1.0.2 to v1.1.0 from the existing resources `mongodbatlas_cloud_provider_snapshot_backup_policy` to the new ones
26+
Version 1.1.0 deprecates the following resources:
2127

28+
* [`mongodbatlas_cloud_provider_snapshot`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/cloud_provider_snapshot)
29+
* [`mongodbatlas_cloud_provider_snapshot_restore_job`](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/cloud_provider_snapshot_restore_job)
2230

23-
### Option 1: Remove the existing and import the new resource
31+
If your Terraform configuration uses these resources, see [Migration from Cloud Provider Snapshot to Cloud Backup Snapshot](#migration-from-cloud-provider-snapshot-to-cloud-backup-snapshot) to migrate to the new resources **before you upgrade**. These resources will be removed in a future major version.
2432

25-
1. Remove your existing `mongodbatlas_cloud_provider_snapshot` resources from terraform state
26-
**NOTE** before doing any terraform state change please do a backup
33+
1.1.0 also includes general improvements and bug fixes. See the [CHANGELOG](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/CHANGELOG.md) for more specific information.
2734

28-
```bash
29-
$ terraform state rm mongodbatlas_cloud_provider_snapshot.test
30-
```
35+
## Migration from Cloud Provider Snapshot to Cloud Backup Snapshot
3136

32-
2. Change the version of provider to the v1.1.0
37+
The term **Cloud Provider** has been deprecated in favor of the term **Cloud Backup**. In order to support this change within the Terraform provider, related resources and data sources with the older terminology have been deprecated and new resources and data sources have been added to support the new terminology. The deprecated resources and data sources will be removed in a future major version. We recommend migrating to the new resources as soon as possible by selecting a method from one of the following two options:
3338

34-
3. In order to import the new resource, you must first change your Terraform configuration file, replacing `mongodbatlas_cloud_provider_snapshot_backup_policy` with `mongodbatlas_cloud_backup_schedule`. See the example shared above or find more information in the [mongodbatlas_cloud_backup_schedule](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/cloud_backup_schedule)
39+
### Option 1: Replace the name of resource in Terraform state
3540

36-
4. Perform an import of your existing `mongodbatlas_cloud_provider_snapshot` to `mongodbatlas_cloud_backup_snapshot`
37-
```bash
38-
terraform import mongodbatlas_cloud_backup_snapshot.test <project_id>-<cluster_name>-<snapshot_id>
39-
```
41+
1. Replace the name of the deprecated resource `mongodbatlas_cloud_provider_snapshot` with the new name `mongodbatlas_cloud_backup_snapshot` in the Terraform state file (`terraform.tfstate`). Do the same for `mongodbatlas_cloud_provider_snapshot_restore_job` and `mongodbatlas_cloud_backup_snapshot_restore_job`.
42+
**NOTE** Before performing any Terraform state change, please backup your state.
4043

41-
5. Do a terraform plan (no changes detected)
44+
2. Upgrade the provider to v1.1.0.
45+
46+
3. Run a `terraform plan` to ensure no changes are detected.
4247

4348
```bash
4449
terraform plan
4550

4651
(...)
4752

48-
4953
No changes. Your infrastructure matches the configuration.
5054

5155
Terraform has compared your real infrastructure against your configuration and found no differences,
5256
so no changes are needed.
5357
```
5458

55-
### Option 2: Replace the name of resource in terraform state
59+
### Option 2: Remove the deprecated and import the new resources
60+
61+
1. Remove your existing `mongodbatlas_cloud_provider_snapshot` and `mongodbatlas_cloud_provider_snapshot_restore_job` resources from the Terraform state file.
62+
**NOTE** Before performing any Terraform state change, please backup your state.
63+
64+
```bash
65+
$ terraform state rm mongodbatlas_cloud_provider_snapshot.test
66+
$ terraform state rm mongodbatlas_cloud_provider_snapshot_restore_job.test
67+
68+
```
69+
70+
2. Upgrade the provider to v1.1.0.
5671

57-
1. Replace then name of the state in your existing `mongodbatlas_cloud_provider_snapshot` with `mongodbatlas_cloud_provider_snapshot` in terraform state file (`terraform.tfstate`).
58-
**NOTE** before doing any terraform state change please do a backup
72+
3. Change your Terraform configuration file, replacing `mongodbatlas_cloud_provider_snapshot` with `mongodbatlas_cloud_backup_snapshot` and `mongodbatlas_cloud_provider_snapshot_restore_job` with `mongodbatlas_cloud_backup_snapshot_restore_job`.
5973

60-
2. Change the version of provider to the v1.1.0
74+
4. Import your existing `mongodbatlas_cloud_provider_snapshot` to `mongodbatlas_cloud_backup_snapshot` and `mongodbatlas_cloud_provider_snapshot_restore_job` to `mongodbatlas_cloud_backup_snapshot_restore_job`:
75+
```bash
76+
terraform import mongodbatlas_cloud_backup_snapshot.test <project_id>-<cluster_name>-<snapshot_id>
77+
```
78+
```bash
79+
terraform import mongodbatlas_cloud_backup_snapshot_restore_job.test <project_id>-<cluster_name>-<job_id>
80+
```
6181

62-
3. Do a terraform plan (no changes detected)
82+
5. Run a `terraform plan` to ensure no changes are detected.
6383

6484
```bash
6585
terraform plan
6686

6787
(...)
6888

69-
7089
No changes. Your infrastructure matches the configuration.
7190

7291
Terraform has compared your real infrastructure against your configuration and found no differences,
7392
so no changes are needed.
7493
```
7594

76-
**NOTE** Doc links for [mongodbatlas_cloud_backup_snapshot](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/cloud_backup_snapshot)
77-
7895
### Helpful Links
7996

8097
* [Report bugs](https://github.com/mongodb/terraform-provider-mongodbatlas/issues)

website/docs/index.html.markdown

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: |-
88

99
# MongoDB Atlas Provider
1010

11-
You can use the MongoDB Atlas provider to interact with the resources supported by [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
11+
You can use the MongoDB Atlas provider to interact with the resources supported by [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
1212
The provider needs to be configured with the proper credentials before it can be used.
1313

1414
Use the navigation to the left to read about the available provider resources and data sources.
@@ -29,13 +29,16 @@ provider "mongodbatlas" {
2929

3030
## Configure Atlas Programmatic Access
3131

32-
In order to set up authentication with the MongoDB Atlas provider a programmatic API key must be generated for MongoDB Atlas with the appropriate permissions and IP access list entries.
33-
The [MongoDB Atlas documentation](https://docs.atlas.mongodb.com/tutorial/manage-programmatic-access/index.html) contains the most up-to-date instructions for creating and managing your key(s) and IP access.
34-
Be aware, not all API resources require an IP access list by default, but one can set Atlas to require IP access entries for all API resources, see the [organization settings documentation](https://docs.atlas.mongodb.com/tutorial/manage-organization-settings/#require-ip-access-list-for-public-api) for more info.
32+
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/) and IP access list entries.
33+
The [MongoDB Atlas documentation](https://docs.atlas.mongodb.com/tutorial/manage-programmatic-access/index.html) contains the most up-to-date instructions for creating and managing your key(s), setting the appropriate role, and IP access.
34+
35+
**Role**: If unsure of which role level to grant your key, we suggest creating an organization API Key with an Organization Owner role. This ensures that you have sufficient access for all actions.
36+
37+
**IP access list**: Some API resources, such as backup resources, require an IP access list by default. We highly suggest that you add an IP access list as soon as possible. See [Require IP Access List for Public API](https://docs.atlas.mongodb.com/tutorial/manage-organization-settings/#require-ip-access-list-for-public-api) for more info.
3538

3639
## Authenticate the Provider
3740

38-
The MongoDB Atlas provider offers a flexible means of providing credentials for authentication.
41+
The MongoDB Atlas provider offers a flexible means of providing credentials for authentication.
3942
You can use any the following methods:
4043

4144
### Environment Variables
@@ -77,7 +80,7 @@ Consider the risks, especially the inadvertent submission of a configuration fil
7780

7881
## Argument Reference
7982

80-
In addition to [generic `provider` arguments](https://www.terraform.io/docs/configuration/providers.html)
83+
In addition to [generic `provider` arguments](https://www.terraform.io/docs/configuration/providers.html)
8184
(e.g. `alias` and `version`), the MongoDB Atlas `provider` supports the following arguments:
8285

8386
* `public_key` - (Optional) This is the public key of your MongoDB Atlas API key pair. It must be
@@ -104,10 +107,9 @@ For more information on configuring and managing programmatic API Keys see the [
104107

105108
## Examples from MongoDB and the Community
106109

107-
We have [example configurations](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples)
110+
We have [example configurations](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples)
108111
in our GitHub repo that will help both beginner and more advanced users.
109112

110-
Have a good example you've created and want to share?
113+
Have a good example you've created and want to share?
111114
Let us know the details via an [issue](https://github.com/mongodb/terraform-provider-mongodbatlas/issues)
112115
or submit a PR of your work to add it to the `examples` directory in our [GitHub repo](https://github.com/mongodb/terraform-provider-mongodbatlas/).
113-

0 commit comments

Comments
 (0)