Skip to content

fix(mongodb): [121024813] support update param #3055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/3055.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:new-resource
tencentcloud_mongodb_instance_params
```
1 change: 1 addition & 0 deletions tencentcloud/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -1400,6 +1400,7 @@ func Provider() *schema.Provider {
"tencentcloud_mongodb_instance_backup_download_task": mongodb.ResourceTencentCloudMongodbInstanceBackupDownloadTask(),
"tencentcloud_mongodb_instance_transparent_data_encryption": mongodb.ResourceTencentCloudMongodbInstanceTransparentDataEncryption(),
"tencentcloud_mongodb_instance_backup_rule": mongodb.ResourceTencentCloudMongodbInstanceBackupRule(),
"tencentcloud_mongodb_instance_params": mongodb.ResourceTencentCloudMongodbInstanceParams(),
"tencentcloud_dayu_cc_http_policy": dayu.ResourceTencentCloudDayuCCHttpPolicy(),
"tencentcloud_dayu_cc_https_policy": dayu.ResourceTencentCloudDayuCCHttpsPolicy(),
"tencentcloud_dayu_ddos_policy": dayu.ResourceTencentCloudDayuDdosPolicy(),
Expand Down
1 change: 1 addition & 0 deletions tencentcloud/provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,7 @@ TencentDB for MongoDB(mongodb)
tencentcloud_mongodb_instance_backup
tencentcloud_mongodb_instance_transparent_data_encryption
tencentcloud_mongodb_instance_backup_rule
tencentcloud_mongodb_instance_params

TencentDB for MySQL(cdb)
Data Source
Expand Down
219 changes: 219 additions & 0 deletions tencentcloud/services/mongodb/resource_tc_mongodb_instance_params.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
package mongodb

import (
"context"
"fmt"
"log"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
mongodb "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/mongodb/v20190725"

tccommon "github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/common"
"github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/internal/helper"
)

func ResourceTencentCloudMongodbInstanceParams() *schema.Resource {
return &schema.Resource{
Create: resourceTencentCloudMongodbInstanceParamsCreate,
Read: resourceTencentCloudMongodbInstanceParamsRead,
Update: resourceTencentCloudMongodbInstanceParamsUpdate,
Delete: resourceTencentCloudMongodbInstanceParamsDelete,
Schema: map[string]*schema.Schema{
"instance_id": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这个资源为啥不支持import?

Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: "Instance id.",
},

"instance_params": {
Type: schema.TypeSet,
Required: true,
Description: "Specify the parameter name and value to be modified.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"key": {
Type: schema.TypeString,
Required: true,
Description: "Parameter names that need to be modified.",
},
"value": {
Type: schema.TypeString,
Required: true,
Description: "The value corresponding to the parameter name to be modified.",
},
},
},
},

"modify_type": {
Type: schema.TypeString,
Optional: true,
Description: "Operation types, including:\n" +
" - IMMEDIATELY: Adjust immediately;\n" +
" - DELAY: Delay adjustment;\n" +
"Optional field. If this parameter is not configured, it defaults to immediate adjustment.",
},
},
}
}

func resourceTencentCloudMongodbInstanceParamsCreate(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_mongodb_instance_params.create")()
defer tccommon.InconsistentCheck(d, meta)()

var (
instanceId string
)
if v, ok := d.GetOk("instance_id"); ok {
instanceId = v.(string)
}

d.SetId(instanceId)

return resourceTencentCloudMongodbInstanceParamsUpdate(d, meta)
}

func resourceTencentCloudMongodbInstanceParamsRead(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_mongodb_instance_params.read")()
defer tccommon.InconsistentCheck(d, meta)()

logId := tccommon.GetLogId(tccommon.ContextNil)

ctx := tccommon.NewResourceLifeCycleHandleFuncContext(context.Background(), logId, d, meta)

service := MongodbService{client: meta.(tccommon.ProviderMeta).GetAPIV3Conn()}

instanceId := d.Id()

_ = d.Set("instance_id", instanceId)

instanceParams := d.Get("instance_params").(*schema.Set).List()
paramNames := make([]string, 0)
for _, instanceParam := range instanceParams {
instanceParamMap := instanceParam.(map[string]interface{})
paramNames = append(paramNames, instanceParamMap["key"].(string))
}
respData, err := service.DescribeMongodbInstanceParamValues(ctx, instanceId, paramNames)
if err != nil {
return err
}

if respData == nil {
d.SetId("")
log.Printf("[WARN]%s resource `mongodb_instance_params` [%s] not found, please check if it has been deleted.\n", logId, d.Id())
return nil
}

resInstanceParams := make([]interface{}, 0)
for k, v := range respData {
resInstanceParams = append(resInstanceParams, map[string]interface{}{
"key": k,
"value": v,
})
}
_ = d.Set("instance_params", resInstanceParams)

return nil
}

func resourceTencentCloudMongodbInstanceParamsUpdate(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_mongodb_instance_params.update")()
defer tccommon.InconsistentCheck(d, meta)()

logId := tccommon.GetLogId(tccommon.ContextNil)

ctx := tccommon.NewResourceLifeCycleHandleFuncContext(context.Background(), logId, d, meta)

instanceId := d.Id()

needChange := false
mutableArgs := []string{"instance_params"}
for _, v := range mutableArgs {
if d.HasChange(v) {
needChange = true
break
}
}

if needChange {
request := mongodb.NewModifyInstanceParamsRequest()
request.InstanceId = helper.String(d.Get("instance_id").(string))

if v, ok := d.GetOk("instance_params"); ok {
for _, item := range v.(*schema.Set).List() {
instanceParamsMap := item.(map[string]interface{})
modifyMongoDBParamType := mongodb.ModifyMongoDBParamType{}
if v, ok := instanceParamsMap["key"]; ok {
modifyMongoDBParamType.Key = helper.String(v.(string))
}
if v, ok := instanceParamsMap["value"]; ok {
modifyMongoDBParamType.Value = helper.String(v.(string))
}
request.InstanceParams = append(request.InstanceParams, &modifyMongoDBParamType)
}
}

if v, ok := d.GetOk("modify_type"); ok {
request.ModifyType = helper.String(v.(string))
}

err := resource.Retry(tccommon.WriteRetryTimeout, func() *resource.RetryError {
result, e := meta.(tccommon.ProviderMeta).GetAPIV3Conn().UseMongodbClient().ModifyInstanceParamsWithContext(ctx, request)
if e != nil {
return tccommon.RetryError(e)
} else {
log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n", logId, request.GetAction(), request.ToJsonString(), result.ToJsonString())
}
return nil
})
if err != nil {
log.Printf("[CRITAL]%s update mongodb instance params failed, reason:%+v", logId, err)
return err
}

service := MongodbService{client: meta.(tccommon.ProviderMeta).GetAPIV3Conn()}
instanceParams := d.Get("instance_params").(*schema.Set).List()
paramMap := make(map[string]string)
paramNames := make([]string, 0)

for _, instanceParam := range instanceParams {
instanceParamMap := instanceParam.(map[string]interface{})
key := instanceParamMap["key"].(string)
value := instanceParamMap["value"].(string)
paramMap[key] = value
paramNames = append(paramNames, key)
}

err = resource.Retry(6*tccommon.WriteRetryTimeout, func() *resource.RetryError {
respMap, e := service.DescribeMongodbInstanceParamValues(ctx, instanceId, paramNames)
if e != nil {
return tccommon.RetryError(e)
}

for k, v := range paramMap {
if vv, ok := respMap[k]; ok {
if v != vv {
return resource.RetryableError(fmt.Errorf("param %s is still being updated", k))
}
}
}
return nil
})
if err != nil {
log.Printf("[CRITAL]%s update mongodb instance params failed, reason:%+v", logId, err)
return err
}
}

_ = instanceId
return resourceTencentCloudMongodbInstanceParamsRead(d, meta)
}

func resourceTencentCloudMongodbInstanceParamsDelete(d *schema.ResourceData, meta interface{}) error {
defer tccommon.LogElapsed("resource.tencentcloud_mongodb_instance_params.delete")()
defer tccommon.InconsistentCheck(d, meta)()

return nil
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Provides a resource to create a mongodb mongodb_instance_params

Example Usage

```hcl
resource "tencentcloud_mongodb_instance_params" "mongodb_instance_params" {
instance_id = "cmgo-xxxxxx"
instance_params {
key = "cmgo.crossZoneLoadBalancing"
value = "on"
}
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
package mongodb_test

import (
"testing"

"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"

tcacctest "github.com/tencentcloudstack/terraform-provider-tencentcloud/tencentcloud/acctest"
)

func TestAccTencentCloudMongodbInstanceParamsResource_basic(t *testing.T) {
t.Parallel()
resource.Test(t, resource.TestCase{
PreCheck: func() {
tcacctest.AccPreCheck(t)
},
Providers: tcacctest.AccProviders,
Steps: []resource.TestStep{
{
Config: testAccMongodbInstanceParams,
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttrSet("tencentcloud_mongodb_instance_params.mongodb_instance_params", "id"),
resource.TestCheckResourceAttr("tencentcloud_mongodb_instance_params.mongodb_instance_params", "instance_params.0.key", "cmgo.crossZoneLoadBalancing"),
resource.TestCheckResourceAttr("tencentcloud_mongodb_instance_params.mongodb_instance_params", "instance_params.0.value", "on"),
),
},
{
Config: testAccMongodbInstanceParamsUpdate,
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttrSet("tencentcloud_mongodb_instance_params.mongodb_instance_params", "id"),
resource.TestCheckResourceAttr("tencentcloud_mongodb_instance_params.mongodb_instance_params", "instance_params.0.key", "cmgo.crossZoneLoadBalancing"),
resource.TestCheckResourceAttr("tencentcloud_mongodb_instance_params.mongodb_instance_params", "instance_params.0.value", "off"),
),
},
},
})
}

