Merge pull request #20 from volcengine/feat/doc

Feat/doc

common/common_volcengine_convert.go

@@ -100,6 +100,12 @@ func ResponseToResourceData(d *schema.ResourceData, resource *schema.Resource, d
 						} else {
 							targetValue = v
 						}
+					} else if _, ok3 := r.Elem.(schema.ValueType); ok3 {
+						if convert.Convert != nil {
+							targetValue = convert.Convert(v)
+						} else {
+							targetValue = v
+						}
 					}
 				} else {
 					if convert.Convert != nil {

common/common_volcengine_version.go

@@ -2,5 +2,5 @@ package common
 
 const (
 	TerraformProviderName    = "terraform-provider-volcengine"
-	TerraformProviderVersion = "0.0.17"
+	TerraformProviderVersion = "0.0.18"
 )

example/clb/main.tf

@@ -1,7 +1,7 @@
 resource "volcengine_clb" "foo" {
   type = "public"
-  subnet_id = "subnet-2744i7u9alnnk7fap8tkq8aft"
+  subnet_id = "subnet-273xjcb6wohs07fap8sz3ihhs"
   load_balancer_spec = "small_1"
-  region_id = "cn-north-3"
   description = "Demo"
+  load_balancer_name = "terraform-auto-create"
 }

example/listener/main.tf

@@ -1,19 +1,55 @@
 resource "volcengine_listener" "foo" {
-  load_balancer_id = "clb-273ylkl0a3i807fap8t4unbsq"
+  load_balancer_id = "clb-274xltt3rfmyo7fap8sv1jq39"
   listener_name = "Demo-HTTP-90"
   protocol = "HTTP"
   port = 90
-  server_group_id = "rsp-273yv0kir1vk07fap8tt9jtwg"
+  server_group_id = "rsp-274xltv2sjoxs7fap8tlv3q3s"
   health_check {
     enabled = "on"
     interval = 10
     timeout = 3
     healthy_threshold = 5
     un_healthy_threshold = 2
-    domain = "github.com"
+    domain = "volcengine.com"
     http_code = "http_2xx"
     method = "GET"
     uri = "/"
   }
   enabled = "on"
+}
+
+resource "volcengine_listener" "bar" {
+  load_balancer_id = "clb-274xltt3rfmyo7fap8sv1jq39"
+  listener_name = "Demo-HTTP-91"
+  protocol = "HTTP"
+  port = 91
+  server_group_id = "rsp-274xltv2sjoxs7fap8tlv3q3s"
+  health_check {
+    enabled = "on"
+    interval = 10
+    timeout = 3
+    healthy_threshold = 5
+    un_healthy_threshold = 2
+    domain = "volcengine.com"
+    http_code = "http_2xx"
+    method = "GET"
+    uri = "/"
+  }
+  enabled = "on"
+}
+
+resource "volcengine_listener" "demo" {
+  load_balancer_id = "clb-274xltt3rfmyo7fap8sv1jq39"
+  protocol = "TCP"
+  port = 92
+  server_group_id = "rsp-274xltv2sjoxs7fap8tlv3q3s"
+  health_check {
+    enabled = "on"
+    interval = 10
+    timeout = 3
+    healthy_threshold = 5
+    un_healthy_threshold = 2
+  }
+  enabled = "on"
+  established_timeout = 10
 }

example/serverGroupServer/main.tf

@@ -1,9 +1,8 @@
 resource "volcengine_server_group_server" "foo" {
-  server_group_id = "rsp-273zn4ewlhkw07fap8tig9ujz"
-  instance_id = "i-72q1zvko6i5lnawvg940"
+  server_group_id = "rsp-274xltv2sjoxs7fap8tlv3q3s"
+  instance_id = "i-ybp1scasbe72q1vq35wv"
   type = "ecs"
   weight = 100
-  ip = "192.168.100.99"
   port = 80
   description = "This is a server"
 }

volcengine/clb/clb/resource_volcengine_clb.go

@@ -30,7 +30,8 @@ func ResourceVolcengineClb() *schema.Resource {
 		Schema: map[string]*schema.Schema{
 			"region_id": {
 				Type:        schema.TypeString,
-				Required:    true,
+				Optional:    true,
+				Computed:    true,
 				ForceNew:    true,
 				Description: "The region of the request.",
 			},
@@ -75,7 +76,7 @@ func ResourceVolcengineClb() *schema.Resource {
 			"modification_protection_status": {
 				Type:         schema.TypeString,
 				Optional:     true,
-				Description:  "The status of the console modification protection.",
+				Description:  "The status of the console modification protection, the value can be `NonProtection` or `ConsoleProtection`.",
 				ValidateFunc: validation.StringInSlice([]string{"NonProtection", "ConsoleProtection"}, false),
 			},
 			"modification_protection_reason": {
@@ -86,14 +87,14 @@ func ResourceVolcengineClb() *schema.Resource {
 			"load_balancer_spec": {
 				Type:        schema.TypeString,
 				Required:    true,
-				Description: "The specification of the CLB.",
+				Description: "The specification of the CLB, the value can be `small_1`, `small_2`, `medium_1`, `medium_2`, `large_1`, `large_2`.",
 			},
 			"load_balancer_billing_type": {
 				Type:         schema.TypeString,
 				Optional:     true,
 				Computed:     true,
 				ForceNew:     true,
-				Description:  "The billing type of the CLB.",
+				Description:  "The billing type of the CLB, the value can be `PostPaid`.",
 				ValidateFunc: validation.StringInSlice([]string{"PostPaid"}, false),
 			},
 			//"period_unit": {

volcengine/clb/clb/service_volcengine_clb.go

@@ -86,6 +86,9 @@ func (s *VolcengineClbService) ReadResource(resourceData *schema.ResourceData, c
 	if len(data) == 0 {
 		return data, fmt.Errorf("Clb %s not exist ", clbId)
 	}
+
+	data["RegionId"] = *s.Client.ClbClient.Config.Region
+
 	return data, err
 }
 
@@ -171,6 +174,14 @@ func (s *VolcengineClbService) CreateResource(resourceData *schema.ResourceData,
 					},
 				},
 			},
+			BeforeCall: func(d *schema.ResourceData, client *ve.SdkClient, call ve.SdkCall) (bool, error) {
+				if regionId, ok := (*call.SdkParam)["RegionId"]; !ok {
+					(*call.SdkParam)["RegionId"] = *s.Client.ClbClient.Config.Region
+				} else if regionId.(string) != *s.Client.ClbClient.Config.Region {
+					return false, fmt.Errorf("region_id is not equal to provider region config(%s)", *s.Client.ClbClient.Config.Region)
+				}
+				return true, nil
+			},
 			ExecuteCall: func(d *schema.ResourceData, client *ve.SdkClient, call ve.SdkCall) (*map[string]interface{}, error) {
 				logger.Debug(logger.RespFormat, call.Action, call.SdkParam)
 				//创建clb

volcengine/clb/listener/resource_volcengine_listener.go

@@ -56,7 +56,7 @@ func ResourceVolcengineListener() *schema.Resource {
 				Type:        schema.TypeInt,
 				Required:    true,
 				ForceNew:    true,
-				Description: "The port receiving request of the Listener.",
+				Description: "The port receiving request of the Listener, the value range in 1~65535.",
 			},
 			"scheduler": {
 				Type:         schema.TypeString,
@@ -139,31 +139,31 @@ func ResourceVolcengineListener() *schema.Resource {
 						"interval": {
 							Type:             schema.TypeInt,
 							Optional:         true,
-							Description:      "The interval executing health check.",
+							Description:      "The interval executing health check, default 2, range in 1~300.",
 							DiffSuppressFunc: HealthCheckFieldDiffSuppress,
 						},
 						"timeout": {
 							Type:             schema.TypeInt,
 							Optional:         true,
-							Description:      "The response timeout of health check.",
+							Description:      "The response timeout of health check, default 2, range in 1~60..",
 							DiffSuppressFunc: HealthCheckFieldDiffSuppress,
 						},
 						"healthy_threshold": {
 							Type:             schema.TypeInt,
 							Optional:         true,
-							Description:      "The healthy threshold of health check.",
+							Description:      "The healthy threshold of health check, default 3, range in 2~10.",
 							DiffSuppressFunc: HealthCheckFieldDiffSuppress,
 						},
 						"un_healthy_threshold": {
 							Type:             schema.TypeInt,
 							Optional:         true,
-							Description:      "The unhealthy threshold of health check.",
+							Description:      "The unhealthy threshold of health check, default 3, range in 2~10.",
 							DiffSuppressFunc: HealthCheckFieldDiffSuppress,
 						},
 						"method": {
 							Type:             schema.TypeString,
 							Optional:         true,
-							Description:      "The method of health check.",
+							Description:      "The method of health check, the value can be `GET` or `HEAD`.",
 							DiffSuppressFunc: HealthCheckHTTPOnlyFieldDiffSuppress,
 						},
 						"domain": {
@@ -181,7 +181,7 @@ func ResourceVolcengineListener() *schema.Resource {
 						"http_code": {
 							Type:             schema.TypeString,
 							Optional:         true,
-							Description:      "The normal http status code of health check.",
+							Description:      "The normal http status code of health check, the value can be `http_2xx` or `http_3xx` or `http_4xx` or `http_5xx`.",
 							DiffSuppressFunc: HealthCheckHTTPOnlyFieldDiffSuppress,
 						},
 					},

volcengine/clb/listener/service_volcengine_listener.go

@@ -90,32 +90,40 @@ func (s *VolcengineListenerService) ReadResource(resourceData *schema.ResourceDa
 
 	clbClient := s.Client.ClbClient
 
-	listenerAttr, err := clbClient.DescribeListenerAttributesCommon(&map[string]interface{}{
+	listenerResp, err := clbClient.DescribeListenerAttributesCommon(&map[string]interface{}{
 		"ListenerId": listenerId,
 	})
 	if err != nil {
 		return nil, err
 	}
-	timeout, err := ve.ObtainSdkValue("Result.EstablishedTimeout", *listenerAttr)
+
+	listenerAttrMap := make(map[string]interface{})
+
+	timeout, err := ve.ObtainSdkValue("Result.EstablishedTimeout", *listenerResp)
 	if err != nil {
 		return nil, err
 	}
-	desc, err := ve.ObtainSdkValue("Result.Description", *listenerAttr)
+	desc, err := ve.ObtainSdkValue("Result.Description", *listenerResp)
 	if err != nil {
 		return nil, err
 	}
-	loadBalancerId, err := ve.ObtainSdkValue("Result.LoadBalancerId", *listenerAttr)
+	loadBalancerId, err := ve.ObtainSdkValue("Result.LoadBalancerId", *listenerResp)
 	if err != nil {
 		return nil, err
 	}
-	scheduler, err := ve.ObtainSdkValue("Result.Scheduler", *listenerAttr)
+	scheduler, err := ve.ObtainSdkValue("Result.Scheduler", *listenerResp)
 	if err != nil {
 		return nil, err
 	}
-	_ = resourceData.Set("established_timeout", int(timeout.(float64)))
-	_ = resourceData.Set("description", desc.(string))
-	_ = resourceData.Set("load_balancer_id", loadBalancerId.(string))
-	_ = resourceData.Set("scheduler", scheduler.(string))
+
+	listenerAttrMap["EstablishedTimeout"] = timeout
+	listenerAttrMap["Description"] = desc
+	listenerAttrMap["LoadBalancerId"] = loadBalancerId
+	listenerAttrMap["Scheduler"] = scheduler
+
+	for k, v := range listenerAttrMap {
+		data[k] = v
+	}
 
 	return data, err
 }
@@ -147,7 +155,7 @@ func (s *VolcengineListenerService) RefreshResourceState(resourceData *schema.Re
 
 }
 
-func (VolcengineListenerService) WithResourceResponseHandlers(listener map[string]interface{}) []ve.ResourceResponseHandler {
+func (*VolcengineListenerService) WithResourceResponseHandlers(listener map[string]interface{}) []ve.ResourceResponseHandler {
 	handler := func() (map[string]interface{}, map[string]ve.ResponseConvert, error) {
 		return listener, nil, nil
 	}
@@ -168,6 +176,23 @@ func (s *VolcengineListenerService) CreateResource(resourceData *schema.Resource
 					ConvertType: ve.ConvertListUnique,
 				},
 			},
+			BeforeCall: func(d *schema.ResourceData, client *ve.SdkClient, call ve.SdkCall) (bool, error) {
+				protocol := (*call.SdkParam)["Protocol"].(string)
+				// 1. established_timeout
+				if protocol == "HTTP" || protocol == "HTTPS" {
+					// not allow establish_timeout
+					if _, ok := (*call.SdkParam)["EstablishedTimeout"]; ok {
+						return false, errors.New("established_timeout is not allowed for HTTP or HTTPS")
+					}
+				}
+
+				// 2. certificate_id
+				if protocol != "HTTPS" && (*call.SdkParam)["CertificateId"] != nil {
+					return false, errors.New("certificate_id is only allowed for HTTPS")
+				}
+
+				return true, nil
+			},
 			ExecuteCall: func(d *schema.ResourceData, client *ve.SdkClient, call ve.SdkCall) (*map[string]interface{}, error) {
 				logger.Debug(logger.RespFormat, call.Action, call.SdkParam)
 				//创建listener
@@ -220,6 +245,20 @@ func (s *VolcengineListenerService) ModifyResource(resourceData *schema.Resource
 				},
 			},
 			BeforeCall: func(d *schema.ResourceData, client *ve.SdkClient, call ve.SdkCall) (bool, error) {
+				protocol := d.Get("protocol").(string)
+				// 1. established_timeout
+				if protocol == "HTTP" || protocol == "HTTPS" {
+					// not allow establish_timeout
+					if _, ok := (*call.SdkParam)["EstablishedTimeout"]; ok {
+						return false, errors.New("established_timeout is not allowed for HTTP or HTTPS")
+					}
+				}
+
+				// 2. certificate_id
+				if protocol != "HTTPS" && (*call.SdkParam)["CertificateId"] != nil {
+					return false, errors.New("certificate_id is only allowed for HTTPS")
+				}
+
 				(*call.SdkParam)["ListenerId"] = d.Id()
 				aclStatus := d.Get("acl_status")
 				if aclStatus, ok := aclStatus.(string); ok && aclStatus == "on" {

volcengine/clb/server_group_server/resource_volcengine_server_group_server.go

@@ -13,7 +13,7 @@ import (
 Import
 ServerGroupServer can be imported using the id, e.g.
 ```
-$ terraform import volcengine_server_group_server.default rs-3ciynux6i1x4w****rszh49sj
+$ terraform import volcengine_server_group_server.default rsp-274xltv2*****8tlv3q3s:rs-3ciynux6i1x4w****rszh49sj
 ```
 
 */
@@ -30,7 +30,7 @@ func ResourceVolcengineServerGroupServer() *schema.Resource {
 		Schema: map[string]*schema.Schema{
 			"server_group_id": {
 				Type:        schema.TypeString,
-				Optional:    true,
+				Required:    true,
 				ForceNew:    true,
 				Description: "The ID of the ServerGroup.",
 			},
@@ -41,31 +41,32 @@ func ResourceVolcengineServerGroupServer() *schema.Resource {
 			},
 			"instance_id": {
 				Type:        schema.TypeString,
-				Optional:    true,
+				Required:    true,
 				ForceNew:    true,
 				Description: "The ID of ecs instance or the network card bound to ecs instance.",
 			},
 			"type": {
 				Type:         schema.TypeString,
-				Optional:     true,
+				Required:     true,
 				ForceNew:     true,
 				Description:  "The type of instance. Optional choice contains `ecs`, `eni`.",
 				ValidateFunc: validation.StringInSlice([]string{"ecs", "eni"}, false),
 			},
 			"weight": {
 				Type:        schema.TypeInt,
 				Optional:    true,
-				Description: "The weight of the instance.",
+				Description: "The weight of the instance, range in 0~100.",
 			},
 			"ip": {
 				Type:        schema.TypeString,
 				Optional:    true,
 				ForceNew:    true,
+				Computed:    true,
 				Description: "The private ip of the instance.",
 			},
 			"port": {
 				Type:        schema.TypeInt,
-				Optional:    true,
+				Required:    true,
 				Description: "The port receiving request.",
 			},
 			"description": {