Add autoscaling settings to pc management cluster (GoogleCloudPlatform#12002)

varshatumburu · amanMahendroo · commit 7f2fed0a9c46 · 2024-12-17T05:34:28.000Z
diff --git a/mmv1/products/vmwareengine/PrivateCloud.yaml b/mmv1/products/vmwareengine/PrivateCloud.yaml
@@ -52,6 +52,7 @@ custom_code:
   update_encoder: 'templates/terraform/update_encoder/private_cloud.go.tmpl'
   decoder: 'templates/terraform/decoders/private_cloud.go.tmpl'
   pre_create: 'templates/terraform/pre_create/vmwareengine_private_cloud.go.tmpl'
+  post_create: 'templates/terraform/post_create/private_cloud.go.tmpl'
   post_delete: 'templates/terraform/post_delete/private_cloud.go.tmpl'
   post_update: 'templates/terraform/post_update/private_cloud.go.tmpl'
   pre_delete: 'templates/terraform/pre_delete/vmwareengine_private_cloud.go.tmpl'
@@ -67,7 +68,7 @@ examples:
       management_cluster_id: 'sample-mgmt-cluster'
     test_env_vars:
       region: 'REGION'
- # update tests will take care of create and update. PC creation is expensive and node reservation is required.
+      # update tests will take care of create and update. PC creation is expensive and node reservation is required.
     exclude_test: true
   - name: 'vmware_engine_private_cloud_full'
     primary_resource_id: 'vmw-engine-pc'
@@ -77,7 +78,7 @@ examples:
       management_cluster_id: 'sample-mgmt-cluster'
     test_env_vars:
       region: 'REGION'
- # update tests will take care of create and update. PC creation is expensive and node reservation is required.
+    # update tests will take care of create and update. PC creation is expensive and node reservation is required.
     exclude_test: true
 virtual_fields:
   - name: 'deletion_delay_hours'
@@ -218,6 +219,107 @@ properties:
             type: String
             description: |
               Additional zone for a higher level of availability and load balancing.
+      - name: 'autoscalingSettings'
+        type: NestedObject
+        description: |
+          Configuration of the autoscaling applied to this cluster
+          Private cloud must have a minimum of 3 nodes to add autoscale settings
+        properties:
+          - name: 'autoscalingPolicies'
+            type: Map
+            required: true
+            description: |
+              The map with autoscaling policies applied to the cluster.
+              The key is the identifier of the policy.
+              It must meet the following requirements:
+               * Only contains 1-63 alphanumeric characters and hyphens
+               * Begins with an alphabetical character
+               * Ends with a non-hyphen character
+               * Not formatted as a UUID
+               * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)
+
+              Currently the map must contain only one element
+              that describes the autoscaling policy for compute nodes.
+            key_name: 'autoscale_policy_id'
+            key_description: 'The key is the identifier of the policy.'
+            value_type:
+              name: AutoscalingPolicy
+              type: NestedObject
+              properties:
+                - name: 'nodeTypeId'
+                  type: String
+                  required: true
+                  description: |
+                    The canonical identifier of the node type to add or remove.
+                - name: 'scaleOutSize'
+                  type: Integer
+                  required: true
+                  description: |
+                    Number of nodes to add to a cluster during a scale-out operation.
+                    Must be divisible by 2 for stretched clusters.
+                - name: 'cpuThresholds'
+                  type: NestedObject
+                  description: |
+                    Utilization thresholds pertaining to CPU utilization.
+                  properties:
+                    - name: 'scaleOut'
+                      type: Integer
+                      required: true
+                      description: |
+                        The utilization triggering the scale-out operation in percent.
+                    - name: 'scaleIn'
+                      type: Integer
+                      required: true
+                      description: |
+                        The utilization triggering the scale-in operation in percent.
+                - name: 'consumedMemoryThresholds'
+                  type: NestedObject
+                  description: |
+                    Utilization thresholds pertaining to amount of consumed memory.
+                  properties:
+                    - name: 'scaleOut'
+                      type: Integer
+                      required: true
+                      description: |
+                        The utilization triggering the scale-out operation in percent.
+                    - name: 'scaleIn'
+                      type: Integer
+                      required: true
+                      description: |
+                        The utilization triggering the scale-in operation in percent.
+                - name: 'storageThresholds'
+                  type: NestedObject
+                  description: |
+                    Utilization thresholds pertaining to amount of consumed storage.
+                  properties:
+                    - name: 'scaleOut'
+                      type: Integer
+                      required: true
+                      description: |
+                        The utilization triggering the scale-out operation in percent.
+                    - name: 'scaleIn'
+                      type: Integer
+                      required: true
+                      description: |
+                        The utilization triggering the scale-in operation in percent.
+          - name: 'minClusterNodeCount'
+            type: Integer
+            description: |
+              Minimum number of nodes of any type in a cluster.
+              Mandatory for successful addition of autoscaling settings in cluster.
+          - name: 'maxClusterNodeCount'
+            type: Integer
+            description: |
+              Maximum number of nodes of any type in a cluster.
+              Mandatory for successful addition of autoscaling settings in cluster.
+          - name: 'coolDownPeriod'
+            type: String
+            description: |
+              The minimum duration between consecutive autoscale operations.
+              It starts once addition or removal of nodes is fully completed.
+              Minimum cool down period is 30m.
+              Cool down period must be in whole minutes (for example, 30m, 31m, 50m).
+              Mandatory for successful addition of autoscaling settings in cluster.
   - name: 'hcx'
     type: NestedObject
     description: |
