mongodb sharding support availability_zone_list (#1582)

* mongodb sharding support availability_zone_list

* add changelog

* update

---------

Co-authored-by: mikatong <mikatong@tencent.com>

Author: tongyiming

.changelog/1582.txt

@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/tencentcloud_mongodb_sharding_instance: support `availability_zone_list` and `hidden_zone`.
+```

go.mod

@@ -36,7 +36,7 @@ require (
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/clb v1.0.599
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cloudaudit v1.0.544
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cls v1.0.412
-	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.600
+	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.606
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm v1.0.553
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cwp v1.0.589
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cynosdb v1.0.572
@@ -54,7 +54,7 @@ require (
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/lighthouse v1.0.413
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/live v1.0.535
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mariadb v1.0.532
-	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.600
+	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.606
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/monitor v1.0.518
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mps v1.0.584
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/organization v1.0.540

go.sum

@@ -531,6 +531,8 @@ github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.599 h1:9rMF
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.599/go.mod h1:7sCQWVkxcsR38nffDW057DRGk8mUjK1Ing/EFOK8s8Y=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.600 h1:rYI1ZQUubjG6r87H65nn5Zwfo5J03rcFxefmVek+Wis=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.600/go.mod h1:7sCQWVkxcsR38nffDW057DRGk8mUjK1Ing/EFOK8s8Y=
+github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.606 h1:3Y3xlzSikB9BfKIfrTXQpwzeW97cxetqyq1kuMaMc08=
+github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.606/go.mod h1:7sCQWVkxcsR38nffDW057DRGk8mUjK1Ing/EFOK8s8Y=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm v1.0.553 h1:Pl1kYgFhJp0QSoVFSzRsiGk+HfEAkBTQg7+O60tytNA=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm v1.0.553/go.mod h1:dnnqPxXYK+kax3e1MKo/PI3iWJtytm6ogWKQHJS7SGE=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cwp v1.0.589 h1:LZihgirMH0vsaGScYexxwY0fTss9vHaSZs/YOQUVESg=
@@ -570,6 +572,8 @@ github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.588 h1:VfI
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.588/go.mod h1:bAyanoZH6UqaapJOc6hTZACz/hi5AWJw2sa6oCQ5u0Y=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.600 h1:lcKfsxsVw2PnU8CzCAOrrteEVC5dPwzGUCxSTYdC5ys=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.600/go.mod h1:xdx+BE6goMwlA9R0S4xCGT4R9C5uIJ1qRPhmc1xVnt8=
+github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.606 h1:Fs1WyS5uw0MMVdKufxNSOEBe4DkybSiBkMAy1131/gg=
+github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb v1.0.606/go.mod h1:XrotKKNeP8jLqt4I9LSoIGpLt1UPd2MnLpxFNrJrts4=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/monitor v1.0.518 h1:XClo3Xa5F9pko91olHT85aZXXcRkQiOYBCMqm8+tHG8=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/monitor v1.0.518/go.mod h1:WDTvvrrc90KE+90iizkoSQRsoSSQ3881eBC6NeypmTI=
 github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mps v1.0.584 h1:FJxYOAolkBhXjQMWoiTek9Ag0bslcKFHyrM7w2Jsxos=

tencentcloud/basic_test.go

@@ -725,6 +725,10 @@ locals {
 // End of TKE Service
 
 // MongoDB
+const (
+	defaultMongoDBVPCId    = "vpc-rwj54lfr"
+	defaultMongoDBSubnetId = "subnet-nyt57zps"
+)
 const defaultMongoDBSecurityGroupId = "sg-if748odn"
 const DefaultMongoDBSpec = `
 data "tencentcloud_mongodb_zone_config" "zone_config" {
@@ -741,6 +745,12 @@ variable "engine_versions" {
 variable "sg_id" {
   default = "` + defaultMongoDBSecurityGroupId + `"
 }
+variable "vpc_id" {
+  default = "` + defaultMongoDBVPCId + `"
+}
+variable "subnet_id" {
+  default = "` + defaultMongoDBSubnetId + `"
+}
 
 locals {
   filtered_spec = [for i in data.tencentcloud_mongodb_zone_config.zone_config.list: i if lookup(i, "machine_type") == "HIO10G" && lookup(i, "engine_version") != "3.2"]

tencentcloud/resource_tc_mongodb_sharding_instance.go

@@ -64,6 +64,27 @@ func resourceTencentCloudMongodbShardingInstance() *schema.Resource {
 			ValidateFunc: validateIntegerInRange(3, 5),
 			Description:  "Number of nodes per shard, at least 3(one master and two slaves).",
 		},
+		"availability_zone_list": {
+			Type:     schema.TypeList,
+			Optional: true,
+			Computed: true,
+			Elem: &schema.Schema{
+				Type: schema.TypeString,
+			},
+			RequiredWith: []string{"hidden_zone"},
+			Description: `A list of nodes deployed in multiple availability zones. For more information, please use the API DescribeSpecInfo.
+			- Multi-availability zone deployment nodes can only be deployed in 3 different availability zones. It is not supported to deploy most nodes of the cluster in the same availability zone. For example, a 3-node cluster does not support the deployment of 2 nodes in the same zone.
+			- Version 4.2 and above are not supported.
+			- Read-only disaster recovery instances are not supported.
+			- Basic network cannot be selected.`,
+		},
+		"hidden_zone": {
+			Type:         schema.TypeString,
+			Optional:     true,
+			Computed:     true,
+			RequiredWith: []string{"availability_zone_list"},
+			Description:  "The availability zone to which the Hidden node belongs. This parameter must be configured to deploy instances across availability zones.",
+		},
 	}
 	basic := TencentMongodbBasicInfo()
 	for k, v := range basic {
@@ -166,6 +187,13 @@ func mongodbAllShardingInstanceReqSet(requestInter interface{}, d *schema.Resour
 	if v, ok := d.GetOk("mongos_node_num"); ok {
 		value.FieldByName("MongosNodeNum").Set(reflect.ValueOf(helper.IntUint64(v.(int))))
 	}
+	if v, ok := d.GetOk("availability_zone_list"); ok {
+		availabilityZoneList := helper.InterfacesStringsPoint(v.([]interface{}))
+		value.FieldByName("AvailabilityZoneList").Set(reflect.ValueOf(availabilityZoneList))
+	}
+	if v, ok := d.GetOk("hidden_zone"); ok {
+		value.FieldByName("HiddenZone").Set(reflect.ValueOf(helper.String(v.(string))))
+	}
 	return nil
 }
 
@@ -385,6 +413,23 @@ func resourceMongodbShardingInstanceRead(d *schema.ResourceData, meta interface{
 	}
 	_ = d.Set("security_groups", groupIds)
 
+	replicateSets, err := mongodbService.DescribeDBInstanceNodeProperty(ctx, instanceId)
+	if err != nil {
+		return err
+	}
+	if len(replicateSets) > 1 {
+		var hiddenZone string
+		availabilityZoneList := make([]string, 0, 3)
+		for _, replicate := range replicateSets[0].Nodes {
+			itemZone := *replicate.Zone
+			if *replicate.Hidden {
+				hiddenZone = itemZone
+			}
+			availabilityZoneList = append(availabilityZoneList, itemZone)
+		}
+		_ = d.Set("hidden_zone", hiddenZone)
+		_ = d.Set("availability_zone_list", availabilityZoneList)
+	}
 	tags := make(map[string]string, len(instance.Tags))
 	for _, tag := range instance.Tags {
 		if tag.TagKey == nil {
@@ -418,8 +463,11 @@ func resourceMongodbShardingInstanceUpdate(d *schema.ResourceData, meta interfac
 	region := client.Region
 
 	d.Partial(true)
+	if d.HasChange("availability_zone_list") || d.HasChange("hidden_zone") {
+		return fmt.Errorf("setting of the field[availability_zone_list, hidden_zone] does not support update")
+	}
 	if d.HasChange("mongos_cpu") || d.HasChange("mongos_memory") || d.HasChange("mongos_node_num") {
-		return fmt.Errorf("setting of the field[mongos_cpu, mongos_memory, mongos_node_numZ] does not support update")
+		return fmt.Errorf("setting of the field[mongos_cpu, mongos_memory, mongos_node_num] does not support update")
 	}
 	if d.HasChange("memory") || d.HasChange("volume") {
 		memory := d.Get("memory").(int)

tencentcloud/resource_tc_mongodb_sharding_instance_test.go

@@ -27,7 +27,7 @@ func TestAccTencentCloudMongodbShardingInstanceResource_postpaid(t *testing.T) {
 					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb", "volume"),
 					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb", "engine_version"),
 					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb", "machine_type"),
-					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "available_zone", "ap-guangzhou-6"),
+					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "available_zone", "ap-guangzhou-3"),
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "project_id", "0"),
 					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb", "status"),
 					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb", "vip"),
@@ -36,7 +36,9 @@ func TestAccTencentCloudMongodbShardingInstanceResource_postpaid(t *testing.T) {
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "tags.test", "test"),
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "charge_type", MONGODB_CHARGE_TYPE_POSTPAID),
 					resource.TestCheckNoResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "prepaid_period"),
-					resource.TestCheckNoResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "security_groups"),
+					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb", "security_groups.#"),
+					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb", "hidden_zone"),
+					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb", "availability_zone_list.#", "3"),
 				),
 			},
 			{
@@ -72,7 +74,7 @@ func TestAccTencentCloudMongodbShardingInstanceResource_prepaid(t *testing.T) {
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "instance_name", "tf-mongodb-sharding-prepaid"),
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "shard_quantity", "2"),
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "nodes_per_shard", "3"),
-					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "available_zone", "ap-guangzhou-6"),
+					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "available_zone", "ap-guangzhou-3"),
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "project_id", "0"),
 					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "status"),
 					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "vip"),
