fix: removed validation from variables so they don't become out of date, and point to official docs instead (#151)

Author: Aayush-Abhyarthi

README.md

@@ -74,14 +74,14 @@ You need the following permissions to run this module.
 | <a name="input_backup_encryption_key_crn"></a> [backup\_encryption\_key\_crn](#input\_backup\_encryption\_key\_crn) | (Optional) The CRN of a Key Protect Key to use for encrypting backups. If left null, the value passed for the 'kms\_key\_crn' variable will be used. Take note that Hyper Protect Crypto Services for IBM Cloud® Databases backups is not currently supported. | `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 in JSON format. | <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 |
-| <a name="input_cpu_count"></a> [cpu\_count](#input\_cpu\_count) | Number of CPU cores available to the mongodb instance | `number` | `7` | no |
-| <a name="input_disk_mb"></a> [disk\_mb](#input\_disk\_mb) | Disk available to the mongodb instance | `number` | `20480` | no |
+| <a name="input_cpu_count"></a> [cpu\_count](#input\_cpu\_count) | The number of CPU cores available to the database instance. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member | `number` | `7` | no |
+| <a name="input_disk_mb"></a> [disk\_mb](#input\_disk\_mb) | Disk space available to the database instance. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member | `number` | `20480` | no |
 | <a name="input_endpoints"></a> [endpoints](#input\_endpoints) | Endpoints available to the mongodb instance (public, private, public-and-private) | `string` | `"private"` | no |
 | <a name="input_existing_kms_instance_guid"></a> [existing\_kms\_instance\_guid](#input\_existing\_kms\_instance\_guid) | The GUID of the Hyper Protect or Key Protect instance in which the key specified in var.kms\_key\_crn is coming from. Only required if skip\_iam\_authorization\_policy is false | `string` | `null` | no |
 | <a name="input_instance_name"></a> [instance\_name](#input\_instance\_name) | Name of the MongoDB instance | `string` | n/a | yes |
 | <a name="input_kms_key_crn"></a> [kms\_key\_crn](#input\_kms\_key\_crn) | (Optional) The root key CRN of a Key Management Service like Key Protect or Hyper Protect Crypto Service (HPCS) that you want to use for disk encryption. If `null`, database is encrypted by using randomly generated keys. See https://cloud.ibm.com/docs/cloud-databases?topic=cloud-databases-key-protect&interface=ui#key-byok for current list of supported regions for BYOK | `string` | `null` | no |
 | <a name="input_members"></a> [members](#input\_members) | Allocated number of members | `number` | `3` | no |
-| <a name="input_memory_mb"></a> [memory\_mb](#input\_memory\_mb) | Memory available to the mongodb instance | `number` | `1024` | no |
+| <a name="input_memory_mb"></a> [memory\_mb](#input\_memory\_mb) | Memory available to the database instance in MB. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member | `number` | `1024` | no |
 | <a name="input_mongodb_version"></a> [mongodb\_version](#input\_mongodb\_version) | The version of the mongodb to be provisioned | `string` | `null` | no |
 | <a name="input_plan"></a> [plan](#input\_plan) | The name of the service plan that you choose for your mongodb instance | `string` | `"standard"` | no |
 | <a name="input_region"></a> [region](#input\_region) | The region MongoDB is to be created on. The region must support BYOK region if Key Protect Key is used or KYOK region if Hyper Protect Crypto Service (HPCS) is used. | `string` | `"us-south"` | no |

module-metadata.json

@@ -17,7 +17,7 @@
       "description": "Configure rules to allow your database to automatically increase its resources. Single block of autoscaling is allowed at once.",
       "pos": {
         "filename": "variables.tf",
-        "line": 166
+        "line": 142
       }
     },
     "backup_encryption_key_crn": {
@@ -43,7 +43,7 @@
       ],
       "pos": {
         "filename": "variables.tf",
-        "line": 201
+        "line": 177
       }
     },
     "configuration": {
@@ -61,21 +61,21 @@
     "cpu_count": {
       "name": "cpu_count",
       "type": "number",
-      "description": "Number of CPU cores available to the mongodb instance",
+      "description": "The number of CPU cores available to the database instance. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member",
       "default": 7,
       "pos": {
         "filename": "variables.tf",
-        "line": 138
+        "line": 122
       }
     },
     "disk_mb": {
       "name": "disk_mb",
       "type": "number",
-      "description": "Disk available to the mongodb instance",
+      "description": "Disk space available to the database instance. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member",
       "default": 20480,
       "pos": {
         "filename": "variables.tf",
-        "line": 124
+        "line": 116
       }
     },
     "endpoints": {
@@ -139,13 +139,13 @@
       "default": 3,
       "pos": {
         "filename": "variables.tf",
-        "line": 153
+        "line": 129
       }
     },
     "memory_mb": {
       "name": "memory_mb",
       "type": "number",
-      "description": "Memory available to the mongodb instance",
+      "description": "Memory available to the database instance in MB. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member",
       "default": 1024,
       "pos": {
         "filename": "variables.tf",

variables.tf

@@ -109,44 +109,20 @@ variable "backup_encryption_key_crn" {
 
 variable "memory_mb" {
   type        = number
-  description = "Memory available to the mongodb instance"
+  description = "Memory available to the database instance in MB. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member"
   default     = 1024
-
-  validation {
-    condition = alltrue([
-      var.memory_mb >= 1024,
-      var.memory_mb <= 114688
-    ])
-    error_message = "Member group memory must be >= 1024 and <= 114688 in increments of 128."
-  }
 }
 
 variable "disk_mb" {
   type        = number
-  description = "Disk available to the mongodb instance"
+  description = "Disk space available to the database instance. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member"
   default     = 20480
-
-  validation {
-    condition = alltrue([
-      var.disk_mb >= 5120,
-      var.disk_mb <= 4194304
-    ])
-    error_message = "Member group disk must be >= 5120 and <= 4194304 in increments of 1024."
-  }
 }
 
 variable "cpu_count" {
   type        = number
-  description = "Number of CPU cores available to the mongodb instance"
+  description = "The number of CPU cores available to the database instance. For more information refer to the docs https://cloud.ibm.com/docs/databases-for-mongodb?topic=databases-for-mongodb-pricing#mongodb-scale-member"
   default     = 7
-
-  validation {
-    condition = alltrue([
-      var.cpu_count >= 6,
-      var.cpu_count <= 28
-    ])
-    error_message = "Number of cpus must be >= 6 and <= 28 in increments of 1."
-  }
 }