Merge pull request #566 from ChuGuai/master

optimize document

Author: gailwang

tencentcloud/provider.go

@@ -298,7 +298,7 @@ Global Application Acceleration(GAAP)
     tencentcloud_gaap_security_rule
     tencentcloud_gaap_domain_error_page
 
-Kubernetes
+Tencent Kubernetes Engine(TKE)
   Data Source
     tencentcloud_kubernetes_clusters
 

tencentcloud/resource_tc_kubernetes_as_scaling_group.go

@@ -457,7 +457,7 @@ func kubernetesAsScalingGroupPara() map[string]*schema.Schema {
 			Optional:    true,
 			ForceNew:    true,
 			MaxItems:    1,
-			Description: "Available values for termination policies include OLDEST_INSTANCE and NEWEST_INSTANCE.",
+			Description: "Available values for termination policies include `OLDEST_INSTANCE` and `NEWEST_INSTANCE`.",
 			Elem: &schema.Schema{
 				Type:    schema.TypeString,
 				Default: SCALING_GROUP_TERMINATION_POLICY_OLDEST_INSTANCE,
@@ -469,7 +469,7 @@ func kubernetesAsScalingGroupPara() map[string]*schema.Schema {
 			Type:        schema.TypeString,
 			Optional:    true,
 			ForceNew:    true,
-			Description: "Available values for retry policies include IMMEDIATE_RETRY and INCREMENTAL_INTERVALS.",
+			Description: "Available values for retry policies include `IMMEDIATE_RETRY` and `INCREMENTAL_INTERVALS`.",
 			Default:     SCALING_GROUP_RETRY_POLICY_IMMEDIATE_RETRY,
 			ValidateFunc: validateAllowedStringValue([]string{SCALING_GROUP_RETRY_POLICY_IMMEDIATE_RETRY,
 				SCALING_GROUP_RETRY_POLICY_INCREMENTAL_INTERVALS}),

tencentcloud/resource_tc_kubernetes_cluster.go

@@ -326,7 +326,7 @@ func TkeCvmCreateInfo() map[string]*schema.Schema {
 			ForceNew:     true,
 			Default:      CVM_PREPAID_RENEW_FLAG_NOTIFY_AND_MANUAL_RENEW,
 			ValidateFunc: validateAllowedStringValue(CVM_PREPAID_RENEW_FLAG),
-			Description:  "When enabled, the CVM instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW` and `DISABLE_NOTIFY_AND_MANUAL_RENEW`. NOTE: it only works when instance_charge_type is set to `PREPAID`.",
+			Description:  "Auto renewal flag. Valid values: `NOTIFY_AND_AUTO_RENEW`: notify upon expiration and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: notify upon expiration but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: neither notify upon expiration nor renew automatically. Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to `PREPAID`.",
 		},
 		"subnet_id": {
 			Type:         schema.TypeString,
@@ -341,7 +341,7 @@ func TkeCvmCreateInfo() map[string]*schema.Schema {
 			Optional:     true,
 			Default:      SYSTEM_DISK_TYPE_CLOUD_PREMIUM,
 			ValidateFunc: validateAllowedStringValue(SYSTEM_DISK_ALLOW_TYPE),
-			Description:  "Type of a CVM disk, and available values include CLOUD_PREMIUM and CLOUD_SSD. Default is CLOUD_PREMIUM.",
+			Description:  "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_BASIC`: HDD cloud disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.",
 		},
 		"system_disk_size": {
 			Type:         schema.TypeInt,
@@ -365,7 +365,7 @@ func TkeCvmCreateInfo() map[string]*schema.Schema {
 						Optional:     true,
 						Default:      SYSTEM_DISK_TYPE_CLOUD_PREMIUM,
 						ValidateFunc: validateAllowedStringValue(SYSTEM_DISK_ALLOW_TYPE),
-						Description:  "Types of disk, available values: CLOUD_PREMIUM and CLOUD_SSD.",
+						Description:  "Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD`.",
 					},
 					"disk_size": {
 						Type:        schema.TypeInt,
@@ -389,7 +389,7 @@ func TkeCvmCreateInfo() map[string]*schema.Schema {
 			Optional:     true,
 			Default:      INTERNET_CHARGE_TYPE_TRAFFIC_POSTPAID_BY_HOUR,
 			ValidateFunc: validateAllowedStringValue(INTERNET_CHARGE_ALLOW_TYPE),
-			Description:  "Charge types for network traffic. Available values include TRAFFIC_POSTPAID_BY_HOUR.",
+			Description:  "Charge types for network traffic. Available values include `TRAFFIC_POSTPAID_BY_HOUR`.",
 		},
 		"internet_max_bandwidth_out": {
 			Type:        schema.TypeInt,

website/docs/d/kubernetes_clusters.html.markdown

@@ -1,5 +1,5 @@
 ---
-subcategory: "Kubernetes"
+subcategory: "Tencent Kubernetes Engine(TKE)"
 layout: "tencentcloud"
 page_title: "TencentCloud: tencentcloud_kubernetes_clusters"
 sidebar_current: "docs-tencentcloud-datasource-kubernetes_clusters"

website/docs/r/kubernetes_as_scaling_group.html.markdown

@@ -1,5 +1,5 @@
 ---
-subcategory: "Kubernetes"
+subcategory: "Tencent Kubernetes Engine(TKE)"
 layout: "tencentcloud"
 page_title: "TencentCloud: tencentcloud_kubernetes_as_scaling_group"
 sidebar_current: "docs-tencentcloud-resource-kubernetes_as_scaling_group"
@@ -170,10 +170,10 @@ The `auto_scaling_group` object supports the following:
 * `forward_balancer_ids` - (Optional, ForceNew) List of application load balancers, which can't be specified with load_balancer_ids together.
 * `load_balancer_ids` - (Optional, ForceNew) ID list of traditional load balancers.
 * `project_id` - (Optional, ForceNew) Specifys to which project the scaling group belongs.
-* `retry_policy` - (Optional, ForceNew) Available values for retry policies include IMMEDIATE_RETRY and INCREMENTAL_INTERVALS.
+* `retry_policy` - (Optional, ForceNew) Available values for retry policies include `IMMEDIATE_RETRY` and `INCREMENTAL_INTERVALS`.
 * `subnet_ids` - (Optional, ForceNew) ID list of subnet, and for VPC it is required.
 * `tags` - (Optional, ForceNew) Tags of a scaling group.
-* `termination_policies` - (Optional, ForceNew) Available values for termination policies include OLDEST_INSTANCE and NEWEST_INSTANCE.
+* `termination_policies` - (Optional, ForceNew) Available values for termination policies include `OLDEST_INSTANCE` and `NEWEST_INSTANCE`.
 * `zones` - (Optional, ForceNew) List of available zones, for Basic network it is required.
 
 The `data_disk` object supports the following:

website/docs/r/kubernetes_cluster.html.markdown

@@ -1,5 +1,5 @@
 ---
-subcategory: "Kubernetes"
+subcategory: "Tencent Kubernetes Engine(TKE)"
 layout: "tencentcloud"
 page_title: "TencentCloud: tencentcloud_kubernetes_cluster"
 sidebar_current: "docs-tencentcloud-resource-kubernetes_cluster"
@@ -250,7 +250,7 @@ The `cluster_extra_args` object supports the following:
 The `data_disk` object supports the following:
 
 * `disk_size` - (Optional, ForceNew) Volume of disk in GB. Default is 0.
-* `disk_type` - (Optional, ForceNew) Types of disk, available values: CLOUD_PREMIUM and CLOUD_SSD.
+* `disk_type` - (Optional, ForceNew) Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD`.
 * `snapshot_id` - (Optional, ForceNew) Data disk snapshot ID.
 
 The `master_config` object supports the following:
@@ -264,17 +264,17 @@ The `master_config` object supports the following:
 * `enhanced_monitor_service` - (Optional, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE.
 * `enhanced_security_service` - (Optional, ForceNew) To specify whether to enable cloud security service. Default is TRUE.
 * `instance_charge_type_prepaid_period` - (Optional, ForceNew) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to `PREPAID`. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
-* `instance_charge_type_prepaid_renew_flag` - (Optional, ForceNew) When enabled, the CVM instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW` and `DISABLE_NOTIFY_AND_MANUAL_RENEW`. NOTE: it only works when instance_charge_type is set to `PREPAID`.
+* `instance_charge_type_prepaid_renew_flag` - (Optional, ForceNew) Auto renewal flag. Valid values: `NOTIFY_AND_AUTO_RENEW`: notify upon expiration and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: notify upon expiration but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: neither notify upon expiration nor renew automatically. Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to `PREPAID`.
 * `instance_charge_type` - (Optional, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`, `PREPAID` instance will not terminated after cluster deleted, and may not allow to delete before expired.
 * `instance_name` - (Optional, ForceNew) Name of the CVMs.
-* `internet_charge_type` - (Optional, ForceNew) Charge types for network traffic. Available values include TRAFFIC_POSTPAID_BY_HOUR.
+* `internet_charge_type` - (Optional, ForceNew) Charge types for network traffic. Available values include `TRAFFIC_POSTPAID_BY_HOUR`.
 * `internet_max_bandwidth_out` - (Optional, ForceNew) Max bandwidth of Internet access in Mbps. Default is 0.
 * `key_ids` - (Optional, ForceNew) ID list of keys, should be set if `password` not set.
 * `password` - (Optional, ForceNew) Password to access, should be set if `key_ids` not set.
 * `public_ip_assigned` - (Optional, ForceNew) Specify whether to assign an Internet IP address.
 * `security_group_ids` - (Optional, ForceNew) Security groups to which a CVM instance belongs.
 * `system_disk_size` - (Optional, ForceNew) Volume of system disk in GB. Default is 50.
-* `system_disk_type` - (Optional, ForceNew) Type of a CVM disk, and available values include CLOUD_PREMIUM and CLOUD_SSD. Default is CLOUD_PREMIUM.
+* `system_disk_type` - (Optional, 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_BASIC`: HDD cloud disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.
 * `user_data` - (Optional, ForceNew) ase64-encoded User Data text, the length limit is 16KB.
 
 The `worker_config` object supports the following:
@@ -288,17 +288,17 @@ The `worker_config` object supports the following:
 * `enhanced_monitor_service` - (Optional, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE.
 * `enhanced_security_service` - (Optional, ForceNew) To specify whether to enable cloud security service. Default is TRUE.
 * `instance_charge_type_prepaid_period` - (Optional, ForceNew) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to `PREPAID`. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
-* `instance_charge_type_prepaid_renew_flag` - (Optional, ForceNew) When enabled, the CVM instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW` and `DISABLE_NOTIFY_AND_MANUAL_RENEW`. NOTE: it only works when instance_charge_type is set to `PREPAID`.
+* `instance_charge_type_prepaid_renew_flag` - (Optional, ForceNew) Auto renewal flag. Valid values: `NOTIFY_AND_AUTO_RENEW`: notify upon expiration and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: notify upon expiration but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: neither notify upon expiration nor renew automatically. Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to `PREPAID`.
 * `instance_charge_type` - (Optional, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`, `PREPAID` instance will not terminated after cluster deleted, and may not allow to delete before expired.
 * `instance_name` - (Optional, ForceNew) Name of the CVMs.
-* `internet_charge_type` - (Optional, ForceNew) Charge types for network traffic. Available values include TRAFFIC_POSTPAID_BY_HOUR.
+* `internet_charge_type` - (Optional, ForceNew) Charge types for network traffic. Available values include `TRAFFIC_POSTPAID_BY_HOUR`.
 * `internet_max_bandwidth_out` - (Optional, ForceNew) Max bandwidth of Internet access in Mbps. Default is 0.
 * `key_ids` - (Optional, ForceNew) ID list of keys, should be set if `password` not set.
 * `password` - (Optional, ForceNew) Password to access, should be set if `key_ids` not set.
 * `public_ip_assigned` - (Optional, ForceNew) Specify whether to assign an Internet IP address.
 * `security_group_ids` - (Optional, ForceNew) Security groups to which a CVM instance belongs.
 * `system_disk_size` - (Optional, ForceNew) Volume of system disk in GB. Default is 50.
-* `system_disk_type` - (Optional, ForceNew) Type of a CVM disk, and available values include CLOUD_PREMIUM and CLOUD_SSD. Default is CLOUD_PREMIUM.
+* `system_disk_type` - (Optional, 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_BASIC`: HDD cloud disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.
 * `user_data` - (Optional, ForceNew) ase64-encoded User Data text, the length limit is 16KB.
 
 ## Attributes Reference

website/docs/r/kubernetes_cluster_attachment.html.markdown

@@ -1,5 +1,5 @@
 ---
-subcategory: "Kubernetes"
+subcategory: "Tencent Kubernetes Engine(TKE)"
 layout: "tencentcloud"
 page_title: "TencentCloud: tencentcloud_kubernetes_cluster_attachment"
 sidebar_current: "docs-tencentcloud-resource-kubernetes_cluster_attachment"

website/docs/r/kubernetes_scale_worker.html.markdown

@@ -1,5 +1,5 @@
 ---
-subcategory: "Kubernetes"
+subcategory: "Tencent Kubernetes Engine(TKE)"
 layout: "tencentcloud"
 page_title: "TencentCloud: tencentcloud_kubernetes_scale_worker"
 sidebar_current: "docs-tencentcloud-resource-kubernetes_scale_worker"
@@ -121,7 +121,7 @@ The following arguments are supported:
 The `data_disk` object supports the following:
 
 * `disk_size` - (Optional, ForceNew) Volume of disk in GB. Default is 0.
-* `disk_type` - (Optional, ForceNew) Types of disk, available values: CLOUD_PREMIUM and CLOUD_SSD.
+* `disk_type` - (Optional, ForceNew) Types of disk, available values: `CLOUD_PREMIUM` and `CLOUD_SSD`.
 * `snapshot_id` - (Optional, ForceNew) Data disk snapshot ID.
 
 The `worker_config` object supports the following:
@@ -135,17 +135,17 @@ The `worker_config` object supports the following:
 * `enhanced_monitor_service` - (Optional, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE.
 * `enhanced_security_service` - (Optional, ForceNew) To specify whether to enable cloud security service. Default is TRUE.
 * `instance_charge_type_prepaid_period` - (Optional, ForceNew) The tenancy (time unit is month) of the prepaid instance, NOTE: it only works when instance_charge_type is set to `PREPAID`. Valid values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
-* `instance_charge_type_prepaid_renew_flag` - (Optional, ForceNew) When enabled, the CVM instance will be renew automatically when it reach the end of the prepaid tenancy. Valid values are `NOTIFY_AND_AUTO_RENEW`, `NOTIFY_AND_MANUAL_RENEW` and `DISABLE_NOTIFY_AND_MANUAL_RENEW`. NOTE: it only works when instance_charge_type is set to `PREPAID`.
+* `instance_charge_type_prepaid_renew_flag` - (Optional, ForceNew) Auto renewal flag. Valid values: `NOTIFY_AND_AUTO_RENEW`: notify upon expiration and renew automatically, `NOTIFY_AND_MANUAL_RENEW`: notify upon expiration but do not renew automatically, `DISABLE_NOTIFY_AND_MANUAL_RENEW`: neither notify upon expiration nor renew automatically. Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis if the account balance is sufficient. NOTE: it only works when instance_charge_type is set to `PREPAID`.
 * `instance_charge_type` - (Optional, ForceNew) The charge type of instance. Valid values are `PREPAID` and `POSTPAID_BY_HOUR`. The default is `POSTPAID_BY_HOUR`. Note: TencentCloud International only supports `POSTPAID_BY_HOUR`, `PREPAID` instance will not terminated after cluster deleted, and may not allow to delete before expired.
 * `instance_name` - (Optional, ForceNew) Name of the CVMs.
-* `internet_charge_type` - (Optional, ForceNew) Charge types for network traffic. Available values include TRAFFIC_POSTPAID_BY_HOUR.
+* `internet_charge_type` - (Optional, ForceNew) Charge types for network traffic. Available values include `TRAFFIC_POSTPAID_BY_HOUR`.
 * `internet_max_bandwidth_out` - (Optional, ForceNew) Max bandwidth of Internet access in Mbps. Default is 0.
 * `key_ids` - (Optional, ForceNew) ID list of keys, should be set if `password` not set.
 * `password` - (Optional, ForceNew) Password to access, should be set if `key_ids` not set.
 * `public_ip_assigned` - (Optional, ForceNew) Specify whether to assign an Internet IP address.
 * `security_group_ids` - (Optional, ForceNew) Security groups to which a CVM instance belongs.
 * `system_disk_size` - (Optional, ForceNew) Volume of system disk in GB. Default is 50.
-* `system_disk_type` - (Optional, ForceNew) Type of a CVM disk, and available values include CLOUD_PREMIUM and CLOUD_SSD. Default is CLOUD_PREMIUM.
+* `system_disk_type` - (Optional, 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_BASIC`: HDD cloud disk, `CLOUD_SSD`: SSD, `CLOUD_PREMIUM`: Premium Cloud Storage. NOTE: `LOCAL_BASIC` and `LOCAL_SSD` are deprecated.
 * `user_data` - (Optional, ForceNew) ase64-encoded User Data text, the length limit is 16KB.
 
 ## Attributes Reference