feat: tdsql-c - support serverless creation (#1406)

* feat: tdsql-c - support serverless creation

* fix: cynos add serverless testcase

* changelog 1406

* fix: cynos lint and import

* kill unused defaultSecurityGroup2

* fix: cynos add immutable update checkings

Author: Kagashino

.changelog/1406.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/tencentcloud_cynosdb_cluster: feat: tdsql-c - support serverless creation
+```

tencentcloud/basic_test.go

@@ -92,8 +92,7 @@ const (
 	defaultGaapRealserverIp2        = "1.1.1.5"
 	defaultHttpsDomainCertificateId = "cert-crg2aynt"
 
-	defaultSecurityGroup  = "sg-ijato2x1"
-	defaultSecurityGroup2 = "sg-51rgzop1"
+	defaultSecurityGroup = "sg-ijato2x1"
 
 	defaultProjectId = "1250480"
 

tencentcloud/extension_cynosdb.go

@@ -8,6 +8,7 @@ import (
 const (
 	CYNOSDB_CHARGE_TYPE_POSTPAID = COMMON_PAYTYPE_POSTPAID
 	CYNOSDB_CHARGE_TYPE_PREPAID  = COMMON_PAYTYPE_PREPAID
+	CYNOSDB_SERVERLESS           = "SERVERLESS"
 
 	CYNOSDB_STATUS_RUNNING  = "running"
 	CYNOSDB_STATUS_OFFLINE  = "offlined"
@@ -38,13 +39,13 @@ func TencentCynosdbInstanceBaseInfo() map[string]*schema.Schema {
 	return map[string]*schema.Schema{
 		"instance_cpu_core": {
 			Type:        schema.TypeInt,
-			Required:    true,
-			Description: "The number of CPU cores of read-write type instance in the CynosDB cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.",
+			Optional:    true,
+			Description: "The number of CPU cores of read-write type instance in the CynosDB cluster. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.",
 		},
 		"instance_memory_size": {
 			Type:        schema.TypeInt,
-			Required:    true,
-			Description: "Memory capacity of read-write type instance, unit in GB. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.",
+			Optional:    true,
+			Description: "Memory capacity of read-write type instance, unit in GB. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.",
 		},
 		"instance_id": {
 			Type:        schema.TypeString,
@@ -346,6 +347,31 @@ func TencentCynosdbClusterBaseInfo() map[string]*schema.Schema {
 			Computed:    true,
 			Description: "The ID of the parameter template.",
 		},
+		"db_mode": {
+			Type:        schema.TypeString,
+			Optional:    true,
+			Description: "Specify DB mode, only available when `db_type` is `MYSQL`. Values: `NORMAL` (Default), `SERVERLESS`.",
+		},
+		"min_cpu": {
+			Optional:    true,
+			Type:        schema.TypeFloat,
+			Description: "Minimum CPU core count, required while `db_mode` is `SERVERLESS`, request DescribeServerlessInstanceSpecs for more reference.",
+		},
+		"max_cpu": {
+			Optional:    true,
+			Type:        schema.TypeFloat,
+			Description: "Maximum CPU core count, required while `db_mode` is `SERVERLESS`, request DescribeServerlessInstanceSpecs for more reference.",
+		},
+		"auto_pause": {
+			Type:        schema.TypeString,
+			Optional:    true,
+			Description: "Specify whether the cluster can auto-pause while `db_mode` is `SERVERLESS`. Values: `yes` (default), `no`.",
+		},
+		"auto_pause_delay": {
+			Type:        schema.TypeInt,
+			Optional:    true,
+			Description: "Specify auto-pause delay in second while `db_mode` is `SERVERLESS`. Value range: `[600, 691200]`. Default: `600`.",
+		},
 	}
 
 	for k, v := range TencentCynosdbInstanceBaseInfo() {

tencentcloud/resource_tc_cynosdb_cluster.go

@@ -115,6 +115,22 @@ func resourceTencentCloudCynosdbClusterCreate(d *schema.ResourceData, meta inter
 	request.AdminPassword = helper.String(d.Get("password").(string))
 	request.RollbackStrategy = helper.String("noneRollback")
 
+	if v, ok := d.GetOk("db_mode"); ok {
+		request.DbMode = helper.String(v.(string))
+	}
+	if v, ok := d.GetOk("min_cpu"); ok {
+		request.MinCpu = helper.Float64(v.(float64))
+	}
+	if v, ok := d.GetOk("max_cpu"); ok {
+		request.MaxCpu = helper.Float64(v.(float64))
+	}
+	if v, ok := d.GetOk("auto_pause"); ok {
+		request.AutoPause = helper.String(v.(string))
+	}
+	if v, ok := d.GetOk("auto_pause_delay"); ok {
+		request.AutoPauseDelay = helper.IntInt64(v.(int))
+	}
+
 	if v, ok := d.GetOk("storage_limit"); ok {
 		request.StorageLimit = helper.IntInt64(v.(int))
 	}
@@ -139,10 +155,17 @@ func resourceTencentCloudCynosdbClusterCreate(d *schema.ResourceData, meta inter
 	if v, ok := d.GetOk("prarm_template_id"); ok {
 		request.ParamTemplateId = helper.IntInt64(v.(int))
 	}
-
-	// instance info
-	request.Cpu = helper.IntInt64(d.Get("instance_cpu_core").(int))
-	request.Memory = helper.IntInt64(d.Get("instance_memory_size").(int))
+	isServerless := d.Get("db_mode").(string) == CYNOSDB_SERVERLESS
+	if v, ok := d.GetOk("instance_cpu_core"); ok {
+		request.Cpu = helper.IntInt64(v.(int))
+	} else if !isServerless {
+		return fmt.Errorf("`instance_cpu_core` is required while creating non-serverless cluster")
+	}
+	if v, ok := d.GetOk("instance_memory_size"); ok {
+		request.Memory = helper.IntInt64(v.(int))
+	} else if !isServerless {
+		return fmt.Errorf("`instance_memory_size` is required while creating non-serverless cluster")
+	}
 
 	var chargeType int64 = 0
 	if v, ok := d.GetOk("charge_type"); ok {
@@ -312,7 +335,7 @@ func resourceTencentCloudCynosdbClusterRead(d *schema.ResourceData, meta interfa
 
 	client := meta.(*TencentCloudClient).apiV3Conn
 	cynosdbService := CynosdbService{client: client}
-	renewFlag, cluster, has, err := cynosdbService.DescribeClusterById(ctx, id)
+	item, cluster, has, err := cynosdbService.DescribeClusterById(ctx, id)
 	if err != nil {
 		return err
 	}
@@ -334,7 +357,11 @@ func resourceTencentCloudCynosdbClusterRead(d *schema.ResourceData, meta interfa
 	_ = d.Set("cluster_status", cluster.Status)
 	_ = d.Set("create_time", cluster.CreateTime)
 	_ = d.Set("storage_used", *cluster.UsedStorage/1000/1000)
-	_ = d.Set("auto_renew_flag", renewFlag)
+	_ = d.Set("auto_renew_flag", *item.RenewFlag)
+
+	if _, ok := d.GetOk("db_mode"); ok || *item.DbMode == CYNOSDB_SERVERLESS {
+		_ = d.Set("db_mode", item.DbMode)
+	}
 
 	//tag
 	tagService := &TagService{client: client}
@@ -357,8 +384,10 @@ func resourceTencentCloudCynosdbClusterRead(d *schema.ResourceData, meta interfa
 			if err != nil {
 				return err
 			}
-			_ = d.Set("instance_cpu_core", instance.Cpu)
-			_ = d.Set("instance_memory_size", instance.Memory)
+			if *item.DbMode != CYNOSDB_SERVERLESS {
+				_ = d.Set("instance_cpu_core", instance.Cpu)
+				_ = d.Set("instance_memory_size", instance.Memory)
+			}
 			_ = d.Set("instance_id", instance.InstanceId)
 			_ = d.Set("instance_name", instance.InstanceName)
 			_ = d.Set("instance_status", instance.Status)
@@ -485,6 +514,19 @@ func resourceTencentCloudCynosdbClusterUpdate(d *schema.ResourceData, meta inter
 		tagService     = TagService{client: client}
 		region         = client.Region
 	)
+	immutableArgs := []string{
+		"db_mode",
+		"min_cpu",
+		"max_cpu",
+		"auto_pause",
+		"auto_pause_delay",
+	}
+
+	for _, a := range immutableArgs {
+		if d.HasChange(a) {
+			return fmt.Errorf("argument %s cannot be modified", a)
+		}
+	}
 
 	d.Partial(true)
 

tencentcloud/resource_tc_cynosdb_cluster_test.go

@@ -128,6 +128,37 @@ func TestAccTencentCloudCynosdbClusterResource(t *testing.T) {
 		},
 	})
 }
+func TestAccTencentCloudCynosdbClusterResourceServerless(t *testing.T) {
+	t.Parallel()
+	resource.Test(t, resource.TestCase{
+		PreCheck:     func() { testAccPreCheck(t) },
+		Providers:    testAccProviders,
+		CheckDestroy: testAccCheckCynosdbClusterDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccCynosdbClusterServerless,
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckCynosdbClusterExists("tencentcloud_cynosdb_cluster.foo"),
+					resource.TestCheckResourceAttr("tencentcloud_cynosdb_cluster.foo", "db_mode", "SERVERLESS"),
+				),
+			},
+			{
+				ResourceName:      "tencentcloud_cynosdb_cluster.foo",
+				ImportState:       true,
+				ImportStateVerify: true,
+				ImportStateVerifyIgnore: []string{
+					"password",
+					"force_delete",
+					"storage_limit",
+					"min_cpu",
+					"max_cpu",
+					"auto_pause",
+					"auto_pause_delay",
+				},
+			},
+		},
+	})
+}
 
 func testAccCheckCynosdbClusterDestroy(s *terraform.State) error {
 	logId := getLogId(contextNil)
@@ -179,7 +210,7 @@ func testAccCheckCynosdbClusterExists(n string) resource.TestCheckFunc {
 	}
 }
 
-const testAccCynosdbBasic = `
+const testAccCynosdbBasic = defaultSecurityGroupData + `
 variable "availability_zone" {
   default = "ap-guangzhou-4"
 }
@@ -237,10 +268,10 @@ resource "tencentcloud_cynosdb_cluster" "foo" {
   force_delete = true
 
   rw_group_sg = [
-    "` + defaultSecurityGroup + `",
+    local.sg_id
   ]
   ro_group_sg = [
-    "` + defaultSecurityGroup + `",
+    local.sg_id
   ]
   prarm_template_id = var.my_param_template
 }
@@ -289,10 +320,39 @@ resource "tencentcloud_cynosdb_cluster" "foo" {
   force_delete = true
 
   rw_group_sg = [
-    "` + defaultSecurityGroup2 + `",
+    local.sg_id2
   ]
   ro_group_sg = [
-    "` + defaultSecurityGroup2 + `",
+    local.sg_id2
   ]
 }
 `
+
+const testAccCynosdbClusterServerless = testAccCynosdbBasic + `
+resource "tencentcloud_cynosdb_cluster" "foo" {
+  available_zone               = var.availability_zone
+  vpc_id                       = var.my_vpc
+  subnet_id                    = var.my_subnet
+  db_type                      = "MYSQL"
+  db_version                   = "5.7"
+  cluster_name                 = "tf-cynosdb-s"
+  password                     = "cynos@123"
+  db_mode                      = "SERVERLESS"
+  min_cpu 					   = 0.25
+  max_cpu 					   = 1
+  auto_pause 				   = "yes"
+  auto_pause_delay 			   = 1000
+  instance_maintain_duration   = 3600
+  instance_maintain_start_time = 10800
+  instance_maintain_weekdays   = [
+    "Fri",
+    "Mon",
+    "Sat",
+    "Sun",
+    "Thu",
+    "Wed",
+    "Tue",
+  ]
+
+  force_delete = true
+}`

tencentcloud/service_tencentcloud_cynosdb.go

@@ -81,7 +81,12 @@ func (me *CynosdbService) DescribeClusters(ctx context.Context, filters map[stri
 	return
 }
 
-func (me *CynosdbService) DescribeClusterById(ctx context.Context, clusterId string) (renewFlag int64, clusterInfo *cynosdb.CynosdbClusterDetail, has bool, errRet error) {
+/**
+Return values:
+	clusterItem: ResponseBody of DescribeClusters, include `renew_flag` and `db_mode`
+    clusterInfo: ResponseBody of DescribeClusterDetailResponse, primary args setter.
+*/
+func (me *CynosdbService) DescribeClusterById(ctx context.Context, clusterId string) (clusterItem *cynosdb.CynosdbCluster, clusterInfo *cynosdb.CynosdbClusterDetail, has bool, errRet error) {
 	logId := getLogId(ctx)
 	request := cynosdb.NewDescribeClusterDetailRequest()
 	request.ClusterId = &clusterId
@@ -102,15 +107,20 @@ func (me *CynosdbService) DescribeClusterById(ctx context.Context, clusterId str
 		if len(clusters) != 1 {
 			return resource.NonRetryableError(fmt.Errorf("[CRITAL] mutiple cluster found by cluster id %s", clusterId))
 		}
-		if *clusters[0].Status == CYNOSDB_STATUS_ISOLATED || *clusters[0].Status == CYNOSDB_STATUS_OFFLINE || *clusters[0].Status == CYNOSDB_STATUS_DELETED {
-			notExist = true
+		clusterItem = clusters[0]
+		clusterStatus := clusterItem.Status
+		if clusterStatus == nil {
+			return resource.NonRetryableError(fmt.Errorf("cluster %s status is nil", clusterId))
+		}
+		if *clusterStatus == CYNOSDB_STATUS_RUNNING {
 			return nil
-		} else if *clusters[0].Status == CYNOSDB_STATUS_RUNNING {
-			renewFlag = *clusters[0].RenewFlag
+		}
+		if *clusterStatus == CYNOSDB_STATUS_ISOLATED || *clusterStatus == CYNOSDB_STATUS_OFFLINE || *clusterStatus == CYNOSDB_STATUS_DELETED {
+			notExist = true
 			return nil
-		} else {
-			return resource.RetryableError(fmt.Errorf("cynosdb cluster %s is still in processing", clusterId))
 		}
+
+		return resource.RetryableError(fmt.Errorf("cynosdb cluster %s is still in processing", clusterId))
 	})
 	if errRet != nil || notExist {
 		return

website/docs/r/cynosdb_cluster.html.markdown

@@ -68,17 +68,22 @@ The following arguments are supported:
 * `cluster_name` - (Required, String, ForceNew) Name of CynosDB cluster.
 * `db_type` - (Required, String, ForceNew) Type of CynosDB, and available values include `MYSQL`.
 * `db_version` - (Required, String, ForceNew) Version of CynosDB, which is related to `db_type`. For `MYSQL`, available value is `5.7`.
-* `instance_cpu_core` - (Required, Int) The number of CPU cores of read-write type instance in the CynosDB cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
-* `instance_memory_size` - (Required, Int) Memory capacity of read-write type instance, unit in GB. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
 * `password` - (Required, String, ForceNew) Password of `root` account.
 * `subnet_id` - (Required, String, ForceNew) ID of the subnet within this VPC.
 * `vpc_id` - (Required, String, ForceNew) ID of the VPC.
+* `auto_pause_delay` - (Optional, Int) Specify auto-pause delay in second while `db_mode` is `SERVERLESS`. Value range: `[600, 691200]`. Default: `600`.
+* `auto_pause` - (Optional, String) Specify whether the cluster can auto-pause while `db_mode` is `SERVERLESS`. Values: `yes` (default), `no`.
 * `auto_renew_flag` - (Optional, Int, ForceNew) Auto renew flag. Valid values are `0`(MANUAL_RENEW), `1`(AUTO_RENEW). Default value is `0`. Only works for PREPAID cluster.
 * `charge_type` - (Optional, String, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. Default value is `POSTPAID_BY_HOUR`.
+* `db_mode` - (Optional, String) Specify DB mode, only available when `db_type` is `MYSQL`. Values: `NORMAL` (Default), `SERVERLESS`.
 * `force_delete` - (Optional, Bool) Indicate whether to delete cluster instance directly or not. Default is false. If set true, the cluster and its `All RELATED INSTANCES` will be deleted instead of staying recycle bin. Note: works for both `PREPAID` and `POSTPAID_BY_HOUR` cluster.
+* `instance_cpu_core` - (Optional, Int) The number of CPU cores of read-write type instance in the CynosDB cluster. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
 * `instance_maintain_duration` - (Optional, Int) Duration time for maintenance, unit in second. `3600` by default.
 * `instance_maintain_start_time` - (Optional, Int) Offset time from 00:00, unit in second. For example, 03:00am should be `10800`. `10800` by default.
 * `instance_maintain_weekdays` - (Optional, Set: [`String`]) Weekdays for maintenance. `["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]` by default.
+* `instance_memory_size` - (Optional, Int) Memory capacity of read-write type instance, unit in GB. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
+* `max_cpu` - (Optional, Float64) Maximum CPU core count, required while `db_mode` is `SERVERLESS`, request DescribeServerlessInstanceSpecs for more reference.
+* `min_cpu` - (Optional, Float64) Minimum CPU core count, required while `db_mode` is `SERVERLESS`, request DescribeServerlessInstanceSpecs for more reference.
 * `param_items` - (Optional, List) Specify parameter list of database. It is valid when prarm_template_id is set in create cluster. Use `data.tencentcloud_mysql_default_params` to query available parameter details.
 * `port` - (Optional, Int, ForceNew) Port of CynosDB cluster.
 * `prarm_template_id` - (Optional, Int) The ID of the parameter template.

website/docs/r/cynosdb_readonly_instance.html.markdown

@@ -40,13 +40,13 @@ resource "tencentcloud_cynosdb_readonly_instance" "foo" {
 The following arguments are supported:
 
 * `cluster_id` - (Required, String, ForceNew) Cluster ID which the readonly instance belongs to.
-* `instance_cpu_core` - (Required, Int) The number of CPU cores of read-write type instance in the CynosDB cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
-* `instance_memory_size` - (Required, Int) Memory capacity of read-write type instance, unit in GB. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
 * `instance_name` - (Required, String, ForceNew) Name of instance.
 * `force_delete` - (Optional, Bool) Indicate whether to delete readonly instance directly or not. Default is false. If set true, instance will be deleted instead of staying recycle bin. Note: works for both `PREPAID` and `POSTPAID_BY_HOUR` cluster.
+* `instance_cpu_core` - (Optional, Int) The number of CPU cores of read-write type instance in the CynosDB cluster. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
 * `instance_maintain_duration` - (Optional, Int) Duration time for maintenance, unit in second. `3600` by default.
 * `instance_maintain_start_time` - (Optional, Int) Offset time from 00:00, unit in second. For example, 03:00am should be `10800`. `10800` by default.
 * `instance_maintain_weekdays` - (Optional, Set: [`String`]) Weekdays for maintenance. `["Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"]` by default.
+* `instance_memory_size` - (Optional, Int) Memory capacity of read-write type instance, unit in GB. Required while creating normal cluster. Note: modification of this field will take effect immediately, if want to upgrade on maintenance window, please upgrade from console.
 
 ## Attributes Reference