fix: add fix for autoscale bug (#163)

ocofaigh · web-flow · commit 7998349e80b4 · 2023-05-19T16:08:48.000+01:00
diff --git a/README.md b/README.md
@@ -38,8 +38,8 @@ You need the following permissions to run this module.
 ## Examples
 
 - [ Basic example](examples/basic)
-- [ Complete example with encryption, autoscaling, and CBR rules](examples/complete)
-- [ Financial Services Cloud profile example](examples/fscloud)
+- [ Complete example with BYOK encryption and CBR rules](examples/complete)
+- [ Financial Services Cloud profile example with autoscaling enabled](examples/fscloud)
 <!-- END EXAMPLES HOOK -->
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ## Requirements
@@ -67,7 +67,7 @@ You need the following permissions to run this module.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_auto_scaling"></a> [auto\_scaling](#input\_auto\_scaling) | Optional rules to allow the database to increase resources in response to usage. Only a single autoscaling block is allowed. Make sure you understand the effects of autoscaling, especially for production environments. See https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-autoscaling&interface=cli#autoscaling-considerations in the IBM Cloud Docs. | <pre>object({<br>    cpu = object({<br>      rate_increase_percent       = optional(number, 10)<br>      rate_limit_count_per_member = optional(number, 30)<br>      rate_period_seconds         = optional(number, 900)<br>      rate_units                  = optional(string, "count")<br>    })<br>    disk = object({<br>      capacity_enabled             = optional(bool, false)<br>      free_space_less_than_percent = optional(number, 10)<br>      io_above_percent             = optional(number, 90)<br>      io_enabled                   = optional(bool, false)<br>      io_over_period               = optional(string, "15m")<br>      rate_increase_percent        = optional(number, 10)<br>      rate_limit_mb_per_member     = optional(number, 3670016)<br>      rate_period_seconds          = optional(number, 900)<br>      rate_units                   = optional(string, "mb")<br>    })<br>    memory = object({<br>      io_above_percent         = optional(number, 90)<br>      io_enabled               = optional(bool, false)<br>      io_over_period           = optional(string, "15m")<br>      rate_increase_percent    = optional(number, 10)<br>      rate_limit_mb_per_member = optional(number, 114688)<br>      rate_period_seconds      = optional(number, 900)<br>      rate_units               = optional(string, "mb")<br>    })<br>  })</pre> | `null` | no |
+| <a name="input_auto_scaling"></a> [auto\_scaling](#input\_auto\_scaling) | Optional rules to allow the database to increase resources in response to usage. Only a single autoscaling block is allowed. Make sure you understand the effects of autoscaling, especially for production environments. See https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-autoscaling&interface=cli#autoscaling-considerations in the IBM Cloud Docs. | <pre>object({<br>    disk = object({<br>      capacity_enabled             = optional(bool, false)<br>      free_space_less_than_percent = optional(number, 10)<br>      io_above_percent             = optional(number, 90)<br>      io_enabled                   = optional(bool, false)<br>      io_over_period               = optional(string, "15m")<br>      rate_increase_percent        = optional(number, 10)<br>      rate_limit_mb_per_member     = optional(number, 3670016)<br>      rate_period_seconds          = optional(number, 900)<br>      rate_units                   = optional(string, "mb")<br>    })<br>    memory = object({<br>      io_above_percent         = optional(number, 90)<br>      io_enabled               = optional(bool, false)<br>      io_over_period           = optional(string, "15m")<br>      rate_increase_percent    = optional(number, 10)<br>      rate_limit_mb_per_member = optional(number, 114688)<br>      rate_period_seconds      = optional(number, 900)<br>      rate_units               = optional(string, "mb")<br>    })<br>  })</pre> | `null` | no |
 | <a name="input_backup_encryption_key_crn"></a> [backup\_encryption\_key\_crn](#input\_backup\_encryption\_key\_crn) | The CRN of a Key Protect key that you want to use for encrypting the disk that holds deployment backups. Only used if var.kms\_encryption\_enabled is set to true. BYOK for backups is available only in US regions us-south and us-east, and in eu-de. Only keys in the us-south and eu-de are durable to region failures. To ensure that your backups are available even if a region failure occurs, use a key from us-south or eu-de. Hyper Protect Crypto Services for IBM Cloud Databases backups is not currently supported. If no value is passed here, the value passed for the 'kms\_key\_crn' variable is used. And if a HPCS value is passed for var.kms\_key\_crn, the database backup encryption uses the default encryption keys. | `string` | `null` | no |
 | <a name="input_cbr_rules"></a> [cbr\_rules](#input\_cbr\_rules) | (Optional, list) List of CBR rules to create | <pre>list(object({<br>    description = string<br>    account_id  = string<br>    rule_contexts = list(object({<br>      attributes = optional(list(object({<br>        name  = string<br>        value = string<br>    }))) }))<br>    enforcement_mode = string<br>  }))</pre> | `[]` | no |
 | <a name="input_configuration"></a> [configuration](#input\_configuration) | Database Configuration. | <pre>object({<br>    maxmemory                   = optional(number)<br>    maxmemory-policy            = optional(string)<br>    appendonly                  = optional(string)<br>    maxmemory-samples           = optional(number)<br>    stop-writes-on-bgsave-error = optional(string)<br>  })</pre> | `null` | no |
diff --git a/examples/complete/README.md b/examples/complete/README.md
@@ -1,10 +1,10 @@
-# Complete example with encryption, autoscaling, and CBR rules
+# Complete example with BYOK encryption and CBR rules
 
 An end-to-end example that uses the IBM Cloud Terraform provider to create the following infrastructure:
 
 - A resource group, if one is not passed in.
 - A Key Protect instance with a root key.
-- An instance of Databases for MongoDB with BYOK encryption and autoscaling enabled (automatically increases resources).
+- An instance of Databases for MongoDB with BYOK encryption.
 - Service credentials for the database instance.
 - A sample virtual private cloud (VPC).
 - A context-based restriction (CBR) rule to only allow MongoDB to be accessible from within the VPC.
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
@@ -76,7 +76,6 @@ module "mongodb" {
   region                     = var.region
   kms_key_crn                = module.key_protect_all_inclusive.keys["icd.${var.prefix}-mongodb"].crn
   tags                       = var.resource_tags
-  auto_scaling               = var.auto_scaling
   service_credential_names   = var.service_credential_names
   cbr_rules = [
     {
diff --git a/examples/complete/variables.tf b/examples/complete/variables.tf
@@ -44,45 +44,3 @@ variable "service_credential_names" {
     "mongodb_viewer" : "Editor",
   }
 }
-
-variable "auto_scaling" {
-  type = object({
-    cpu = object({
-      rate_increase_percent       = optional(number)
-      rate_limit_count_per_member = optional(number)
-      rate_period_seconds         = optional(number)
-      rate_units                  = optional(string)
-    })
-    disk = object({
-      capacity_enabled             = optional(bool)
-      free_space_less_than_percent = optional(number)
-      io_above_percent             = optional(number)
-      io_enabled                   = optional(bool)
-      io_over_period               = optional(string)
-      rate_increase_percent        = optional(number)
-      rate_limit_mb_per_member     = optional(number)
-      rate_period_seconds          = optional(number)
-      rate_units                   = optional(string)
-    })
-    memory = object({
-      io_above_percent         = optional(number)
-      io_enabled               = optional(bool)
-      io_over_period           = optional(string)
-      rate_increase_percent    = optional(number)
-      rate_limit_mb_per_member = optional(number)
-      rate_period_seconds      = optional(number)
-      rate_units               = optional(string)
-    })
-  })
-  description = "Optional rules to allow the database to increase resources in response to usage. Only a single autoscaling block is allowed. Make sure you understand the effects of autoscaling, especially for production environments. See https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-autoscaling&interface=cli#autoscaling-considerations in the IBM Cloud Docs."
-  default = {
-    cpu = {}
-    disk = {
-      capacity_enabled : true,
-      io_enabled : true
-    }
-    memory = {
-      io_enabled : true,
-    }
-  }
-}
diff --git a/examples/fscloud/README.md b/examples/fscloud/README.md
@@ -1,4 +1,4 @@
-# Financial Services Cloud profile example
+# Financial Services Cloud profile example with autoscaling enabled
 
 An end-to-end example that uses the [Profile for IBM Cloud Framework for Financial Services](../../profiles/fscloud/) to deploy an instance of IBM Cloud Databases for MongoDB.
 
@@ -7,6 +7,7 @@ The example uses the IBM Cloud Terraform provider to create the following infras
 - A resource group, if one is not passed in.
 - An IAM authorization between all MongoDB database instances in the given resource group, and the Hyper Protect Crypto Services instance that is passed in.
 - An IBM Cloud Databases MongoDB database instance that is encrypted with the Hyper Protect Crypto Services root key that is passed in.
+- Autoscaling rules for the IBM Cloud Databases MongoDB database instance.
 - Service Credentials for the MongoDB database instance.
 - A sample virtual private cloud (VPC).
 - A context-based restriction (CBR) rule to only allow MongoDB to be accessible from within the VPC.
diff --git a/examples/fscloud/main.tf b/examples/fscloud/main.tf
@@ -61,6 +61,7 @@ module "mongodb" {
   existing_kms_instance_guid = var.existing_kms_instance_guid
   mongodb_version            = var.mongodb_version
   service_credential_names   = var.service_credential_names
+  auto_scaling               = var.auto_scaling
   cbr_rules = [
     {
       description      = "${var.prefix}-mongodb access only from vpc"
diff --git a/examples/fscloud/variables.tf b/examples/fscloud/variables.tf
@@ -54,3 +54,38 @@ variable "service_credential_names" {
     "mongodb_editor" : "Editor",
   }
 }
+
+variable "auto_scaling" {
+  type = object({
+    disk = object({
+      capacity_enabled             = optional(bool)
+      free_space_less_than_percent = optional(number)
+      io_above_percent             = optional(number)
+      io_enabled                   = optional(bool)
+      io_over_period               = optional(string)
+      rate_increase_percent        = optional(number)
+      rate_limit_mb_per_member     = optional(number)
+      rate_period_seconds          = optional(number)
+      rate_units                   = optional(string)
+    })
+    memory = object({
+      io_above_percent         = optional(number)
+      io_enabled               = optional(bool)
+      io_over_period           = optional(string)
+      rate_increase_percent    = optional(number)
+      rate_limit_mb_per_member = optional(number)
+      rate_period_seconds      = optional(number)
+      rate_units               = optional(string)
+    })
+  })
+  description = "Optional rules to allow the database to increase resources in response to usage. Only a single autoscaling block is allowed. Make sure you understand the effects of autoscaling, especially for production environments. See https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-autoscaling&interface=cli#autoscaling-considerations in the IBM Cloud Docs."
+  default = {
+    disk = {
+      capacity_enabled : true,
+      io_enabled : true
+    }
+    memory = {
+      io_enabled : true,
+    }
+  }
+}
diff --git a/main.tf b/main.tf
@@ -75,12 +75,6 @@ resource "ibm_database" "mongodb" {
   dynamic "auto_scaling" {
     for_each = local.auto_scaling_enabled
     content {
-      cpu {
-        rate_increase_percent       = var.auto_scaling.cpu.rate_increase_percent
-        rate_limit_count_per_member = var.auto_scaling.cpu.rate_limit_count_per_member
-        rate_period_seconds         = var.auto_scaling.cpu.rate_period_seconds
-        rate_units                  = var.auto_scaling.cpu.rate_units
-      }
       disk {
         capacity_enabled             = var.auto_scaling.disk.capacity_enabled
         free_space_less_than_percent = var.auto_scaling.disk.free_space_less_than_percent
diff --git a/module-metadata.json b/module-metadata.json
@@ -3,7 +3,7 @@
   "variables": {
     "auto_scaling": {
       "name": "auto_scaling",
-      "type": "object({\n    cpu = object({\n      rate_increase_percent       = optional(number, 10)\n      rate_limit_count_per_member = optional(number, 30)\n      rate_period_seconds         = optional(number, 900)\n      rate_units                  = optional(string, \"count\")\n    })\n    disk = object({\n      capacity_enabled             = optional(bool, false)\n      free_space_less_than_percent = optional(number, 10)\n      io_above_percent             = optional(number, 90)\n      io_enabled                   = optional(bool, false)\n      io_over_period               = optional(string, \"15m\")\n      rate_increase_percent        = optional(number, 10)\n      rate_limit_mb_per_member     = optional(number, 3670016)\n      rate_period_seconds          = optional(number, 900)\n      rate_units                   = optional(string, \"mb\")\n    })\n    memory = object({\n      io_above_percent         = optional(number, 90)\n      io_enabled               = optional(bool, false)\n      io_over_period           = optional(string, \"15m\")\n      rate_increase_percent    = optional(number, 10)\n      rate_limit_mb_per_member = optional(number, 114688)\n      rate_period_seconds      = optional(number, 900)\n      rate_units               = optional(string, \"mb\")\n    })\n  })",
+      "type": "object({\n    disk = object({\n      capacity_enabled             = optional(bool, false)\n      free_space_less_than_percent = optional(number, 10)\n      io_above_percent             = optional(number, 90)\n      io_enabled                   = optional(bool, false)\n      io_over_period               = optional(string, \"15m\")\n      rate_increase_percent        = optional(number, 10)\n      rate_limit_mb_per_member     = optional(number, 3670016)\n      rate_period_seconds          = optional(number, 900)\n      rate_units                   = optional(string, \"mb\")\n    })\n    memory = object({\n      io_above_percent         = optional(number, 90)\n      io_enabled               = optional(bool, false)\n      io_over_period           = optional(string, \"15m\")\n      rate_increase_percent    = optional(number, 10)\n      rate_limit_mb_per_member = optional(number, 114688)\n      rate_period_seconds      = optional(number, 900)\n      rate_units               = optional(string, \"mb\")\n    })\n  })",
       "description": "Optional rules to allow the database to increase resources in response to usage. Only a single autoscaling block is allowed. Make sure you understand the effects of autoscaling, especially for production environments. See https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-autoscaling\u0026interface=cli#autoscaling-considerations in the IBM Cloud Docs.",
       "pos": {
         "filename": "variables.tf",
@@ -16,7 +16,7 @@
       "description": "The CRN of a Key Protect key that you want to use for encrypting the disk that holds deployment backups. Only used if var.kms_encryption_enabled is set to true. BYOK for backups is available only in US regions us-south and us-east, and in eu-de. Only keys in the us-south and eu-de are durable to region failures. To ensure that your backups are available even if a region failure occurs, use a key from us-south or eu-de. Hyper Protect Crypto Services for IBM Cloud Databases backups is not currently supported. If no value is passed here, the value passed for the 'kms_key_crn' variable is used. And if a HPCS value is passed for var.kms_key_crn, the database backup encryption uses the default encryption keys.",
       "pos": {
         "filename": "variables.tf",
-        "line": 179
+        "line": 173
       }
     },
     "cbr_rules": {
@@ -33,7 +33,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 205
+        "line": 199
       }
     },
     "configuration": {
@@ -91,7 +91,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 195
+        "line": 189
       },
       "immutable": true,
       "computed": true
@@ -119,7 +119,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 159
+        "line": 153
       }
     },
     "kms_key_crn": {
@@ -131,7 +131,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 165
+        "line": 159
       },
       "immutable": true
     },
@@ -253,7 +253,7 @@
       "default": false,
       "pos": {
         "filename": "variables.tf",
-        "line": 189
+        "line": 183
       }
     },
     "tags": {
@@ -406,7 +406,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 164
+        "line": 158
       }
     }
   },
@@ -485,7 +485,7 @@
       },
       "pos": {
         "filename": "main.tf",
-        "line": 125
+        "line": 119
       }
     }
   }
diff --git a/profiles/fscloud/README.md b/profiles/fscloud/README.md
diff --git a/profiles/fscloud/variables.tf b/profiles/fscloud/variables.tf
diff --git a/variables.tf b/variables.tf

Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,6 @@ module "mongodb" {`
`76`	`76`	`region = var.region`
`77`	`77`	`kms_key_crn = module.key_protect_all_inclusive.keys["icd.${var.prefix}-mongodb"].crn`
`78`	`78`	`tags = var.resource_tags`
`79`		`- auto_scaling = var.auto_scaling`
`80`	`79`	`service_credential_names = var.service_credential_names`
`81`	`80`	`cbr_rules = [`
`82`	`81`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ module "mongodb" {`
`61`	`61`	`existing_kms_instance_guid = var.existing_kms_instance_guid`
`62`	`62`	`mongodb_version = var.mongodb_version`
`63`	`63`	`service_credential_names = var.service_credential_names`
	`64`	`+ auto_scaling = var.auto_scaling`
`64`	`65`	`cbr_rules = [`
`65`	`66`	`{`
`66`	`67`	`description = "${var.prefix}-mongodb access only from vpc"`