@@ -82,6 +84,8 @@ func TestAccTencentCloudMongodbShardingInstanceResource_prepaid(t *testing.T) {
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "charge_type", MONGODB_CHARGE_TYPE_PREPAID),
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "prepaid_period", "1"),
 					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "auto_renew_flag", "0"),
+					resource.TestCheckResourceAttrSet("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "hidden_zone"),
+					resource.TestCheckResourceAttr("tencentcloud_mongodb_sharding_instance.mongodb_prepaid", "availability_zone_list.#", "3"),
 				),
 			},
 			{
@@ -130,7 +134,7 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb" {
   volume          = local.sharding_volume
   engine_version  = local.sharding_engine_version
   machine_type    = local.sharding_machine_type
-  available_zone  = "ap-guangzhou-6"
+  available_zone  = "ap-guangzhou-3"
   project_id      = 0
   password        = "test1234"
   mongos_cpu = 1
@@ -140,6 +144,10 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb" {
     test = "test"
   }
   security_groups = [var.sg_id]
+  vpc_id = var.vpc_id
+  subnet_id = var.subnet_id
+  availability_zone_list = ["ap-guangzhou-3", "ap-guangzhou-4", "ap-guangzhou-6"]
+  hidden_zone = "ap-guangzhou-6"
 }
 `
 
@@ -152,7 +160,7 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb" {
   volume          = local.sharding_volume
   engine_version  = local.sharding_engine_version
   machine_type    = local.sharding_machine_type
-  available_zone  = "ap-guangzhou-6"
+  available_zone  = "ap-guangzhou-3"
   project_id      = 0
   password        = "test1234update"
   mongos_cpu = 1
@@ -163,6 +171,10 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb" {
     abc = "abc"
   }
   security_groups = [var.sg_id]
+  vpc_id = var.vpc_id
+  subnet_id = var.subnet_id
+  availability_zone_list = ["ap-guangzhou-3", "ap-guangzhou-4", "ap-guangzhou-6"]
+  hidden_zone = "ap-guangzhou-6"
 }
 `
 
