Remove IOPS and adjust parameter description (#443)

Remove IOPS in examples as it's not needed and creating confusion. Also adjust parameter description to better express current state.
mongodb · Apr 22, 2021 · 3036569 · 3036569
1 parent 0b58372
commit 3036569
Show file tree

Hide file tree

Showing 11 changed files with 3 additions and 24 deletions.
diff --git a/website/docs/d/cloud_provider_snapshot_backup_policy.html.markdown b/website/docs/d/cloud_provider_snapshot_backup_policy.html.markdown
@@ -25,7 +25,6 @@ resource "mongodbatlas_cluster" "my_cluster" {
   provider_region_name        = "EU_CENTRAL_1"
   provider_instance_size_name = "M10"
   provider_backup_enabled     = true // enable cloud backup snapshots
-  provider_disk_iops          = 100
 }
 
 resource "mongodbatlas_cloud_provider_snapshot_backup_policy" "test" {

diff --git a/website/docs/d/cluster.html.markdown b/website/docs/d/cluster.html.markdown
@@ -38,8 +38,6 @@ resource "mongodbatlas_cluster" "test" {
 
   //Provider Settings "block"
   provider_name               = "AWS"
-  provider_disk_iops          = 300
-  provider_volume_type        = "STANDARD"
   provider_instance_size_name = "M40"
 }
 

diff --git a/website/docs/d/clusters.html.markdown b/website/docs/d/clusters.html.markdown
@@ -38,8 +38,6 @@ resource "mongodbatlas_cluster" "test" {
 
   //Provider Settings "block"
   provider_name               = "AWS"
-  provider_disk_iops          = 300
-  provider_volume_type        = "STANDARD"
   provider_instance_size_name = "M40"
 }
 

diff --git a/website/docs/d/global_cluster_config.html.markdown b/website/docs/d/global_cluster_config.html.markdown
@@ -26,7 +26,6 @@ description: |-
 
 		//Provider Settings "block"
 		provider_name               = "AWS"
-		provider_disk_iops          = 240
 		provider_instance_size_name = "M30"
 
 		replication_specs {

diff --git a/website/docs/d/ldap_verify.html.markdown b/website/docs/d/ldap_verify.html.markdown
@@ -31,7 +31,6 @@ resource "mongodbatlas_cluster" "test" {
   provider_region_name        = "US_EAST_2"
   provider_instance_size_name = "M10"
   provider_backup_enabled     = true //enable cloud provider snapshots
-  provider_disk_iops          = 100
   provider_encrypt_ebs_volume = false
 }
 

diff --git a/website/docs/r/cloud_provider_snapshot.html.markdown b/website/docs/r/cloud_provider_snapshot.html.markdown
@@ -26,7 +26,6 @@ On-demand snapshots happen immediately, unlike scheduled snapshots which occur a
     provider_region_name        = "EU_WEST_2"
     provider_instance_size_name = "M10"
     provider_backup_enabled     = true   // enable cloud backup snapshots
-    provider_disk_iops          = 3000
   }
 
   resource "mongodbatlas_cloud_provider_snapshot" "test" {

diff --git a/website/docs/r/cloud_provider_snapshot_backup_policy.html.markdown b/website/docs/r/cloud_provider_snapshot_backup_policy.html.markdown
@@ -28,7 +28,6 @@ resource "mongodbatlas_cluster" "my_cluster" {
   provider_region_name        = "EU_CENTRAL_1"
   provider_instance_size_name = "M10"
   provider_backup_enabled     = true // must be enabled in order to use cloud_provider_snapshot_backup_policy resource
-  provider_disk_iops          = 3000
 }
 
 resource "mongodbatlas_cloud_provider_snapshot_backup_policy" "test" {
@@ -94,7 +93,6 @@ resource "mongodbatlas_cluster" "my_cluster" {
   provider_region_name        = "EU_CENTRAL_1"
   provider_instance_size_name = "M10"
   provider_backup_enabled     = true // must be enabled in order to use cloud_provider_snapshot_backup_policy resource
-  provider_disk_iops          = 3000
 }
 
 resource "mongodbatlas_cloud_provider_snapshot_backup_policy" "test" {
@@ -162,7 +160,6 @@ resource "mongodbatlas_cluster" "my_cluster" {
   provider_region_name        = "EU_CENTRAL_1"
   provider_instance_size_name = "M10"
   provider_backup_enabled     = true // must be enabled in order to use cloud_provider_snapshot_backup_policy resource
-  provider_disk_iops          = 3000
 }
 
 resource "mongodbatlas_cloud_provider_snapshot_backup_policy" "test" {

diff --git a/website/docs/r/cloud_provider_snapshot_restore_job.html.markdown b/website/docs/r/cloud_provider_snapshot_restore_job.html.markdown
@@ -34,7 +34,6 @@ description: |-
     provider_region_name        = "EU_WEST_2"
     provider_instance_size_name = "M10"
     provider_backup_enabled     = true   // enable cloud backup snapshots
-    provider_disk_iops          = 3000
   }
 
   resource "mongodbatlas_cloud_provider_snapshot" "test" {
@@ -70,7 +69,6 @@ description: |-
     provider_region_name        = "EU_WEST_2"
     provider_instance_size_name = "M10"
     provider_backup_enabled     = true   // enable cloud backup snapshots
-    provider_disk_iops          = 3000
   }
 
   resource "mongodbatlas_cloud_provider_snapshot" "test" {

diff --git a/website/docs/r/cluster.html.markdown b/website/docs/r/cluster.html.markdown
@@ -45,8 +45,6 @@ resource "mongodbatlas_cluster" "cluster-test" {
   //Provider Settings "block"
   provider_name               = "AWS"
   disk_size_gb                = 100
-  provider_disk_iops         ops          = 300
-  provider_volume_type        = "STANDARD"
   provider_instance_size_name = "M40"
 }
 ```
@@ -118,8 +116,6 @@ resource "mongodbatlas_cluster" "cluster-test" {
 
   //Provider Settings "block"
   provider_name               = "AWS"
-  provider_disk_iops          = 3000
-  provider_volume_type        = "STANDARD"
   provider_instance_size_name = "M10"
 
   replication_specs {
@@ -159,8 +155,6 @@ resource "mongodbatlas_cluster" "cluster-test" {
 
   //Provider Settings "block"
   provider_name               = "AWS"
-  provider_disk_iops          = 3000
-  provider_volume_type        = "STANDARD"
   provider_instance_size_name = "M30"
 
   replication_specs {
@@ -303,12 +297,13 @@ But in order to explicitly change `provider_instance_size_name` comment the `lif
     - GCP - Google Cloud Platform
     - AZURE - Microsoft Azure
 
-* `provider_disk_iops` - (Optional) The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected `provider_instance_size_name` and `disk_size_gb`.
+* `provider_disk_iops` - (Optional - AWS Only) The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected `provider_instance_size_name` and `disk_size_gb`.  This setting requires that `provider_instance_size_name` to be M30 or greater and cannot be used with clusters with local NVMe SSDs.  The default value for `provider_disk_iops` is the same as the cluster tier's Standard IOPS value, as viewable in the Atlas console.  It is used in cases where a higher number of IOPS is needed and possible.  If a value is submitted that is lower or equal to the default IOPS value for the cluster tier Atlas ignores the requested value and uses the default.  More details available under the providerSettings.diskIOPS parameter: [MongoDB API Clusters](https://docs.atlas.mongodb.com/reference/api/clusters-create-one/)
+
 * `provider_disk_type_name` - (Optional - Azure Only) Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName.  Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB.  More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.
 * `provider_encrypt_ebs_volume` - **(Deprecated) The Flag is always true.** Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. **Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.**.
 * `provider_region_name` - (Optional) Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases.  Requires the **Atlas region name**, see the reference list for [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
     Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.
-* `provider_volume_type` - (AWS - Optional) The type of the volume. The possible values are: `STANDARD` and `PROVISIONED`.  `PROVISIONED` required if setting IOPS higher than the default instance IOPS.
+* `provider_volume_type` - (AWS - Optional) The type of the volume. The possible values are: `STANDARD` and `PROVISIONED`.  `PROVISIONED` is ONLY required if setting IOPS higher than the default instance IOPS.
 * `replication_factor` - (Deprecated) Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.
 * `provider_auto_scaling_compute_min_instance_size` - (Optional) Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if `autoScaling.compute.scaleDownEnabled` is `true`.
 * `provider_auto_scaling_compute_max_instance_size` - (Optional) Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if `autoScaling.compute.enabled` is `true`.

diff --git a/website/docs/r/global_cluster_config.html.markdown b/website/docs/r/global_cluster_config.html.markdown
@@ -29,7 +29,6 @@ description: |-
 
 		//Provider Settings "block"
 		provider_name               = "AWS"
-		provider_disk_iops          = 240
 		provider_instance_size_name = "M30"
 
 		replication_specs {
@@ -88,7 +87,6 @@ resource "mongodbatlas_cluster" "cluster-test" {
   //Provider Settings "block"
   provider_name               = "AWS"
   disk_size_gb                = 100
-  provider_disk_iops          = 3000
   provider_instance_size_name = "M40"
   provider_region_name        = "US_EAST_1"
 }

diff --git a/website/docs/r/ldap_verify.html.markdown b/website/docs/r/ldap_verify.html.markdown
@@ -28,7 +28,6 @@ resource "mongodbatlas_cluster" "test" {
     provider_region_name        = "US_EAST_2"
     provider_instance_size_name = "M10"
     provider_backup_enabled     = true //enable cloud provider snapshots
-    provider_disk_iops          = 3000
     provider_encrypt_ebs_volume = false
 }