Skip to content

Commit e83bc31

Browse files
authored
fix nodepool doc (#1603)
1 parent 0d27ee1 commit e83bc31

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

tencentcloud/resource_tc_kubernetes_node_pool.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
Provide a resource to create an auto scaling group for kubernetes cluster.
33
44
~> **NOTE:** We recommend the usage of one cluster with essential worker config + node pool to manage cluster and nodes. Its a more flexible way than manage worker config with tencentcloud_kubernetes_cluster, tencentcloud_kubernetes_scale_worker or exist node management of `tencentcloud_kubernetes_attachment`. Cause some unchangeable parameters of `worker_config` may cause the whole cluster resource `force new`.
5+
56
~> **NOTE:** In order to ensure the integrity of customer data, if you destroy nodepool instance, it will keep the cvm instance associate with nodepool by default. If you want destroy together, please set `delete_keep_instance` to `false`.
67
8+
~> **NOTE:** In order to ensure the integrity of customer data, if the cvm instance was destroyed due to shrinking, it will keep the cbs associate with cvm by default. If you want destroy together, please set `delete_with_instance` to `true`.
9+
710
Example Usage
811
912
```hcl
@@ -240,7 +243,7 @@ func composedKubernetesAsScalingConfigPara() map[string]*schema.Schema {
240243
"delete_with_instance": {
241244
Type: schema.TypeBool,
242245
Optional: true,
243-
Description: "Indicates whether the disk remove after instance terminated.",
246+
Description: "Indicates whether the disk remove after instance terminated. Default is `false`.",
244247
},
245248
"encrypt": {
246249
Type: schema.TypeBool,

website/docs/r/kubernetes_node_pool.html.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@ description: |-
1212
Provide a resource to create an auto scaling group for kubernetes cluster.
1313

1414
~> **NOTE:** We recommend the usage of one cluster with essential worker config + node pool to manage cluster and nodes. Its a more flexible way than manage worker config with tencentcloud_kubernetes_cluster, tencentcloud_kubernetes_scale_worker or exist node management of `tencentcloud_kubernetes_attachment`. Cause some unchangeable parameters of `worker_config` may cause the whole cluster resource `force new`.
15+
1516
~> **NOTE:** In order to ensure the integrity of customer data, if you destroy nodepool instance, it will keep the cvm instance associate with nodepool by default. If you want destroy together, please set `delete_keep_instance` to `false`.
1617

18+
~> **NOTE:** In order to ensure the integrity of customer data, if the cvm instance was destroyed due to shrinking, it will keep the cbs associate with cvm by default. If you want destroy together, please set `delete_with_instance` to `true`.
19+
1720
## Example Usage
1821

1922
```hcl
@@ -217,7 +220,7 @@ The `data_disk` object supports the following:
217220

218221
The `data_disk` object supports the following:
219222

220-
* `delete_with_instance` - (Optional, Bool) Indicates whether the disk remove after instance terminated.
223+
* `delete_with_instance` - (Optional, Bool) Indicates whether the disk remove after instance terminated. Default is `false`.
221224
* `disk_size` - (Optional, Int) Volume of disk in GB. Default is `0`.
222225
* `disk_type` - (Optional, String) Types of disk. Valid value: `CLOUD_PREMIUM` and `CLOUD_SSD`.
223226
* `encrypt` - (Optional, Bool) Specify whether to encrypt data disk, default: false. NOTE: Make sure the instance type is offering and the cam role `QcloudKMSAccessForCVMRole` was provided.

0 commit comments

Comments
 (0)