Skip to content

Commit

Permalink
INTMDB-244: add deprecation notes for cloud backup documentation (#525)
Browse files Browse the repository at this point in the history
* fixed documentattion

* fix documentation

* typo fix

* changed examples in documentation

* added deprecated tags

* fix conflicts

* docs: added other example for ldap configuration docs (#520)

Co-authored-by: Edgar Lopez <edgarlopez@pop-os.localdomain>

* fix documentation word in resources (#523)

* feat: use golangci lint action (#528)

* task: remove misspell as a dependency (#527)

* task: check examples are formatted correctly (#529)

* INTMDB-236: Updated the cluster configuration (#526)

* refactor: refactorized the examples for the cluster in tests/docs/examples

* comment

Co-authored-by: Edgar Lopez <edgarlopez@pop-os.localdomain>

* fix deprecated docs

Co-authored-by: Edgar López <edgars.ealo@gmail.com>
Co-authored-by: Edgar Lopez <edgarlopez@pop-os.localdomain>
Co-authored-by: Gustavo Bazan <gssbzn@gmail.com>
  • Loading branch information
4 people committed Aug 26, 2021
1 parent 25f43db commit 5ab41cc
Show file tree
Hide file tree
Showing 11 changed files with 54 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ description: |-
Provides a Cloud Backup Snapshot Policy Datasource.
---


**WARNING:** This data source is deprecated, use `mongodbatlas_cloud_backup_schedule`

# mongodbatlas_cloud_provider_snapshot_backup_policy

`mongodbatlas_cloud_provider_snapshot_backup_policy` provides a Cloud Backup Snapshot Backup Policy datasource. An Atlas Cloud Backup Snapshot Policy provides the current snapshot schedule and retention settings for the cluster.
Expand Down
16 changes: 13 additions & 3 deletions website/docs/d/cluster.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ resource "mongodbatlas_cluster" "test" {
read_only_nodes = 0
}
}
provider_backup_enabled = true
cloud_backup = true
auto_scaling_disk_gb_enabled = true
//Provider Settings "block"
Expand All @@ -57,7 +57,7 @@ data "mongodbatlas_cluster" "test" {
In addition to all arguments above, the following attributes are exported:

* `id` - The cluster ID.
* `mongo_db_version` - Version of MongoDB the cluster runs, in `major-version`.`minor-version` format.
* `mongo_db_version` - Version of MongoDB the cluster runs, in `major-version`.`minor-version` format.
* `mongo_uri` - Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
* `mongo_uri_updated` - Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
* `mongo_uri_with_options` - Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
Expand Down Expand Up @@ -102,7 +102,8 @@ In addition to all arguments above, the following attributes are exported:
* `name` - Name of the cluster as it appears in Atlas.
* `mongo_db_major_version` - Indicates the version of the cluster to deploy.
* `num_shards` - Indicates whether the cluster is a replica set or a sharded cluster.
* `provider_backup_enabled` - Flag indicating if the cluster uses Cloud Backup Snapshots for backups.
* `provider_backup_enabled` - **(DEPRECATED)** Flag indicating if the cluster uses Cloud Backup Snapshots for backups.
* `cloud_backup` - Flag indicating if the cluster uses Cloud Backup Snapshots for backups.
* `provider_instance_size_name` - Atlas provides different instance sizes, each with a default storage capacity and RAM size.
* `provider_name` - Indicates the cloud service provider on which the servers are provisioned.
* `backing_provider_name` - Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.
Expand Down Expand Up @@ -160,6 +161,9 @@ Contains a key-value pair that tags that the cluster was created by a Terraform
* `version` - The current version of the plugin.

### Cloud Provider Snapshot Backup Policy

**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` datasource instead.

* `snapshot_backup_policy` - current snapshot schedule and retention settings for the cluster.

* `snapshot_backup_policy.#.cluster_id` - Unique identifier of the Atlas cluster.
Expand All @@ -171,10 +175,16 @@ Contains a key-value pair that tags that the cluster was created by a Terraform
* `snapshot_backup_policy.#.update_snapshots` - Specifies it's true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

### Policies

**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` datasource instead.

* `snapshot_backup_policy.#.policies` - A list of policy definitions for the cluster.
* `snapshot_backup_policy.#.policies.#.id` - Unique identifier of the backup policy.

#### Policy Item

**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` datasource instead.

* `snapshot_backup_policy.#.policies.#.policy_item` - A list of specifications for a policy.
* `snapshot_backup_policy.#.policies.#.policy_item.#.id` - Unique identifier for this policy item.
* `snapshot_backup_policy.#.policies.#.policy_item.#.frequency_interval` - The frequency interval for a set of snapshots.
Expand Down
13 changes: 10 additions & 3 deletions website/docs/d/clusters.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ resource "mongodbatlas_cluster" "test" {
read_only_nodes = 0
}
}
provider_backup_enabled = true
cloud_backup = true
auto_scaling_disk_gb_enabled = true
//Provider Settings "block"
Expand All @@ -60,7 +60,7 @@ In addition to all arguments above, the following attributes are exported:
### Cluster

* `name` - Name of the cluster as it appears in Atlas.
* `mongo_db_version` - Version of MongoDB the cluster runs, in `major-version`.`minor-version` format.
* `mongo_db_version` - Version of MongoDB the cluster runs, in `major-version`.`minor-version` format.
* `mongo_uri` - Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.
* `mongo_uri_updated` - Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.
* `mongo_uri_with_options` - Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.
Expand Down Expand Up @@ -103,7 +103,8 @@ In addition to all arguments above, the following attributes are exported:
* `encryption_at_rest_provider` - Indicates whether Encryption at Rest is enabled or disabled.
* `mongo_db_major_version` - Indicates the version of the cluster to deploy.
* `num_shards` - Indicates whether the cluster is a replica set or a sharded cluster.
* `provider_backup_enabled` - Flag indicating if the cluster uses Cloud Backup Snapshots for backups.
* `provider_backup_enabled` - Flag indicating if the cluster uses Cloud Backup Snapshots for backups. **DEPRECATED** Use `cloud_backup` instead.
* `cloud_backup` - Flag indicating if the cluster uses Cloud Backup Snapshots for backups.
* `provider_instance_size_name` - Atlas provides different instance sizes, each with a default storage capacity and RAM size.
* `provider_name` - Indicates the cloud service provider on which the servers are provisioned.
* `backing_provider_name` - Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.
Expand Down Expand Up @@ -165,6 +166,8 @@ Contains a key-value pair that tags that the cluster was created by a Terraform
* `version` - The current version of the plugin.

### Cloud Provider Snapshot Backup Policy
**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` datasource instead.

* `snapshot_backup_policy` - current snapshot schedule and retention settings for the cluster.

* `snapshot_backup_policy.#.cluster_id` - Unique identifier of the Atlas cluster.
Expand All @@ -176,10 +179,14 @@ Contains a key-value pair that tags that the cluster was created by a Terraform
* `snapshot_backup_policy.#.update_snapshots` - Specifies it's true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

### Policies
**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` datasource instead.

* `snapshot_backup_policy.#.policies` - A list of policy definitions for the cluster.
* `snapshot_backup_policy.#.policies.#.id` - Unique identifier of the backup policy.

#### Policy Item
**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` datasource instead.

* `snapshot_backup_policy.#.policies.#.policy_item` - A list of specifications for a policy.
* `snapshot_backup_policy.#.policies.#.policy_item.#.id` - Unique identifier for this policy item.
* `snapshot_backup_policy.#.policies.#.policy_item.#.frequency_interval` - The frequency interval for a set of snapshots.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/global_cluster_config.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ description: |-
project_id = "<YOUR-PROJECT-ID>"
name = "<CLUSTER-NAME>"
disk_size_gb = 80
provider_backup_enabled = true
cloud_backup = true
cluster_type = "GEOSHARDED"
//Provider Settings "block"
Expand Down
2 changes: 1 addition & 1 deletion website/docs/d/ldap_verify.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ resource "mongodbatlas_cluster" "test" {
provider_name = "AWS"
provider_region_name = "US_EAST_2"
provider_instance_size_name = "M10"
provider_backup_enabled = true //enable cloud provider snapshots
cloud_backup = true //enable cloud provider snapshots
}
resource "mongodbatlas_ldap_verify" "test" {
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/cloud_provider_snapshot.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ On-demand snapshots happen immediately, unlike scheduled snapshots which occur a
provider_name = "AWS"
provider_region_name = "EU_WEST_2"
provider_instance_size_name = "M10"
provider_backup_enabled = true // enable cloud backup snapshots
cloud_backup = true // enable cloud backup snapshots
}
resource "mongodbatlas_cloud_provider_snapshot" "test" {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ description: |-
Provides a Cloud Backup Snapshot Policy resource.
---

**WARNING:** This resource is deprecated, use `mongodbatlas_cloud_backup_schedule`

# mongodbatlas_cloud_provider_snapshot_backup_policy

`mongodbatlas_cloud_provider_snapshot_backup_policy` provides a resource that enables you to view and modify the snapshot schedule and retention settings for an Atlas cluster with Cloud Backup enabled. A default policy is created automatically when Cloud Backup is enabled for the cluster.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ description: |-
provider_name = "AWS"
provider_region_name = "EU_WEST_2"
provider_instance_size_name = "M10"
provider_backup_enabled = true // enable cloud backup snapshots
cloud_backup = true // enable cloud backup snapshots
}
resource "mongodbatlas_cloud_provider_snapshot" "test" {
Expand Down Expand Up @@ -68,7 +68,7 @@ description: |-
provider_name = "AWS"
provider_region_name = "EU_WEST_2"
provider_instance_size_name = "M10"
provider_backup_enabled = true // enable cloud backup snapshots
cloud_backup = true // enable cloud backup snapshots
}
resource "mongodbatlas_cloud_provider_snapshot" "test" {
Expand Down
30 changes: 19 additions & 11 deletions website/docs/r/cluster.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand All @@ -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"
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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.
* 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.
* 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.

Expand All @@ -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.

Expand Down Expand Up @@ -505,7 +506,10 @@ In addition to all arguments above, the following attributes are exported:
- REPAIRING

### Cloud Backup Policy
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.

**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` resource instead.

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.

Expand All @@ -518,10 +522,14 @@ Cloud Backup Policy will be added if provider_backup_enabled is enabled because
* `snapshot_backup_policy.#.update_snapshots` - Specifies it's true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

### Policies
**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` resource instead.

* `snapshot_backup_policy.#.policies` - A list of policy definitions for the cluster.
* `snapshot_backup_policy.#.policies.#.id` - Unique identifier of the backup policy.

#### Policy Item
**WARNING:** This property is deprecated, use `mongodbatlas_cloud_backup_schedule` resource instead.

* `snapshot_backup_policy.#.policies.#.policy_item` - A list of specifications for a policy.
* `snapshot_backup_policy.#.policies.#.policy_item.#.id` - Unique identifier for this policy item.
* `snapshot_backup_policy.#.policies.#.policy_item.#.frequency_interval` - The frequency interval for a set of snapshots.
Expand Down
3 changes: 1 addition & 2 deletions website/docs/r/global_cluster_config.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ description: |-
project_id = "<YOUR-PROJECT-ID>"
name = "<CLUSTER-NAME>"
disk_size_gb = 80
backup_enabled = false
provider_backup_enabled = true
cloud_backup = true
cluster_type = "GEOSHARDED"
//Provider Settings "block"
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/ldap_verify.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ resource "mongodbatlas_cluster" "test" {
provider_name = "AWS"
provider_region_name = "US_EAST_2"
provider_instance_size_name = "M10"
provider_backup_enabled = true //enable cloud provider snapshots
cloud_backup = true //enable cloud provider snapshots
}
resource "mongodbatlas_ldap_verify" "test" {
Expand Down

0 comments on commit 5ab41cc

Please sign in to comment.