const testAccMongodbInstanceParams = `
resource "tencentcloud_mongodb_instance_params" "mongodb_instance_params" {
instance_id = "cmgo-c6k2v891"
instance_params {
key = "cmgo.crossZoneLoadBalancing"
value = "on"
}
}
`

const testAccMongodbInstanceParamsUpdate = `
resource "tencentcloud_mongodb_instance_params" "mongodb_instance_params" {
instance_id = "cmgo-c6k2v891"
instance_params {
key = "cmgo.crossZoneLoadBalancing"
value = "off"
}
}
`
54 changes: 54 additions & 0 deletions tencentcloud/services/mongodb/service_tencentcloud_mongodb.go
Original file line number Diff line number Diff line change
Expand Up @@ -923,3 +923,57 @@ func (me *MongodbService) SetInstanceMaintenance(ctx context.Context, instanceId

return nil
}

func (me *MongodbService) DescribeMongodbInstanceParamValues(ctx context.Context, instanceId string, paramNames []string) (res map[string]string, errRet error) {
logId := tccommon.GetLogId(ctx)

request := mongodb.NewDescribeInstanceParamsRequest()
request.InstanceId = helper.String(instanceId)

defer func() {
if errRet != nil {
log.Printf("[CRITAL]%s api[%s] fail, request body [%s], reason[%s]\n", logId, request.GetAction(), request.ToJsonString(), errRet.Error())
}
}()

ratelimit.Check(request.GetAction())

response, err := me.client.UseMongodbClient().DescribeInstanceParams(request)
if err != nil {
errRet = err
return
}
log.Printf("[DEBUG]%s api[%s] success, request body [%s], response body [%s]\n", logId, request.GetAction(), request.ToJsonString(), response.ToJsonString())

res = make(map[string]string)
for _, param := range response.Response.InstanceEnumParam {
for _, paramName := range paramNames {
if *param.ParamName == paramName {
res[paramName] = *param.CurrentValue
}
}
}
for _, param := range response.Response.InstanceIntegerParam {
for _, paramName := range paramNames {
if *param.ParamName == paramName {
res[paramName] = *param.CurrentValue
}
}
}
for _, param := range response.Response.InstanceMultiParam {
for _, paramName := range paramNames {
if *param.ParamName == paramName {
res[paramName] = *param.CurrentValue
}
}
}
for _, param := range response.Response.InstanceTextParam {
for _, paramName := range paramNames {
if *param.ParamName == paramName {
res[paramName] = *param.CurrentValue
}
}
}

return
}
Loading
Loading