@@ -175,7 +187,7 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb_prepaid" {
   volume          = local.sharding_volume
   engine_version  = local.sharding_engine_version
   machine_type    = local.sharding_machine_type
-  available_zone  = "ap-guangzhou-6"
+  available_zone  = "ap-guangzhou-3"
   project_id      = 0
   password        = "test1234"
   charge_type     = "PREPAID"
@@ -188,6 +200,10 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb_prepaid" {
   tags = {
     test = "test-prepaid"
   }
+  vpc_id = var.vpc_id
+  subnet_id = var.subnet_id
+  availability_zone_list = ["ap-guangzhou-3", "ap-guangzhou-4", "ap-guangzhou-6"]
+  hidden_zone = "ap-guangzhou-6"
 }
 `
 
@@ -200,7 +216,7 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb_prepaid" {
   volume          = local.sharding_volume
   engine_version  = local.sharding_engine_version
   machine_type    = local.sharding_machine_type
-  available_zone  = "ap-guangzhou-6"
+  available_zone  = "ap-guangzhou-3"
   project_id      = 0
   password        = "test1234update"
   charge_type     = "PREPAID"
@@ -213,5 +229,9 @@ resource "tencentcloud_mongodb_sharding_instance" "mongodb_prepaid" {
   tags = {
     prepaid = "prepaid"
   }
+  vpc_id = var.vpc_id
+  subnet_id = var.subnet_id
+  availability_zone_list = ["ap-guangzhou-3", "ap-guangzhou-4", "ap-guangzhou-6"]
+  hidden_zone = "ap-guangzhou-6"
 }
 `

tencentcloud/service_tencentcloud_mongodb.go

@@ -413,3 +413,22 @@ func (me *MongodbService) DescribeSecurityGroup(ctx context.Context, instanceId
 	groups = response.Response.Groups
 	return
 }
+
+func (me *MongodbService) DescribeDBInstanceNodeProperty(ctx context.Context, instanceId string) (replicateSets []*mongodb.ReplicateSetInfo, errRet error) {
+	logId := getLogId(ctx)
+	request := mongodb.NewDescribeDBInstanceNodePropertyRequest()
+	request.InstanceId = helper.String(instanceId)
+	ratelimit.Check(request.GetAction())
+	response, err := me.client.UseMongodbClient().DescribeDBInstanceNodeProperty(request)
+	if err != nil {
+		log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%s]",
+			logId, request.GetAction(), request.ToJsonString(), err.Error())
+		errRet = err
+		return
+	}
+	log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]",
+		logId, request.GetAction(), request.ToJsonString(), response.ToJsonString())
+
+	replicateSets = response.Response.ReplicateSets
+	return
+}