Skip to content

Commit 405baac

Browse files
author
ivan
committed
gendoc
1 parent 1e76485 commit 405baac

11 files changed

+102
-10
lines changed

tencentcloud/data_source_tc_clb_instances.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,27 +162,27 @@ func dataSourceTencentCloudClbInstances() *schema.Resource {
162162
"zone_id": {
163163
Type: schema.TypeInt,
164164
Computed: true,
165-
Description: "Available zone unique id(numerical representation), This field maybe null, means cannot get a valid value",
165+
Description: "Available zone unique id(numerical representation), This field maybe null, means cannot get a valid value.",
166166
},
167167
"zone": {
168168
Type: schema.TypeString,
169169
Computed: true,
170-
Description: "Available zone unique id(string representation), This field maybe null, means cannot get a valid value",
170+
Description: "Available zone unique id(string representation), This field maybe null, means cannot get a valid value.",
171171
},
172172
"zone_name": {
173173
Type: schema.TypeString,
174174
Computed: true,
175-
Description: "Available zone name, This field maybe null, means cannot get a valid value",
175+
Description: "Available zone name, This field maybe null, means cannot get a valid value.",
176176
},
177177
"zone_region": {
178178
Type: schema.TypeString,
179179
Computed: true,
180-
Description: "Region that this available zone belong to, This field maybe null, means cannot get a valid value",
180+
Description: "Region that this available zone belong to, This field maybe null, means cannot get a valid value.",
181181
},
182182
"local_zone": {
183183
Type: schema.TypeBool,
184184
Computed: true,
185-
Description: "Whether this available zone is local zone, This field maybe null, means cannot get a valid value",
185+
Description: "Whether this available zone is local zone, This field maybe null, means cannot get a valid value.",
186186
},
187187
},
188188
},

tencentcloud/resource_tc_clb_instance.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ func resourceTencentCloudClbInstance() *schema.Resource {
232232
"slave_zone_id": {
233233
Type: schema.TypeString,
234234
Optional: true,
235-
Description: "Setting slave zone id of cross available zone disaster recovery, only applicable to open CLB. this zone will undertake traffic when the master is down",
235+
Description: "Setting slave zone id of cross available zone disaster recovery, only applicable to open CLB. this zone will undertake traffic when the master is down.",
236236
},
237237
},
238238
}

website/docs/d/as_scaling_groups.html.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ In addition to all arguments above, the following attributes are exported:
5151
* `load_balancer_ids` - A list of traditional clb ids which the CVM instances attached to.
5252
* `max_size` - The maximum number of CVM instances.
5353
* `min_size` - The minimum number of CVM instances.
54+
* `multi_zone_subnet_policy` - Multi zone or subnet strategy, Valid values: PRIORITY and EQUALITY.
5455
* `project_id` - ID of the project to which the scaling group belongs. Default value is 0.
5556
* `retry_policy` - A retry policy can be used when a creation fails.
5657
* `scaling_group_id` - Auto scaling group ID.

website/docs/d/clb_instances.html.markdown

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ The following arguments are supported:
2929

3030
* `clb_id` - (Optional) ID of the CLB to be queried.
3131
* `clb_name` - (Optional) Name of the CLB to be queried.
32+
* `master_zone` - (Optional) Master available zone id.
3233
* `network_type` - (Optional) Type of CLB instance, and available values include `OPEN` and `INTERNAL`.
3334
* `project_id` - (Optional) Project ID of the CLB.
3435
* `result_output_file` - (Optional) Used to save results.
@@ -45,6 +46,7 @@ In addition to all arguments above, the following attributes are exported:
4546
* `create_time` - Create time of the CLB.
4647
* `internet_bandwidth_max_out` - Max bandwidth out, only applicable to open CLB. Valid value ranges is [1, 2048]. Unit is MB.
4748
* `internet_charge_type` - Internet charge type, only applicable to open CLB. Valid values are `TRAFFIC_POSTPAID_BY_HOUR`, `BANDWIDTH_POSTPAID_BY_HOUR` and `BANDWIDTH_PACKAGE`.
49+
* `local_zone` - Whether this available zone is local zone, This field maybe null, means cannot get a valid value.
4850
* `network_type` - Types of CLB.
4951
* `project_id` - ID of the project.
5052
* `security_groups` - ID set of the security groups.
@@ -56,5 +58,9 @@ In addition to all arguments above, the following attributes are exported:
5658
* `target_region_info_vpc_id` - VpcId information of backend service are attached the CLB.
5759
* `vip_isp` - Network operator, only applicable to open CLB. Valid values are `CMCC`(China Mobile), `CTCC`(Telecom), `CUCC`(China Unicom) and `BGP`. If this ISP is specified, network billing method can only use the bandwidth package billing (BANDWIDTH_PACKAGE).
5860
* `vpc_id` - ID of the VPC.
61+
* `zone_id` - Available zone unique id(numerical representation), This field maybe null, means cannot get a valid value.
62+
* `zone_name` - Available zone name, This field maybe null, means cannot get a valid value.
63+
* `zone_region` - Region that this available zone belong to, This field maybe null, means cannot get a valid value.
64+
* `zone` - Available zone unique id(string representation), This field maybe null, means cannot get a valid value.
5965

