feature: Added recommended defaults for blueprint variables (#20)

Author: Gautam04

README.md

@@ -36,8 +36,8 @@ Functional examples are included in the
 | name | The unique name of the Bigtable instance. | `string` | n/a | yes |
 | project\_id | The ID of the project in which the resource belongs | `string` | n/a | yes |
 | storage\_type | The storage type to use. One of SSD or HDD. Defaults to SSD | `string` | `"SSD"` | no |
-| tables | Tables to created in the Bigtable instance. | <pre>map(object({<br>    table_name              = string<br>    split_keys              = optional(list(string))<br>    deletion_protection     = optional(string)<br>    change_stream_retention = optional(number)<br>    column_family = optional(map(object({<br>      family = string<br>      }))<br>    )<br>  }))</pre> | `{}` | no |
-| zones | Zones of the Bigtable cluster. | <pre>map(object({<br>    zone         = string<br>    cluster_id   = string<br>    num_nodes    = optional(number)<br>    kms_key_name = optional(string)<br>    autoscaling_config = optional(object({<br>      min_nodes      = number<br>      max_nodes      = number<br>      cpu_target     = number<br>      storage_target = optional(number)<br>    }))<br>  }))</pre> | n/a | yes |
+| tables | Tables to created in the Bigtable instance. | <pre>map(object({<br>    table_name              = string<br>    split_keys              = optional(list(string))<br>    deletion_protection     = optional(string, "PROTECTED")<br>    change_stream_retention = optional(string, "0s")<br>    automated_backup_policy = optional(object({<br>      retention_period = string<br>      frequency        = string<br>    }))<br><br>    column_family = optional(map(object({<br>      family = string<br>      }))<br>    )<br>  }))</pre> | `{}` | no |
+| zones | Zones of the Bigtable cluster. | <pre>map(object({<br>    zone         = string<br>    cluster_id   = string<br>    num_nodes    = optional(number)<br>    kms_key_name = optional(string)<br>    autoscaling_config = optional(object({<br>      min_nodes      = number<br>      max_nodes      = number<br>      cpu_target     = number<br>      storage_target = optional(number)<br>    }))<br>  }))</pre> | <pre>{<br>  "zone1": {<br>    "autoscaling_config": {<br>      "cpu_target": 60,<br>      "max_nodes": 2,<br>      "min_nodes": 1<br>    },<br>    "cluster_id": "cluster1",<br>    "zone": "us-central1-a"<br>  },<br>  "zone2": {<br>    "autoscaling_config": {<br>      "cpu_target": 60,<br>      "max_nodes": 2,<br>      "min_nodes": 1<br>    },<br>    "cluster_id": "cluster2",<br>    "zone": "us-west1-a"<br>  },<br>  "zone3": {<br>    "autoscaling_config": {<br>      "cpu_target": 60,<br>      "max_nodes": 2,<br>      "min_nodes": 1<br>    },<br>    "cluster_id": "cluster3",<br>    "zone": "us-central1-c"<br>  }<br>}</pre> | no |
 
 ## Outputs
 

examples/basic/main.tf

@@ -42,22 +42,27 @@ module "bigtable" {
   }
   tables = {
     table1 = {
-      "table_name" = "test-table1"
+      table_name = "test-table1"
       split_keys   = ["a", "b", "c"]
-      "column_family" = {
+      column_family = {
         family1 = {
-          "family" = "first-family"
+          family = "first-family"
         }
         family2 = {
-          "family" = "second-family"
+          family = "second-family"
         }
       }
+      deletion_protection = "UNPROTECTED"
     }
+
     table2 = {
-      "table_name" = "test-table2"
-      table3 = {
-        "table_name" = "test-table3"
-      }
+      table_name = "test-table2"
+      deletion_protection = "UNPROTECTED"
+    }
+
+    table3 = {
+      table_name = "test-table3"
+      deletion_protection = "UNPROTECTED"
     }
   }
   deletion_protection = false

main.tf

@@ -65,6 +65,14 @@ resource "google_bigtable_table" "table" {
       family = column_family.value["family"]
     }
   }
+
+  dynamic "automated_backup_policy" {
+    for_each = each.value.automated_backup_policy != null ? [each.value.automated_backup_policy] : []
+    content {
+      retention_period = automated_backup_policy.value.retention_period
+      frequency        = automated_backup_policy.value.frequency
+    }
+  }
 }
 
 