diff --git a/mmv1/templates/terraform/examples/vmware_engine_private_cloud_full.tf.tmpl b/mmv1/templates/terraform/examples/vmware_engine_private_cloud_full.tf.tmpl
@@ -14,6 +14,28 @@ resource "google_vmwareengine_private_cloud" "{{$.PrimaryResourceId}}" {
       node_count   = 1
       custom_core_count = 32
     }
+    autoscaling_settings {
+      autoscaling_policies {
+        autoscale_policy_id = "autoscaling-policy"
+        node_type_id = "standard-72"
+        scale_out_size = 1
+        cpu_thresholds {
+          scale_out = 80
+          scale_in  = 15
+        }
+        consumed_memory_thresholds {
+          scale_out = 75
+          scale_in  = 20
+        }
+        storage_thresholds {
+          scale_out = 80
+          scale_in  = 20
+        }
+      }
+      min_cluster_node_count = 3
+      max_cluster_node_count = 8
+      cool_down_period = "1800s"
+    }
   }
   deletion_delay_hours = 0
   send_deletion_delay_hours_if_zero = true
diff --git a/mmv1/templates/terraform/post_create/private_cloud.go.tmpl b/mmv1/templates/terraform/post_create/private_cloud.go.tmpl
@@ -0,0 +1,54 @@
+mgmtClusterProp, err := expandVmwareenginePrivateCloudManagementCluster(d.Get("management_cluster"), d, config)
+if v, ok := d.GetOkExists("management_cluster"); !tpgresource.IsEmptyValue(reflect.ValueOf(v)) && (ok || !reflect.DeepEqual(v, mgmtClusterProp)) {
+		obj["managementCluster"] = mgmtClusterProp
+}
+
+mgmtMap := mgmtClusterProp.(map[string]interface{})
+parentUrl, err := tpgresource.ReplaceVars(d, config, "{{"{{"}}VmwareengineBasePath{{"}}"}}projects/{{"{{"}}project{{"}}"}}/locations/{{"{{"}}location{{"}}"}}/privateClouds/{{"{{"}}name{{"}}"}}")
+if err != nil {
+  return err
+}
+
+clusterUrl := fmt.Sprintf("%s/clusters/%s", parentUrl, mgmtMap["clusterId"])
+clusterUpdateMask := []string{}
+clusterObj := make(map[string]interface{})
+
+if v, ok := d.GetOkExists("management_cluster"); !tpgresource.IsEmptyValue(reflect.ValueOf(mgmtClusterProp)) && (ok || !reflect.DeepEqual(v, mgmtClusterProp)) {
+  clusterObj["autoscalingSettings"] = mgmtMap["autoscalingSettings"]
+}
+
+if d.HasChange("management_cluster") {
+  clusterUpdateMask = append(clusterUpdateMask, "autoscalingSettings")
+}
+
+clusterPatchUrl, err := transport_tpg.AddQueryParams(clusterUrl, map[string]string{"updateMask": strings.Join(clusterUpdateMask, ",")})
+if err != nil {
+  return err
+}
+
+// check if there is anything to update to avoid API call if not required.
+if len(clusterUpdateMask) > 0 {
+    res, err := transport_tpg.SendRequest(transport_tpg.SendRequestOptions{
+      Config:    config,
+      Method:    "PATCH",
+      Project:   billingProject,
+      RawURL:    clusterPatchUrl,
+      UserAgent: userAgent,
+      Body:      clusterObj,
+      Timeout:   d.Timeout(schema.TimeoutUpdate),
+    })
+
+    if err != nil {
+      return fmt.Errorf("Error updating magament cluster %q: %s", d.Id(), err)
+    } else {
+      log.Printf("[DEBUG] Finished updating magament cluster %q: %#v", d.Id(), res)
+    }
+
+    err = VmwareengineOperationWaitTime(
+      config, res, project, "Updating Managment Cluster", userAgent,
+      d.Timeout(schema.TimeoutUpdate))
+
+    if err != nil {
+      return err
+    }
+}
diff --git a/mmv1/templates/terraform/post_update/private_cloud.go.tmpl b/mmv1/templates/terraform/post_update/private_cloud.go.tmpl
@@ -15,10 +15,12 @@ clusterObj := make(map[string]interface{})
 
 if v, ok := d.GetOkExists("management_cluster"); !tpgresource.IsEmptyValue(reflect.ValueOf(mgmtClusterProp)) && (ok || !reflect.DeepEqual(v, mgmtClusterProp)) {
   clusterObj["nodeTypeConfigs"] = mgmtMap["nodeTypeConfigs"]
+  clusterObj["autoscalingSettings"] = mgmtMap["autoscalingSettings"]
 }
 
 if d.HasChange("management_cluster") {
   clusterUpdateMask = append(clusterUpdateMask, "nodeTypeConfigs.*.nodeCount")
+  clusterUpdateMask = append(clusterUpdateMask, "autoscalingSettings")
 }
 
 clusterPatchUrl, err := transport_tpg.AddQueryParams(clusterUrl, map[string]string{"updateMask": strings.Join(clusterUpdateMask, ",")})