6066

website/docs/d/kubernetes_clusters.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ In addition to all arguments above, the following attributes are exported:
6060
* `domain` - Domain name for access.
6161
* `eni_subnet_ids` - Subnet IDs for cluster with VPC-CNI network mode.
6262
* `ignore_cluster_cidr_conflict` - Indicates whether to ignore the cluster cidr conflict error.
63-
* `is_non_static_ip_mode` - Indicates whether static ip mode is enabled.
63+
* `is_non_static_ip_mode` - Indicates whether non-static ip mode is enabled.
6464
* `kube_config` - kubernetes config.
6565
* `kube_proxy_mode` - Cluster kube-proxy mode.
6666
* `network_type` - Cluster network type.

website/docs/r/as_scaling_group.html.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ The following arguments are supported:
5353
* `desired_capacity` - (Optional) Desired volume of CVM instances, which is between `max_size` and `min_size`.
5454
* `forward_balancer_ids` - (Optional) List of application load balancers, which can't be specified with `load_balancer_ids` together.
5555
* `load_balancer_ids` - (Optional) ID list of traditional load balancers.
56+
* `multi_zone_subnet_policy` - (Optional) Multi zone or subnet strategy, Valid values: PRIORITY and EQUALITY.
5657
* `project_id` - (Optional) Specifies to which project the scaling group belongs.
5758
* `retry_policy` - (Optional) Available values for retry policies. Valid values: IMMEDIATE_RETRY and INCREMENTAL_INTERVALS.
5859
* `subnet_ids` - (Optional) ID list of subnet, and for VPC it is required.

