feat: redis - support param template (#1432)

* wip: redis - param template

* feat: redis - support parameter template

* fix: redis - ignore missing params override

* changelog 1432

* fix: redis - change param template testcasae fn name

Author: Kagashino

.changelog/1432.txt

@@ -0,0 +1,3 @@
+```release-note:new-resource
+tencentcloud_redis_param_template
+```

tencentcloud/provider.go

@@ -466,6 +466,7 @@ TencentDB for Redis
   Resource
     tencentcloud_redis_instance
     tencentcloud_redis_backup_config
+    tencentcloud_redis_param_template
 
 Serverless Cloud Function(SCF)
   Data Source
@@ -1219,6 +1220,7 @@ func Provider() terraform.ResourceProvider {
 			"tencentcloud_cfs_access_rule":                          resourceTencentCloudCfsAccessRule(),
 			"tencentcloud_redis_instance":                           resourceTencentCloudRedisInstance(),
 			"tencentcloud_redis_backup_config":                      resourceTencentCloudRedisBackupConfig(),
+			"tencentcloud_redis_param_template":                     resourceTencentCloudRedisParamTemplate(),
 			"tencentcloud_as_scaling_config":                        resourceTencentCloudAsScalingConfig(),
 			"tencentcloud_as_scaling_group":                         resourceTencentCloudAsScalingGroup(),
 			"tencentcloud_as_attachment":                            resourceTencentCloudAsAttachment(),

tencentcloud/resource_tc_redis_param_template.go

@@ -0,0 +1,357 @@
+/*
+Provides a resource to create a redis parameter template
+
+Example Usage
+
+```hcl
+resource "tencentcloud_redis_param_template" "param_template" {
+  name = "example-template"
+  description = "This is an example redis param template."
+  product_type = 6
+  params {
+	key = "timeout"
+	value = "7200"
+  }
+}
+```
+
+Copy from another template
+```hcl
+resource "tencentcloud_redis_param_template" "param_template" {
+  name = "example-copied"
+  description = "This is an copied redis param template from xxx."
+  template_id = "xxx"
+  params {
+	key = "timeout"
+	value = "7200"
+  }
+}
+```
+
+
+Import
+
+redis param_template can be imported using the id, e.g.
+```
+$ terraform import tencentcloud_redis_param_template.param_template param_template_id
+```
+*/
+package tencentcloud
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	redis "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/redis/v20180412"
+	"github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/internal/helper"
+)
+
+func resourceTencentCloudRedisParamTemplate() *schema.Resource {
+	return &schema.Resource{
+		Read:   resourceTencentCloudRedisParamTemplateRead,
+		Create: resourceTencentCloudRedisParamTemplateCreate,
+		Update: resourceTencentCloudRedisParamTemplateUpdate,
+		Delete: resourceTencentCloudRedisParamTemplateDelete,
+		Importer: &schema.ResourceImporter{
+			State: schema.ImportStatePassthrough,
+		},
+		Schema: map[string]*schema.Schema{
+			"name": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "Parameter template name.",
+			},
+			"description": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "Parameter template description.",
+			},
+			"product_type": {
+				Type:          schema.TypeInt,
+				Optional:      true,
+				ConflictsWith: []string{"template_id"},
+				Description:   "Specify product type. Valid values: 1 (Redis 2.8 Memory Edition in cluster architecture), 2 (Redis 2.8 Memory Edition in standard architecture), 3 (CKV 3.2 Memory Edition in standard architecture), 4 (CKV 3.2 Memory Edition in cluster architecture), 5 (Redis 2.8 Memory Edition in standalone architecture), 6 (Redis 4.0 Memory Edition in standard architecture), 7 (Redis 4.0 Memory Edition in cluster architecture), 8 (Redis 5.0 Memory Edition in standard architecture), 9 (Redis 5.0 Memory Edition in cluster architecture). If `template_id` is specified, this parameter can be left blank; otherwise, it is required.",
+			},
+			"template_id": {
+				Type:          schema.TypeString,
+				Optional:      true,
+				ConflictsWith: []string{"product_type"},
+				Description:   "Specify which existed template import from.",
+			},
+			"params_override": {
+				Type:        schema.TypeList,
+				Optional:    true,
+				Description: "Specify override parameter list, NOTE: Do not remove override params once set, removing will not take effects to current value.",
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"key": {
+							Type:        schema.TypeString,
+							Required:    true,
+							Description: "Parameter key e.g. `timeout`, check https://www.tencentcloud.com/document/product/239/39796 for more reference.",
+						},
+						"value": {
+							Type:        schema.TypeString,
+							Required:    true,
+							Description: "Parameter value, check https://www.tencentcloud.com/document/product/239/39796 for more reference.",
+						},
+					},
+				},
+			},
+			"param_details": {
+				Type:        schema.TypeList,
+				Computed:    true,
+				Description: "Readonly full parameter list details.",
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"name": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Parameter key name.",
+						},
+						"param_type": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Parameter type.",
+						},
+						"default": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Default value.",
+						},
+						"description": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Parameter description.",
+						},
+						"current_value": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Current value.",
+						},
+						"need_reboot": {
+							Type:        schema.TypeInt,
+							Computed:    true,
+							Description: "Indicates whether to reboot redis instance if modified.",
+						},
+						"max": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Maximum value.",
+						},
+						"min": {
+							Type:        schema.TypeString,
+							Computed:    true,
+							Description: "Minimum value.",
+						},
+						"enum_value": {
+							Type:        schema.TypeList,
+							Computed:    true,
+							Description: "Enum values.",
+							Elem:        &schema.Schema{Type: schema.TypeString},
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+func resourceTencentCloudRedisParamTemplateCreate(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_redis_param_template.create")()
+	defer inconsistentCheck(d, meta)()
+
+	logId := getLogId(contextNil)
+	ctx := context.WithValue(context.TODO(), logIdKey, logId)
+	client := meta.(*TencentCloudClient).apiV3Conn
+	service := RedisService{client: client}
+
+	var (
+		request = redis.NewCreateParamTemplateRequest()
+		id      string
+	)
+
+	if v, ok := d.GetOk("name"); ok {
+		request.Name = helper.String(v.(string))
+	}
+
+	if v, ok := d.GetOk("description"); ok {
+		request.Description = helper.String(v.(string))
+	}
+
+	if v, ok := d.GetOk("product_type"); ok {
+		request.ProductType = helper.IntUint64(v.(int))
+	}
+
+	if v, ok := d.GetOk("template_id"); ok {
+		request.TemplateId = helper.String(v.(string))
+	}
+
+	if v, ok := d.GetOk("params_override"); ok {
+		for _, item := range v.([]interface{}) {
+			dMap := item.(map[string]interface{})
+			instanceParam := redis.InstanceParam{}
+			if v, ok := dMap["key"]; ok {
+				instanceParam.Key = helper.String(v.(string))
+			}
+			if v, ok := dMap["value"]; ok {
+				instanceParam.Value = helper.String(v.(string))
+			}
+
+			request.ParamList = append(request.ParamList, &instanceParam)
+		}
+	}
+
+	err := resource.Retry(writeRetryTimeout, func() *resource.RetryError {
+		resTemplateId, e := service.CreateParamTemplate(ctx, request)
+		if e != nil {
+			return retryError(e)
+		}
+		id = resTemplateId
+		return nil
+	})
+
+	if err != nil {
+		return err
+	}
+
+	if id == "" {
+		return fmt.Errorf("cannot get redis template id")
+	}
+
+	d.SetId(id)
+	return resourceTencentCloudRedisParamTemplateRead(d, meta)
+}
+
+func resourceTencentCloudRedisParamTemplateRead(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_redis_param_template.read")()
+	defer inconsistentCheck(d, meta)()
+
+	logId := getLogId(contextNil)
+	ctx := context.WithValue(context.TODO(), logIdKey, logId)
+
+	service := RedisService{client: meta.(*TencentCloudClient).apiV3Conn}
+
+	id := d.Id()
+
+	paramTemplate, err := service.DescribeParamTemplateInfo(ctx, id)
+
+	if err != nil {
+		return err
+	}
+
+	if paramTemplate == nil {
+		d.SetId("")
+		return fmt.Errorf("resource `param_template` %s does not exist", id)
+	}
+
+	d.SetId(id)
+
+	if paramTemplate.Name != nil {
+		_ = d.Set("name", paramTemplate.Name)
+	}
+
+	if paramTemplate.Description != nil {
+		_ = d.Set("description", paramTemplate.Description)
+	}
+
+	if _, ok := d.GetOk("product_type"); ok && paramTemplate.ProductType != nil {
+		_ = d.Set("product_type", paramTemplate.ProductType)
+	}
+
+	if len(paramTemplate.Items) > 0 {
+		result := make([]interface{}, 0)
+		for i := range paramTemplate.Items {
+			item := paramTemplate.Items[i]
+			listMap := map[string]interface{}{
+				"name":          item.Name,
+				"param_type":    item.ParamType,
+				"default":       item.Default,
+				"description":   item.Description,
+				"current_value": item.CurrentValue,
+				"need_reboot":   item.NeedReboot,
+				"max":           item.Max,
+				"min":           item.Min,
+				"enum_value":    item.EnumValue,
+			}
+
+			result = append(result, listMap)
+		}
+		_ = d.Set("param_details", result)
+	}
+
+	return nil
+}
+
+func resourceTencentCloudRedisParamTemplateUpdate(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_redis_param_template.update")()
+	defer inconsistentCheck(d, meta)()
+
+	logId := getLogId(contextNil)
+
+	ctx := context.WithValue(context.TODO(), logIdKey, logId)
+	request := redis.NewModifyParamTemplateRequest()
+	client := meta.(*TencentCloudClient).apiV3Conn
+	service := RedisService{client: client}
+
+	templateId := d.Id()
+
+	request.TemplateId = &templateId
+
+	if d.HasChange("name") {
+		request.Name = helper.String(d.Get("name").(string))
+	}
+
+	if d.HasChange("description") {
+		request.Description = helper.String(d.Get("description").(string))
+	}
+
+	if d.HasChange("product_type") {
+		return fmt.Errorf("`product_type` do not support change now.")
+	}
+
+	if d.HasChange("template_id") {
+		return fmt.Errorf("`template_id` do not support change now.")
+	}
+
+	if d.HasChange("params_override") {
+		if v, ok := d.GetOk("params_override"); ok {
+			for _, item := range v.([]interface{}) {
+				dMap := item.(map[string]interface{})
+				request.ParamList = append(request.ParamList, &redis.InstanceParam{
+					Key:   helper.String(dMap["key"].(string)),
+					Value: helper.String(dMap["value"].(string)),
+				})
+			}
+		}
+	}
+
+	err := service.ModifyParamTemplate(ctx, request)
+
+	if err != nil {
+		return err
+	}
+
+	return resourceTencentCloudRedisParamTemplateRead(d, meta)
+}
+
+func resourceTencentCloudRedisParamTemplateDelete(d *schema.ResourceData, meta interface{}) error {
+	defer logElapsed("resource.tencentcloud_redis_param_template.delete")()
+	defer inconsistentCheck(d, meta)()
+
+	logId := getLogId(contextNil)
+	ctx := context.WithValue(context.TODO(), logIdKey, logId)
+
+	service := RedisService{client: meta.(*TencentCloudClient).apiV3Conn}
+
+	id := d.Id()
+
+	request := redis.NewDeleteParamTemplateRequest()
+	request.TemplateId = &id
+	if err := service.DeleteParamTemplate(ctx, request); err != nil {
+		return err
+	}
+
+	return nil
+}