You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]>
Copy file name to clipboardExpand all lines: website/docs/guides/1.1.0-upgrade-guide.html.markdown
+45-28Lines changed: 45 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,73 +8,90 @@ MongoDB Atlas Provider 1.1.0: Upgrade and Information Guide
8
8
9
9
# MongoDB Atlas Provider 1.1.0: Upgrade and Information Guide
10
10
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.
12
12
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:
15
14
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).
17
23
18
-
## Migration from Cloud Provider Snapshot to Cloud Backup Snapshot
24
+
Changes:
19
25
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
### 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.
24
32
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.
27
34
28
-
```bash
29
-
$ terraform state rm mongodbatlas_cloud_provider_snapshot.test
30
-
```
35
+
## Migration from Cloud Provider Snapshot to Cloud Backup Snapshot
31
36
32
-
2. Change the version of providerto 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:
33
38
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
35
40
36
-
4. Perform an import of your existing `mongodbatlas_cloud_provider_snapshot` to `mongodbatlas_cloud_backup_snapshot`
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.
40
43
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.
42
47
43
48
```bash
44
49
terraform plan
45
50
46
51
(...)
47
52
48
-
49
53
No changes. Your infrastructure matches the configuration.
50
54
51
55
Terraform has compared your real infrastructure against your configuration and found no differences,
52
56
so no changes are needed.
53
57
```
54
58
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.
56
71
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`.
59
73
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`:
5. Run a `terraform plan` to ensure no changes are detected.
63
83
64
84
```bash
65
85
terraform plan
66
86
67
87
(...)
68
88
69
-
70
89
No changes. Your infrastructure matches the configuration.
71
90
72
91
Terraform has compared your real infrastructure against your configuration and found no differences,
73
92
so no changes are needed.
74
93
```
75
94
76
-
**NOTE** Doc links for [mongodbatlas_cloud_backup_snapshot](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/cloud_backup_snapshot)
Copy file name to clipboardExpand all lines: website/docs/index.html.markdown
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ description: |-
8
8
9
9
# MongoDB Atlas Provider
10
10
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).
12
12
The provider needs to be configured with the proper credentials before it can be used.
13
13
14
14
Use the navigation to the left to read about the available provider resources and data sources.
@@ -29,13 +29,16 @@ provider "mongodbatlas" {
29
29
30
30
## Configure Atlas Programmatic Access
31
31
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.
35
38
36
39
## Authenticate the Provider
37
40
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.
39
42
You can use any the following methods:
40
43
41
44
### Environment Variables
@@ -77,7 +80,7 @@ Consider the risks, especially the inadvertent submission of a configuration fil
77
80
78
81
## Argument Reference
79
82
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)
81
84
(e.g. `alias` and `version`), the MongoDB Atlas `provider` supports the following arguments:
82
85
83
86
*`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 [
104
107
105
108
## Examples from MongoDB and the Community
106
109
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)
108
111
in our GitHub repo that will help both beginner and more advanced users.
109
112
110
-
Have a good example you've created and want to share?
113
+
Have a good example you've created and want to share?
111
114
Let us know the details via an [issue](https://github.com/mongodb/terraform-provider-mongodbatlas/issues)
112
115
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/).
0 commit comments