website/docs/r/clb_instance.html.markdown

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,60 @@ resource "tencentcloud_clb_instance" "open_clb" {
4747
}
4848
```
4949

50+
Default enable
51+
52+
```hcl
53+
resource "tencentcloud_subnet" "subnet" {
54+
availability_zone = "ap-guangzhou-1"
55+
name = "sdk-feature-test"
56+
vpc_id = tencentcloud_vpc.foo.id
57+
cidr_block = "10.0.20.0/28"
58+
is_multicast = false
59+
}
60+
61+
resource "tencentcloud_security_group" "sglab" {
62+
name = "sg_o0ek7r93"
63+
description = "favourite sg"
64+
project_id = 0
65+
}
66+
67+
resource "tencentcloud_vpc" "foo" {
68+
name = "for-my-open-clb"
69+
cidr_block = "10.0.0.0/16"
70+
71+
tags = {
72+
"test" = "mytest"
73+
}
74+
}
75+
76+
resource "tencentcloud_clb_instance" "open_clb" {
77+
network_type = "OPEN"
78+
clb_name = "my-open-clb"
79+
project_id = 0
80+
vpc_id = tencentcloud_vpc.foo.id
81+
load_balancer_pass_to_target = true
82+
83+
security_groups = [tencentcloud_security_group.sglab.id]
84+
target_region_info_region = "ap-guangzhou"
85+
target_region_info_vpc_id = tencentcloud_vpc.foo.id
86+
87+
tags = {
88+
test = "open"
89+
}
90+
}
91+
```
92+
93+
CREATE multiple instance
94+
95+
```hcl
96+
resource "tencentcloud_clb_instance" "open_clb1" {
97+
network_type = "OPEN"
98+
clb_name = "hello"
99+
master_zone_id = "ap-guangzhou-3"
100+
}
101+
~
102+
```
103+
50104
## Argument Reference
51105

52106
The following arguments are supported:
@@ -56,13 +110,17 @@ The following arguments are supported:
56110
* `address_ip_version` - (Optional) IP version, only applicable to open CLB. Valid values are `ipv4`, `ipv6` and `IPv6FullChain`.
57111
* `internet_bandwidth_max_out` - (Optional) Max bandwidth out, only applicable to open CLB. Valid value ranges is [1, 2048]. Unit is MB.
58112
* `internet_charge_type` - (Optional) Internet charge type, only applicable to open CLB. Valid values are `TRAFFIC_POSTPAID_BY_HOUR`, `BANDWIDTH_POSTPAID_BY_HOUR` and `BANDWIDTH_PACKAGE`.
113+
* `load_balancer_pass_to_target` - (Optional) Whether the target allow flow come from clb. If value is true, only check security group of clb, or check both clb and backend instance security group.
114+
* `master_zone_id` - (Optional) Setting master zone id of cross available zone disaster recovery, only applicable to open CLB.
59115
* `project_id` - (Optional, ForceNew) ID of the project within the CLB instance, `0` - Default Project.
60-
* `security_groups` - (Optional) Security groups of the CLB instance. Only supports `OPEN` CLBs.
116+
* `security_groups` - (Optional) Security groups of the CLB instance. Supports both `OPEN` and `INTERNAL` CLBs.
117+
* `slave_zone_id` - (Optional) Setting slave zone id of cross available zone disaster recovery, only applicable to open CLB. this zone will undertake traffic when the master is down.
61118
* `subnet_id` - (Optional, ForceNew) Subnet ID of the CLB. Effective only for CLB within the VPC. Only supports `INTERNAL` CLBs. Default is `ipv4`.
62119
* `tags` - (Optional) The available tags within this CLB.
63120
* `target_region_info_region` - (Optional) Region information of backend services are attached the CLB instance. Only supports `OPEN` CLBs.
64121
* `target_region_info_vpc_id` - (Optional) Vpc information of backend services are attached the CLB instance. Only supports `OPEN` CLBs.
65122
* `vpc_id` - (Optional, ForceNew) VPC ID of the CLB.
123+
* `zone_id` - (Optional) Available zone id, only applicable to open CLB.
66124

67125
## Attributes Reference
68126

website/docs/r/clb_target_group.html.markdown

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,35 @@ resource "tencentcloud_clb_target_group" "test" {
2020
}
2121
```
2222

23+
Create target group
24+
25+
```hcl
26+
resource "tencentcloud_clb_target_group" "test" {
27+
target_group_name = "hello1"
28+
port = 18082
29+
target_group_instances {
30+
bind_ip = "10.0.0.4"
31+
port = 18080
32+
}
33+
}
34+
```
35+
2336
## Argument Reference
2437

2538
The following arguments are supported:
2639

40+
* `port` - (Optional) The default port of target group, add server after can use it.
41+
* `target_group_instances` - (Optional) The backend server of target group bind.
2742
* `target_group_name` - (Optional) Target group name.
2843
* `vpc_id` - (Optional, ForceNew) VPC ID, default is based on the network.
2944

45+
The `target_group_instances` object supports the following:
46+
47+
* `bind_ip` - (Required) The internal ip of target group instance.
48+
* `port` - (Required) The port of target group instance.
49+
* `new_port` - (Optional) The new port of target group instance.
50+
* `weight` - (Optional) The weight of target group instance.
51+
3052
## Attributes Reference
3153

3254
In addition to all arguments above, the following attributes are exported:

website/docs/r/instance.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ resource "tencentcloud_subnet" "app" {
5252
// Create 2 CVM instances to host awesome_app
5353
resource "tencentcloud_instance" "my_awesome_app" {
5454
instance_name = "awesome_app"
55-
availability_zone = data.tencentcloud_availability_zones.my_favorate_zones.zones.0.name
55+
availability_zone = data.tencentcloud_availability_zones.my_favorite_zones.zones.0.name
5656
image_id = data.tencentcloud_images.my_favorite_image.images.0.image_id
5757
instance_type = data.tencentcloud_instance_types.my_favorite_instance_types.instance_types.0.instance_type
5858
system_disk_type = "CLOUD_PREMIUM"

website/docs/r/kubernetes_cluster.html.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ resource "tencentcloud_kubernetes_cluster" "managed_cluster" {
6464
internet_max_bandwidth_out = 100
6565
public_ip_assigned = true
6666
subnet_id = data.tencentcloud_vpc_subnets.vpc_first.instance_list.0.subnet_id
67+
img_id = "img-rkiynh11"
6768
6869
data_disk {
6970
disk_type = "CLOUD_PREMIUM"
@@ -304,7 +305,7 @@ The following arguments are supported:
304305
* `extra_args` - (Optional, ForceNew) Custom parameter information related to the node.
305306
* `globe_desired_pod_num` - (Optional, ForceNew) Indicate to set desired pod number in node. valid when enable_customized_pod_cidr=true, and it takes effect for all nodes.
306307
* `ignore_cluster_cidr_conflict` - (Optional, ForceNew) Indicates whether to ignore the cluster cidr conflict error. Default is false.
307-
* `is_non_static_ip_mode` - (Optional, ForceNew) Indicates whether static ip mode is enabled. Default is false.
308+
* `is_non_static_ip_mode` - (Optional, ForceNew) Indicates whether non-static ip mode is enabled. Default is false.
308309
* `kube_proxy_mode` - (Optional) Cluster kube-proxy mode, the available values include: 'kube-proxy-bpf'. Default is not set.When set to kube-proxy-bpf, cluster version greater than 1.14 and with Tencent Linux 2.4 is required.
309310
* `labels` - (Optional, ForceNew) Labels of tke cluster nodes.
310311
* `managed_cluster_internet_security_policies` - (Optional) Security policies for managed cluster internet, like:'192.168.1.0/24' or '113.116.51.27', '0.0.0.0/0' means all. This field can only set when field `cluster_deploy_type` is 'MANAGED_CLUSTER' and `cluster_internet` is true. `managed_cluster_internet_security_policies` can not delete or empty once be set.
@@ -355,6 +356,7 @@ The `master_config` object supports the following:
355356
* `enhanced_monitor_service` - (Optional, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE.
356357
* `enhanced_security_service` - (Optional, ForceNew) To specify whether to enable cloud security service. Default is TRUE.
357358
* `hostname` - (Optional, ForceNew) The host name of the attached instance. Dot (.) and dash (-) cannot be used as the first and last characters of HostName and cannot be used consecutively. Windows example: The length of the name character is [2, 15], letters (capitalization is not restricted), numbers and dashes (-) are allowed, dots (.) are not supported, and not all numbers are allowed. Examples of other types (Linux, etc.): The character length is [2, 60], and multiple dots are allowed. There is a segment between the dots. Each segment allows letters (with no limitation on capitalization), numbers and dashes (-).
359+
* `img_id` - (Optional) The valid image id, format of img-xxx.
358360
* `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`.
359361
* `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`.
360362
* `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.
@@ -394,6 +396,7 @@ The `worker_config` object supports the following:
394396
* `enhanced_monitor_service` - (Optional, ForceNew) To specify whether to enable cloud monitor service. Default is TRUE.
395397
* `enhanced_security_service` - (Optional, ForceNew) To specify whether to enable cloud security service. Default is TRUE.
396398
* `hostname` - (Optional, ForceNew) The host name of the attached instance. Dot (.) and dash (-) cannot be used as the first and last characters of HostName and cannot be used consecutively. Windows example: The length of the name character is [2, 15], letters (capitalization is not restricted), numbers and dashes (-) are allowed, dots (.) are not supported, and not all numbers are allowed. Examples of other types (Linux, etc.): The character length is [2, 60], and multiple dots are allowed. There is a segment between the dots. Each segment allows letters (with no limitation on capitalization), numbers and dashes (-).
399+
* `img_id` - (Optional) The valid image id, format of img-xxx.
397400
* `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`.
398401
* `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`.
399402
* `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.

0 commit comments

Comments
 (0)