feat!: Allow setting predictive method for CPU utilization scaling (#255

)

* Allow setting predictive method for CPU utilization scaling

* Update variable type for autoscaling_cpu

* Update fixture for failing tests

autogen/main.tf.tmpl

@@ -146,7 +146,8 @@ resource "google_compute_region_autoscaler" "autoscaler" {
     dynamic "cpu_utilization" {
       for_each = var.autoscaling_cpu
       content {
-        target = lookup(cpu_utilization.value, "target", null)
+        target            = lookup(cpu_utilization.value, "target", null)
+        predictive_method = lookup(cpu_utilization.value, "predictive_method", null)
       }
     }
     dynamic "metric" {

autogen/variables.tf.tmpl

@@ -184,7 +184,10 @@ variable "autoscaling_mode" {
 
 variable "autoscaling_cpu" {
   description = "Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization"
-  type        = list(map(number))
+  type        = list(object({
+    target            = number
+    predictive_method = string
+  }))
   default     = []
 }
 

examples/mig/autoscaler/README.md

@@ -8,7 +8,7 @@ group with an autoscaler.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| autoscaling\_cpu | Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization | `list(map(number))` | n/a | yes |
+| autoscaling\_cpu | Autoscaling, cpu utilization policy block as single element array. https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_autoscaler#cpu_utilization | <pre>list(object({<br>    target            = number<br>    predictive_method = string<br>  }))</pre> | n/a | yes |
 | autoscaling\_enabled | Creates an autoscaler for the managed instance group | `any` | n/a | yes |
 | min\_replicas | The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. | `any` | n/a | yes |
 | project\_id | The GCP project to use for integration tests | `string` | n/a | yes |

examples/mig/autoscaler/variables.tf

@@ -51,7 +51,10 @@ variable "min_replicas" {
 
 
 variable "autoscaling_cpu" {
-  description = "Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization"
-  type        = list(map(number))
+  description = "Autoscaling, cpu utilization policy block as single element array. https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_autoscaler#cpu_utilization"
+  type = list(object({
+    target            = number
+    predictive_method = string
+  }))
 }
 

examples/mig/healthcheck/main.tf

@@ -71,7 +71,8 @@ module "mig" {
 
   autoscaling_cpu = [
     {
-      target = 0.4
+      target            = 0.4
+      predictive_method = null # use default of NONE
     },
   ]
 

modules/mig/README.md

@@ -19,7 +19,7 @@ The current version is 2.X. The following guides are available to assist with up
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | autoscaler\_name | Autoscaler name. When variable is empty, name will be derived from var.hostname. | `string` | `""` | no |
-| autoscaling\_cpu | Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization | `list(map(number))` | `[]` | no |
+| autoscaling\_cpu | Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization | <pre>list(object({<br>    target            = number<br>    predictive_method = string<br>  }))</pre> | `[]` | no |
 | autoscaling\_enabled | Creates an autoscaler for the managed instance group | `string` | `"false"` | no |
 | autoscaling\_lb | Autoscaling, load balancing utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#load_balancing_utilization | `list(map(number))` | `[]` | no |
 | autoscaling\_metric | Autoscaling, metric policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#metric | <pre>list(object({<br>    name   = string<br>    target = number<br>    type   = string<br>  }))</pre> | `[]` | no |

modules/mig/main.tf

@@ -130,7 +130,8 @@ resource "google_compute_region_autoscaler" "autoscaler" {
     dynamic "cpu_utilization" {
       for_each = var.autoscaling_cpu
       content {
-        target = lookup(cpu_utilization.value, "target", null)
+        target            = lookup(cpu_utilization.value, "target", null)
+        predictive_method = lookup(cpu_utilization.value, "predictive_method", null)
       }
     }
     dynamic "metric" {

modules/mig/variables.tf

@@ -169,8 +169,11 @@ variable "autoscaling_mode" {
 
 variable "autoscaling_cpu" {
   description = "Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization"
-  type        = list(map(number))
-  default     = []
+  type = list(object({
+    target            = number
+    predictive_method = string
+  }))
+  default = []
 }
 
 variable "autoscaling_metric" {

modules/mig_with_percent/README.md

@@ -18,7 +18,7 @@ The current version is 2.X. The following guides are available to assist with up
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | autoscaler\_name | Autoscaler name. When variable is empty, name will be derived from var.hostname. | `string` | `""` | no |
-| autoscaling\_cpu | Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization | `list(map(number))` | `[]` | no |
+| autoscaling\_cpu | Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization | <pre>list(object({<br>    target            = number<br>    predictive_method = string<br>  }))</pre> | `[]` | no |
 | autoscaling\_enabled | Creates an autoscaler for the managed instance group | `string` | `"false"` | no |
 | autoscaling\_lb | Autoscaling, load balancing utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#load_balancing_utilization | `list(map(number))` | `[]` | no |
 | autoscaling\_metric | Autoscaling, metric policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#metric | <pre>list(object({<br>    name   = string<br>    target = number<br>    type   = string<br>  }))</pre> | `[]` | no |

modules/mig_with_percent/main.tf

@@ -139,7 +139,8 @@ resource "google_compute_region_autoscaler" "autoscaler" {
     dynamic "cpu_utilization" {
       for_each = var.autoscaling_cpu
       content {
-        target = lookup(cpu_utilization.value, "target", null)
+        target            = lookup(cpu_utilization.value, "target", null)
+        predictive_method = lookup(cpu_utilization.value, "predictive_method", null)
       }
     }
     dynamic "metric" {

modules/mig_with_percent/variables.tf

@@ -177,8 +177,11 @@ variable "autoscaling_mode" {
 
 variable "autoscaling_cpu" {
   description = "Autoscaling, cpu utilization policy block as single element array. https://www.terraform.io/docs/providers/google/r/compute_autoscaler.html#cpu_utilization"
-  type        = list(map(number))
-  default     = []
+  type = list(object({
+    target            = number
+    predictive_method = string
+  }))
+  default = []
 }
 
 variable "autoscaling_metric" {

test/fixtures/mig/autoscaler/main.tf

@@ -24,7 +24,8 @@ module "mig_autoscaler" {
 
   autoscaling_cpu = [
     {
-      target = 0.6
+      target            = 0.6,
+      predictive_method = null,
     },
   ]
 }