feat(tke): [117335378]Add pre_start_user_script and user_script fields (#2651)

bruceybian · web-flow · commit 57e27c5e660b · 2024-05-23T22:15:02.000+08:00
* Add pre_start_user_script and user_script fields

* add changelog 2651.txt

* update test

* update test

* update test

* update e2e test

* update e2e test

* update e2e test
diff --git a/.changelog/2651.txt b/.changelog/2651.txt
@@ -0,0 +1,3 @@
+```release-note:enhancement
+resource/tencentcloud_kubernetes_scale_worker: Add `pre_start_user_script` and `user_script` fields
+```
diff --git a/tencentcloud/services/tke/resource_tc_kubernetes_cluster.go b/tencentcloud/services/tke/resource_tc_kubernetes_cluster.go
@@ -307,7 +307,7 @@ func TkeCvmCreateInfo() map[string]*schema.Schema {
 			Type:        schema.TypeString,
 			ForceNew:    true,
 			Optional:    true,
-			Description: "ase64-encoded User Data text, the length limit is 16KB.",
+			Description: "User data provided to instances, needs to be encoded in base64, and the maximum supported data size is 16KB.",
 		},
 		"cam_role_name": {
 			Type:        schema.TypeString,
diff --git a/tencentcloud/services/tke/resource_tc_kubernetes_scale_worker.go b/tencentcloud/services/tke/resource_tc_kubernetes_scale_worker.go
@@ -83,7 +83,7 @@ func ResourceTencentCloudTkeScaleWorker() *schema.Resource {
 				Optional:    true,
 				ForceNew:    true,
 				Default:     0,
-				Description: "Sets whether the joining node participates in the schedule. Default is '0'. Participate in scheduling.",
+				Description: "Set whether the added node participates in scheduling. The default value is 0, which means participating in scheduling; non-0 means not participating in scheduling. After the node initialization is completed, you can execute kubectl uncordon nodename to join the node in scheduling.",
 			},
 			"desired_pod_num": {
 				Type:        schema.TypeInt,
@@ -150,6 +150,18 @@ func ResourceTencentCloudTkeScaleWorker() *schema.Resource {
 					},
 				},
 			},
+			"pre_start_user_script": {
+				Type:        schema.TypeString,
+				ForceNew:    true,
+				Optional:    true,
+				Description: "Base64-encoded user script, executed before initializing the node, currently only effective for adding existing nodes.",
+			},
+			"user_script": {
+				Type:        schema.TypeString,
+				ForceNew:    true,
+				Optional:    true,
+				Description: "Base64 encoded user script, this script will be executed after the k8s component is run. The user needs to ensure that the script is reentrant and retry logic. The script and its generated log files can be viewed in the /data/ccs_userscript/ path of the node, if required. The node needs to be initialized before it can be added to the schedule. It can be used with the unschedulable parameter. After the final initialization of userScript is completed, add the kubectl uncordon nodename --kubeconfig=/root/.kube/config command to add the node to the schedule.",
+			},
 			// Computed values
 			"worker_instances_list": {
 				Type:     schema.TypeList,
@@ -213,6 +225,14 @@ func resourceTencentCloudTkeScaleWorkerCreate(d *schema.ResourceData, meta inter
 		iAdvanced.Unschedulable = helper.Int64(int64(temp.(int)))
 	}
 
+	if v, ok := d.GetOk("pre_start_user_script"); ok {
+		iAdvanced.PreStartUserScript = helper.String(v.(string))
+	}
+
+	if v, ok := d.GetOk("user_script"); ok {
+		iAdvanced.UserScript = helper.String(v.(string))
+	}
+
 	if workers, ok := d.GetOk("worker_config"); ok {
 		workerList := workers.([]interface{})
 		for index := range workerList {
@@ -366,6 +386,8 @@ func resourceTencentCloudTkeScaleWorkerRead(d *schema.ResourceData, meta interfa
 			}
 
 			_ = d.Set("unschedulable", helper.PInt64(cvm.InstanceAdvancedSettings.Unschedulable))
+			_ = d.Set("pre_start_user_script", helper.PString(cvm.InstanceAdvancedSettings.PreStartUserScript))
+			_ = d.Set("user_script", helper.PString(cvm.InstanceAdvancedSettings.UserScript))
 
 			if importFlag {
 				_ = d.Set("docker_graph_path", helper.PString(cvm.InstanceAdvancedSettings.DockerGraphPath))
diff --git a/tencentcloud/services/tke/resource_tc_kubernetes_scale_worker_test.go b/tencentcloud/services/tke/resource_tc_kubernetes_scale_worker_test.go
@@ -119,6 +119,7 @@ func TestAccTencentCloudKubernetesScaleWorkerResource(t *testing.T) {
 					resource.TestCheckResourceAttrSet(testTkeScaleWorkerResourceKey, "worker_instances_list.0.instance_id"),
 					resource.TestCheckResourceAttrSet(testTkeScaleWorkerResourceKey, "worker_instances_list.0.instance_role"),
 					resource.TestCheckResourceAttrSet(testTkeScaleWorkerResourceKey, "unschedulable"),
+					resource.TestCheckResourceAttr(testTkeScaleWorkerResourceKey, "user_script", "IyEvYmluL3NoIGVjaG8gImhlbGxvIHdvcmxkIg=="),
 				),
 			},
 			{
@@ -230,7 +231,43 @@ func testAccCheckTkeScaleWorkerExists(n string) resource.TestCheckFunc {
 	}
 }
 
-const testAccTkeScaleWorkerInstanceBasic = tcacctest.TkeExclusiveNetwork + tcacctest.TkeDataSource + tcacctest.DefaultSecurityGroupData
+const testAccTkeScaleWorkerInstanceBasic = tcacctest.TkeDataSource + `
+variable "default_az" {
+  default = "ap-guangzhou-3"
+}
+
+data "tencentcloud_vpc_instances" "vpc" {
+  name = "keep-tke-vpc"
+}
+
+data "tencentcloud_vpc_subnets" "subnet" {
+  vpc_id = data.tencentcloud_vpc_instances.vpc.instance_list.0.vpc_id
+}
+
+data "tencentcloud_instance_types" "default" {
+  filter {
+    name   = "zone"
+    values = [var.default_az]
+  }
+  filter {
+    name   = "instance-charge-type"
+    values = ["POSTPAID_BY_HOUR"]
+  }
+  cpu_core_count   = 2
+  exclude_sold_out = true
+}
+
+data "tencentcloud_security_groups" "internal" {
+  name = "keep-tke"
+}
+
+locals {
+  vpc_id              = data.tencentcloud_vpc_subnets.subnet.instance_list.0.vpc_id
+  subnet_id           = data.tencentcloud_vpc_subnets.subnet.instance_list.0.subnet_id
+  scale_instance_type = data.tencentcloud_instance_types.default.instance_types.0.instance_type
+  sg_id               = data.tencentcloud_security_groups.internal.security_groups.0.security_group_id
+}
+`
 
 const testAccTkeScaleWorkerInstance string = testAccTkeScaleWorkerInstanceBasic + `
 
@@ -246,6 +283,7 @@ resource tencentcloud_kubernetes_scale_worker test_scale {
     "test2" = "test2",
   }
   unschedulable = 0
+  user_script   = "IyEvYmluL3NoIGVjaG8gImhlbGxvIHdvcmxkIg=="
 
   worker_config {
     count                      				= 1
@@ -284,6 +322,7 @@ resource tencentcloud_kubernetes_scale_worker test_scale {
     "test2" = "test2",
   }
   unschedulable = 0
+  user_script   = "IyEvYmluL3NoIGVjaG8gImhlbGxvIHdvcmxkIg=="
 
   worker_config {
     count                      				= 1
diff --git a/website/docs/r/kubernetes_cluster.html.markdown b/website/docs/r/kubernetes_cluster.html.markdown
@@ -948,7 +948,7 @@ The `master_config` object supports the following:
 * `security_group_ids` - (Optional, List, ForceNew) Security groups to which a CVM instance belongs.
 * `system_disk_size` - (Optional, Int, ForceNew) Volume of system disk in GB. Default is `50`.
 * `system_disk_type` - (Optional, String, ForceNew) System disk type. For more information on limits of system disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952). Valid values: `LOCAL_BASIC`: local disk, `LOCAL_SSD`: local SSD disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `CLOUD_BASIC`, `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.
-* `user_data` - (Optional, String, ForceNew) ase64-encoded User Data text, the length limit is 16KB.
+* `user_data` - (Optional, String, ForceNew) User data provided to instances, needs to be encoded in base64, and the maximum supported data size is 16KB.
 
 The `node_pool_global_config` object supports the following:
 
@@ -990,7 +990,7 @@ The `worker_config` object supports the following:
 * `security_group_ids` - (Optional, List, ForceNew) Security groups to which a CVM instance belongs.
 * `system_disk_size` - (Optional, Int, ForceNew) Volume of system disk in GB. Default is `50`.
 * `system_disk_type` - (Optional, String, ForceNew) System disk type. For more information on limits of system disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952). Valid values: `LOCAL_BASIC`: local disk, `LOCAL_SSD`: local SSD disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `CLOUD_BASIC`, `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.
-* `user_data` - (Optional, String, ForceNew) ase64-encoded User Data text, the length limit is 16KB.
+* `user_data` - (Optional, String, ForceNew) User data provided to instances, needs to be encoded in base64, and the maximum supported data size is 16KB.
 
 ## Attributes Reference
 
diff --git a/website/docs/r/kubernetes_scale_worker.html.markdown b/website/docs/r/kubernetes_scale_worker.html.markdown
@@ -125,7 +125,9 @@ The following arguments are supported:
 * `gpu_args` - (Optional, List, ForceNew) GPU driver parameters.
 * `labels` - (Optional, Map, ForceNew) Labels of kubernetes scale worker created nodes.
 * `mount_target` - (Optional, String, ForceNew) Mount target. Default is not mounting.
-* `unschedulable` - (Optional, Int, ForceNew) Sets whether the joining node participates in the schedule. Default is '0'. Participate in scheduling.
+* `pre_start_user_script` - (Optional, String, ForceNew) Base64-encoded user script, executed before initializing the node, currently only effective for adding existing nodes.
+* `unschedulable` - (Optional, Int, ForceNew) Set whether the added node participates in scheduling. The default value is 0, which means participating in scheduling; non-0 means not participating in scheduling. After the node initialization is completed, you can execute kubectl uncordon nodename to join the node in scheduling.
+* `user_script` - (Optional, String, ForceNew) Base64 encoded user script, this script will be executed after the k8s component is run. The user needs to ensure that the script is reentrant and retry logic. The script and its generated log files can be viewed in the /data/ccs_userscript/ path of the node, if required. The node needs to be initialized before it can be added to the schedule. It can be used with the unschedulable parameter. After the final initialization of userScript is completed, add the kubectl uncordon nodename --kubeconfig=/root/.kube/config command to add the node to the schedule.
 
 The `data_disk` object of `worker_config` supports the following:
 
@@ -183,7 +185,7 @@ The `worker_config` object supports the following:
 * `security_group_ids` - (Optional, List, ForceNew) Security groups to which a CVM instance belongs.
 * `system_disk_size` - (Optional, Int, ForceNew) Volume of system disk in GB. Default is `50`.
 * `system_disk_type` - (Optional, String, ForceNew) System disk type. For more information on limits of system disk types, see [Storage Overview](https://intl.cloud.tencent.com/document/product/213/4952). Valid values: `LOCAL_BASIC`: local disk, `LOCAL_SSD`: local SSD disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `CLOUD_BASIC`, `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.
-* `user_data` - (Optional, String, ForceNew) ase64-encoded User Data text, the length limit is 16KB.
+* `user_data` - (Optional, String, ForceNew) User data provided to instances, needs to be encoded in base64, and the maximum supported data size is 16KB.
 
 ## Attributes Reference
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+```release-note:enhancement
	`2`	+resource/tencentcloud_kubernetes_scale_worker: Add `pre_start_user_script` and `user_script` fields
	`3`	+```