metadata.yaml

@@ -71,7 +71,28 @@ spec:
                 storage_target = optional(number)
               }))
             }))
-        required: true
+        defaultValue:
+          zone1:
+            autoscaling_config:
+              cpu_target: 60
+              max_nodes: 2
+              min_nodes: 1
+            cluster_id: cluster1
+            zone: us-central1-a
+          zone2:
+            autoscaling_config:
+              cpu_target: 60
+              max_nodes: 2
+              min_nodes: 1
+            cluster_id: cluster2
+            zone: us-west1-a
+          zone3:
+            autoscaling_config:
+              cpu_target: 60
+              max_nodes: 2
+              min_nodes: 1
+            cluster_id: cluster3
+            zone: us-central1-c
       - name: labels
         description: labels associated to the Bigtable instance.
         varType: map(string)
@@ -82,8 +103,13 @@ spec:
           map(object({
               table_name              = string
               split_keys              = optional(list(string))
-              deletion_protection     = optional(string)
-              change_stream_retention = optional(number)
+              deletion_protection     = optional(string, "PROTECTED")
+              change_stream_retention = optional(string, "0s")
+              automated_backup_policy = optional(object({
+                retention_period = string
+                frequency        = string
+              }))
+
               column_family = optional(map(object({
                 family = string
                 }))

variables.tf

@@ -64,6 +64,45 @@ variable "zones" {
       storage_target = optional(number)
     }))
   }))
+
+  default = {
+    "zone1" = {
+      cluster_id = "cluster1"
+      zone       = "us-central1-a"
+      autoscaling_config = {
+        min_nodes  = 1
+        max_nodes  = 2
+        cpu_target = 60
+      }
+    }
+
+    "zone2" = {
+      cluster_id = "cluster2"
+      zone       = "us-west1-a"
+      autoscaling_config = {
+        min_nodes  = 1
+        max_nodes  = 2
+        cpu_target = 60
+      }
+    }
+
+    "zone3" = {
+      cluster_id = "cluster3"
+      zone       = "us-central1-c"
+      autoscaling_config = {
+        min_nodes  = 1
+        max_nodes  = 2
+        cpu_target = 60
+      }
+    }
+  }
+
+  validation {
+    condition = alltrue(flatten([
+      for k, v in var.zones : !((v.num_nodes == null && v.autoscaling_config == null) || (v.num_nodes != null && v.autoscaling_config != null))
+    ]))
+    error_message = "Set either num_nodes (or) autoscaling_config."
+  }
 }
 
 
@@ -79,8 +118,13 @@ variable "tables" {
   type = map(object({
     table_name              = string
     split_keys              = optional(list(string))
-    deletion_protection     = optional(string)
-    change_stream_retention = optional(number)
+    deletion_protection     = optional(string, "PROTECTED")
+    change_stream_retention = optional(string, "0s")
+    automated_backup_policy = optional(object({
+      retention_period = string
+      frequency        = string
+    }))
+
     column_family = optional(map(object({
       family = string
       }))
@@ -93,6 +137,13 @@ variable "tables" {
     ]))
     error_message = "table_name must be between 1 and 50."
   }
+
+  validation {
+    condition = alltrue(flatten([
+      for k, v in var.tables : (v.deletion_protection == "PROTECTED" || v.deletion_protection == "UNPROTECTED")
+    ]))
+    error_message = "deletion_protection must be set to either PROTECTED or UNPROTECTED"
+  }
   default = {}
 }