-
Notifications
You must be signed in to change notification settings - Fork 178
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.
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
INTMDB-244: add deprecation notes for cloud backup documentation #525
Merged
Merged
Changes from 2 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
907f66f
fixed documentattion
abner-dou b6eb963
fix documentation
abner-dou 1ed843c
typo fix
abner-dou 9228e1b
changed examples in documentation
abner-dou f4b1e2d
added deprecated tags
abner-dou 5791079
fix conflicts
abner-dou b0759e1
docs: added other example for ldap configuration docs (#520)
coderGo93 dbe3848
fix documentation word in resources (#523)
abner-dou 2cc53dd
feat: use golangci lint action (#528)
gssbzn db6a250
task: remove misspell as a dependency (#527)
gssbzn c666b1c
task: check examples are formatted correctly (#529)
gssbzn 3f80892
INTMDB-236: Updated the cluster configuration (#526)
coderGo93 690f1ee
Merge branch 'master' into INTMDB-244
abner-dou dee2674
fix deprecated docs
abner-dou File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -38,7 +38,7 @@ resource "mongodbatlas_cluster" "cluster-test" { | |||||
read_only_nodes = 0 | ||||||
} | ||||||
} | ||||||
provider_backup_enabled = true | ||||||
cloud_backup = true | ||||||
auto_scaling_disk_gb_enabled = true | ||||||
mongo_db_major_version = "4.2" | ||||||
|
||||||
|
@@ -65,7 +65,7 @@ resource "mongodbatlas_cluster" "test" { | |||||
read_only_nodes = 0 | ||||||
} | ||||||
} | ||||||
provider_backup_enabled = true | ||||||
cloud_backup = true | ||||||
auto_scaling_disk_gb_enabled = true | ||||||
mongo_db_major_version = "4.2" | ||||||
|
||||||
|
@@ -92,7 +92,7 @@ resource "mongodbatlas_cluster" "test" { | |||||
read_only_nodes = 0 | ||||||
} | ||||||
} | ||||||
provider_backup_enabled = true | ||||||
cloud_backup = true | ||||||
auto_scaling_disk_gb_enabled = true | ||||||
mongo_db_major_version = "4.2" | ||||||
|
||||||
|
@@ -111,7 +111,7 @@ resource "mongodbatlas_cluster" "cluster-test" { | |||||
name = "cluster-test-multi-region" | ||||||
disk_size_gb = 100 | ||||||
num_shards = 1 | ||||||
provider_backup_enabled = true | ||||||
cloud_backup = true | ||||||
cluster_type = "REPLICASET" | ||||||
|
||||||
//Provider Settings "block" | ||||||
|
@@ -150,7 +150,7 @@ resource "mongodbatlas_cluster" "cluster-test" { | |||||
name = "cluster-test-global" | ||||||
disk_size_gb = 80 | ||||||
num_shards = 1 | ||||||
provider_backup_enabled = true | ||||||
cloud_backup = true | ||||||
cluster_type = "GEOSHARDED" | ||||||
|
||||||
//Provider Settings "block" | ||||||
|
@@ -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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I already fixed this :D |
||||||
* Setting this value to false to disable legacy backups for the cluster will let Atlas delete any stored snapshots. In order to preserve the legacy backups snapshots, disable the legacy backups and enable the cloud backups in the single **terraform apply** action. | ||||||
``` | ||||||
backup_enabled = "false" | ||||||
provider_backup_enabled = "true" | ||||||
cloud_backup = "true" | ||||||
``` | ||||||
* The default value is false. M10 and above only. | ||||||
|
||||||
|
@@ -307,10 +307,11 @@ But in order to explicitly change `provider_instance_size_name` comment the `lif | |||||
* `encryption_at_rest_provider` - (Optional) Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see [Encryption at Rest using Customer Key Management](https://docs.atlas.mongodb.com/security-aws-kms/) for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. **Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default**. | ||||||
* `mongo_db_major_version` - (Optional) Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: `3.6`, `4.0`, or `4.2`. You must set this value to `4.2` if `provider_instance_size_name` is either M2 or M5. | ||||||
* `num_shards` - (Optional) Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards. | ||||||
* `pit_enabled` - (Optional) - Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true. | ||||||
* `provider_backup_enabled` - (Optional) Flag indicating if the cluster uses Cloud Backup for backups. | ||||||
* `pit_enabled` - (Optional) - Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, cloud_backup must also be set to true. | ||||||
* `provider_backup_enabled` - (Optional) Flag indicating if the cluster uses Cloud Backup for backups. **Deprecated** use `cloud_backup` instead. | ||||||
* `cloud_backup` - (Optional) Flag indicating if the cluster uses Cloud Backup for backups. | ||||||
|
||||||
If true, the cluster uses Cloud Backup for backups. If provider_backup_enabled and backup_enabled are false, the cluster does not use Atlas backups. | ||||||
If true, the cluster uses Cloud Backup for backups. If cloud_backup and backup_enabled are false, the cluster does not use Atlas backups. | ||||||
|
||||||
You cannot enable cloud backup if you have an existing cluster in the project with legacy backup enabled. | ||||||
|
||||||
|
@@ -505,7 +506,7 @@ In addition to all arguments above, the following attributes are exported: | |||||
- REPAIRING | ||||||
|
||||||
### Cloud Backup Policy | ||||||
themantissa marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
Cloud Backup Policy will be added if provider_backup_enabled is enabled because MongoDB Atlas automatically creates a default policy, if not, returned values will be empty. | ||||||
Cloud Backup Policy will be added if provider_backup_enabled or cloud_backup is enabled because MongoDB Atlas automatically creates a default policy, if not, returned values will be empty. | ||||||
|
||||||
* `snapshot_backup_policy` - current snapshot schedule and retention settings for the cluster. | ||||||
|
||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this was a typo (autocomplete feature don't help me in this)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it seems its a typo, it should be
cloud_backup