diff --git a/mmv1/third_party/terraform/services/vmwareengine/resource_vmwareengine_private_cloud_test.go b/mmv1/third_party/terraform/services/vmwareengine/resource_vmwareengine_private_cloud_test.go
@@ -55,7 +55,27 @@ func TestAccVmwareenginePrivateCloud_vmwareEnginePrivateCloudUpdate(t *testing.T
 			},
 
 			{
-				Config: testVmwareenginePrivateCloudUpdateConfig(context),
+				Config: testVmwareenginePrivateCloudUpdateNodeConfig(context),
+				Check: resource.ComposeTestCheckFunc(
+					acctest.CheckDataSourceStateMatchesResourceStateWithIgnores(
+						"data.google_vmwareengine_private_cloud.ds",
+						"google_vmwareengine_private_cloud.vmw-engine-pc",
+						map[string]struct{}{
+							"type":                              {},
+							"deletion_delay_hours":              {},
+							"send_deletion_delay_hours_if_zero": {},
+						}),
+				),
+			},
+			{
+				ResourceName:            "google_vmwareengine_private_cloud.vmw-engine-pc",
+				ImportState:             true,
+				ImportStateVerify:       true,
+				ImportStateVerifyIgnore: []string{"location", "name", "update_time", "type", "deletion_delay_hours", "send_deletion_delay_hours_if_zero"},
+			},
+
+			{
+				Config: testVmwareenginePrivateCloudUpdateAutoscaleConfig(context),
 				Check: resource.ComposeTestCheckFunc(
 					acctest.CheckDataSourceStateMatchesResourceStateWithIgnores(
 						"data.google_vmwareengine_private_cloud.ds",
@@ -131,27 +151,31 @@ func TestAccVmwareenginePrivateCloud_vmwareEnginePrivateCloudUpdate(t *testing.T
 }
 
 func testVmwareenginePrivateCloudCreateConfig(context map[string]interface{}) string {
-	return testVmwareenginePrivateCloudConfig(context, "sample description", "TIME_LIMITED", 1, 1) + testVmwareengineVcenterNSXCredentailsConfig(context)
+	return testVmwareenginePrivateCloudConfig(context, "sample description", "STANDARD", 3, 8) + testVmwareengineVcenterNSXCredentailsConfig(context)
 }
 
-func testVmwareenginePrivateCloudUpdateConfig(context map[string]interface{}) string {
+func testVmwareenginePrivateCloudUpdateNodeConfig(context map[string]interface{}) string {
 	return testVmwareenginePrivateCloudConfig(context, "sample updated description", "STANDARD", 3, 8) + testVmwareengineVcenterNSXCredentailsConfig(context)
 }
 
+func testVmwareenginePrivateCloudUpdateAutoscaleConfig(context map[string]interface{}) string {
+	return testVmwareenginePrivateCloudAutoscaleConfig(context, "sample updated description", "STANDARD", 3, 8) + testVmwareengineVcenterNSXCredentailsConfig(context)
+}
+
 func testVmwareenginePrivateCloudDelayedDeleteConfig(context map[string]interface{}) string {
 	return testVmwareenginePrivateCloudDeletedConfig(context)
 }
 
 func testVmwareenginePrivateCloudUndeleteConfig(context map[string]interface{}) string {
-	return testVmwareenginePrivateCloudConfig(context, "sample updated description", "STANDARD", 3, 0) + testVmwareengineVcenterNSXCredentailsConfig(context)
+	return testVmwareenginePrivateCloudAutoscaleConfig(context, "sample updated description", "STANDARD", 3, 0) + testVmwareengineVcenterNSXCredentailsConfig(context)
 }
 
 func testVmwareengineSubnetImportConfig(context map[string]interface{}) string {
-	return testVmwareenginePrivateCloudConfig(context, "sample updated description", "STANDARD", 3, 0) + testVmwareengineSubnetConfig(context, "192.168.1.0/26")
+	return testVmwareenginePrivateCloudAutoscaleConfig(context, "sample updated description", "STANDARD", 3, 0) + testVmwareengineSubnetConfig(context, "192.168.1.0/26")
 }
 
 func testVmwareengineSubnetUpdateConfig(context map[string]interface{}) string {
-	return testVmwareenginePrivateCloudConfig(context, "sample updated description", "STANDARD", 3, 0) + testVmwareengineSubnetConfig(context, "192.168.2.0/26")
+	return testVmwareenginePrivateCloudAutoscaleConfig(context, "sample updated description", "STANDARD", 3, 0) + testVmwareengineSubnetConfig(context, "192.168.2.0/26")
 }
 
 func testVmwareenginePrivateCloudConfig(context map[string]interface{}, description, pcType string, nodeCount, delayHours int) string {
@@ -184,6 +208,86 @@ resource "google_vmwareengine_private_cloud" "vmw-engine-pc" {
       node_type_id = "standard-72"
       node_count = "%{node_count}"
       custom_core_count = 32
+    }
+		autoscaling_settings {
+      autoscaling_policies {
+        autoscale_policy_id = "autoscaling-policy"
+        node_type_id = "standard-72"
+        scale_out_size = 1
+        storage_thresholds {
+          scale_out = 60
+          scale_in  = 20
+        }
+      }
+      min_cluster_node_count = 3
+      max_cluster_node_count = 8
+      cool_down_period = "1800s"
+    }
+  }
+}
+
+data "google_vmwareengine_private_cloud" "ds" {
+	location = "%{region}-b"
+	name = "tf-test-sample-pc%{random_suffix}"
+	depends_on = [
+   	google_vmwareengine_private_cloud.vmw-engine-pc,
+  ]
+}
+`, context)
+}
+
+func testVmwareenginePrivateCloudAutoscaleConfig(context map[string]interface{}, description, pcType string, nodeCount, delayHours int) string {
+	context["node_count"] = nodeCount
+	context["delay_hrs"] = delayHours
+	context["description"] = description
+	context["type"] = pcType
+	return acctest.Nprintf(`
+resource "google_vmwareengine_network" "vmw-engine-nw" {
+  name              = "tf-test-pc-nw-%{random_suffix}"
+  location          = "global"
+  type              = "STANDARD"
+  description       = "PC network description."
+}
+
+resource "google_vmwareengine_private_cloud" "vmw-engine-pc" {
+  location = "%{region}-b"
+  name = "tf-test-sample-pc%{random_suffix}"
+  description = "%{description}"
+  type = "%{type}"
+  deletion_delay_hours = "%{delay_hrs}"
+  send_deletion_delay_hours_if_zero = true
+  network_config {
+    management_cidr = "192.168.0.0/24"
+    vmware_engine_network = google_vmwareengine_network.vmw-engine-nw.id
+  }
+  management_cluster {
+    cluster_id = "tf-test-sample-mgmt-cluster-custom-core-count%{random_suffix}"
+    node_type_configs {
+      node_type_id = "standard-72"
+      node_count = "%{node_count}"
+      custom_core_count = 32
+    }
+    autoscaling_settings {
+      autoscaling_policies {
+        autoscale_policy_id = "autoscaling-policy"
+        node_type_id = "standard-72"
+        scale_out_size = 1
+        cpu_thresholds {
+          scale_out = 80
+          scale_in  = 15
+        }
+        consumed_memory_thresholds {
+          scale_out = 75
+          scale_in  = 20
+        }
+        storage_thresholds {
+          scale_out = 80
+          scale_in  = 20
+        }
+      }
+      min_cluster_node_count = 3
+      max_cluster_node_count = 8
+      cool_down_period = "1800s"
     }
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,12 @@ clusterObj := make(map[string]interface{})`
`15`	`15`
`16`	`16`	`if v, ok := d.GetOkExists("management_cluster"); !tpgresource.IsEmptyValue(reflect.ValueOf(mgmtClusterProp)) && (ok \|\| !reflect.DeepEqual(v, mgmtClusterProp)) {`
`17`	`17`	`clusterObj["nodeTypeConfigs"] = mgmtMap["nodeTypeConfigs"]`
	`18`	`+ clusterObj["autoscalingSettings"] = mgmtMap["autoscalingSettings"]`
`18`	`19`	`}`
`19`	`20`
`20`	`21`	`if d.HasChange("management_cluster") {`
`21`	`22`	`clusterUpdateMask = append(clusterUpdateMask, "nodeTypeConfigs.*.nodeCount")`
	`23`	`+ clusterUpdateMask = append(clusterUpdateMask, "autoscalingSettings")`
`22`	`24`	`}`
`23`	`25`
`24`	`26`	`clusterPatchUrl, err := transport_tpg.AddQueryParams(clusterUrl, map[string]string{"updateMask": strings.Join(clusterUpdateMask, ",")})`