INTMDB-244: add deprecation notes for cloud backup documentation #525
Conversation
themantissa
requested review from
a team and
gssbzn
and removed request for
a team
website/docs/d/cluster.html.markdown
Outdated
| @@ -33,7 +33,7 @@ resource "mongodbatlas_cluster" "test" { | |||
| read_only_nodes = 0 | |||
| } | |||
| } | |||
| provider_backup_enabled = true | |||
| cloud_backup_config = true | |||
There was a problem hiding this comment.
Which is it? In @coderGo93's add to the guide it states:
IMPORTANT In resource mongodbatlas_cluster the parameter provider_backup_enabled has been deprecated, use cloud_backup instead.
Now this has cloud_backup_config. Looks like cloud_backup: https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/mongodbatlas/resource_mongodbatlas_cluster.go#L151. Looking at rest maybe a typo?
There was a problem hiding this comment.
this was a typo (autocomplete feature don't help me in this)
There was a problem hiding this comment.
Yes, it seems its a typo, it should be cloud_backup
website/docs/r/cluster.html.markdown
Outdated
| @@ -279,11 +279,11 @@ But in order to explicitly change `provider_instance_size_name` comment the `lif | |||
|
|
|||
| * `backup_enabled` - (Optional) Legacy Backup - Set to true to enable Atlas legacy backups for the cluster. | |||
| **Important** - MongoDB deprecated the Legacy Backup feature. Clusters that use Legacy Backup can continue to use it. MongoDB recommends using [Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/). | |||
| * Any net new Atlas clusters of any type do not support this parameter. These clusters must use Cloud Backup, `provider_backup_enabled`, to enable Cloud Backup. If you create a new Atlas cluster and set `backup_enabled` to true, the Provider will respond with an error. This change doesn’t affect existing clusters that use legacy backups. | |||
| * Any net new Atlas clusters of any type do not support this parameter. These clusters must use Cloud Backup, `cloud_backup`, to enable Cloud Backup. If you create a new Atlas cluster and set `backup_enabled` to true, the Provider will respond with an error. This change doesn’t affect existing clusters that use legacy backups. | |||
There was a problem hiding this comment.
| * Any net new Atlas clusters of any type do not support this parameter. These clusters must use Cloud Backup, `cloud_backup`, to enable Cloud Backup. If you create a new Atlas cluster and set `backup_enabled` to true, the Provider will respond with an error. This change doesn’t affect existing clusters that use legacy backups. | |
| * New Atlas clusters of any type do not support this parameter. These clusters must use Cloud Backup, `cloud_backup`, to enable Cloud Backup. If you create a new Atlas cluster and set `backup_enabled` to true, the Provider will respond with an error. This change doesn’t affect existing clusters that use legacy backups. |
There was a problem hiding this comment.
I already fixed this :D
There was a problem hiding this comment.
From my side LGTM with one small improvement to the copy, @themantissa point may still need to be addressed but I also don't have full context here
Co-authored-by: Edgar Lopez <[email protected]>
* refactor: refactorized the examples for the cluster in tests/docs/examples * comment Co-authored-by: Edgar Lopez <[email protected]>
|
@themantissa this PR is ready to merge :) |
Description
Marked some resources and datasources as deprecated, also cluster documentation was updated
Link to any related issue(s):
Type of change:
Required Checklist:
Further comments