Skip to content

Commit d73ab57

Browse files
committed
feat: update docs and version
1 parent 7a483e0 commit d73ab57

File tree

46 files changed

+1033
-102
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1033
-102
lines changed

common/common_volcengine_version.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ package common
22

33
const (
44
TerraformProviderName = "terraform-provider-volcengine"
5-
TerraformProviderVersion = "0.0.153"
5+
TerraformProviderVersion = "0.0.154"
66
)

volcengine/clb/listener/resource_volcengine_listener.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ func ResourceVolcengineListener() *schema.Resource {
203203
DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
204204
return (d.Get("protocol").(string) != "TCP" && d.Get("protocol").(string) != "UDP") || d.Get("connection_drain_enabled").(string) != "on"
205205
},
206-
Description: "The connection drain timeout of the Listener. Valid value range is `1-900`.\n" +
206+
Description: "The connection drain timeout of the Listener. Valid value range is `0-900`.\n" +
207207
"This filed is required when the value of field `connection_drain_enabled` is `on`.",
208208
},
209209
"health_check": {

volcengine/tls/topic/resource_volcengine_tls_topic.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ func ResourceVolcengineTlsTopic() *schema.Resource {
6464
DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
6565
return d.Id() == ""
6666
},
67-
Description: "The id of shard to be manually split. This field is valid only when modifying the topic." +
68-
"When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields. \n",
67+
Description: "The id of shard to be manually split. This field is valid only when modifying the topic. \n" +
68+
"When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.",
6969
},
7070
"manual_split_shard_number": {
7171
Type: schema.TypeInt,

website/docs/d/customer_gateways.html.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ The following arguments are supported:
2727
* `ip_address` - (Optional) A IP address of the customer gateway.
2828
* `name_regex` - (Optional) A Name Regex of customer gateway.
2929
* `output_file` - (Optional) File name where to save data source results.
30+
* `project_name` - (Optional) The project name of the VPN customer gateway.
3031

3132
## Attributes Reference
3233
In addition to all arguments above, the following attributes are exported:
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
subcategory: "EBS"
3+
layout: "volcengine"
4+
page_title: "Volcengine: volcengine_ebs_auto_snapshot_policies"
5+
sidebar_current: "docs-volcengine-datasource-ebs_auto_snapshot_policies"
6+
description: |-
7+
Use this data source to query detailed information of ebs auto snapshot policies
8+
---
9+
# volcengine_ebs_auto_snapshot_policies
10+
Use this data source to query detailed information of ebs auto snapshot policies
11+
## Example Usage
12+
```hcl
13+
resource "volcengine_ebs_auto_snapshot_policy" "foo" {
14+
auto_snapshot_policy_name = "acc-test-auto-snapshot-policy"
15+
time_points = [1, 5, 9]
16+
retention_days = -1
17+
repeat_weekdays = [2, 6]
18+
project_name = "default"
19+
tags {
20+
key = "k1"
21+
value = "v1"
22+
}
23+
count = 2
24+
}
25+
26+
data "volcengine_ebs_auto_snapshot_policies" "foo" {
27+
ids = volcengine_ebs_auto_snapshot_policy.foo[*].id
28+
}
29+
```
30+
## Argument Reference
31+
The following arguments are supported:
32+
* `ids` - (Optional) A list of auto snapshot policy IDs.
33+
* `name_regex` - (Optional) A Name Regex of Resource.
34+
* `output_file` - (Optional) File name where to save data source results.
35+
* `project_name` - (Optional) The project name of auto snapshot policy.
36+
* `tags` - (Optional) Tags.
37+
38+
The `tags` object supports the following:
39+
40+
* `key` - (Required) The Key of Tags.
41+
* `value` - (Required) The Value of Tags.
42+
43+
## Attributes Reference
44+
In addition to all arguments above, the following attributes are exported:
45+
* `auto_snapshot_policies` - The collection of query.
46+
* `auto_snapshot_policy_id` - The id of the auto snapshot policy.
47+
* `auto_snapshot_policy_name` - The name of the auto snapshot policy.
48+
* `created_at` - The creation time of the auto snapshot policy.
49+
* `id` - The id of the auto snapshot policy.
50+
* `project_name` - The project name of the auto snapshot policy.
51+
* `repeat_days` - Create snapshots repeatedly on a daily basis, with intervals of a certain number of days between each snapshot.
52+
* `repeat_weekdays` - The date of creating snapshot repeatedly by week. The value range is `1-7`, for example, 1 represents Monday.
53+
* `retention_days` - The retention days of the auto snapshot. `-1` means permanently preserving the snapshot.
54+
* `status` - The status of the auto snapshot policy.
55+
* `tags` - Tags.
56+
* `key` - The Key of Tags.
57+
* `value` - The Value of Tags.
58+
* `time_points` - The creation time points of the auto snapshot policy. The value range is `0~23`, representing a total of 24 time points from 00:00 to 23:00, for example, 1 represents 01:00.
59+
* `updated_at` - The updated time of the auto snapshot policy.
60+
* `volume_nums` - The number of volumes associated with the auto snapshot policy.
61+
* `total_count` - The total count of query.
62+
63+
Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
subcategory: "EBS"
3+
layout: "volcengine"
4+
page_title: "Volcengine: volcengine_ebs_snapshot_groups"
5+
sidebar_current: "docs-volcengine-datasource-ebs_snapshot_groups"
6+
description: |-
7+
Use this data source to query detailed information of ebs snapshot groups
8+
---
9+
# volcengine_ebs_snapshot_groups
10+
Use this data source to query detailed information of ebs snapshot groups
11+
## Example Usage
12+
```hcl
13+
data "volcengine_zones" "foo" {
14+
}
15+
16+
resource "volcengine_vpc" "foo" {
17+
vpc_name = "acc-test-vpc"
18+
cidr_block = "172.16.0.0/16"
19+
}
20+
21+
resource "volcengine_subnet" "foo" {
22+
subnet_name = "acc-test-subnet"
23+
cidr_block = "172.16.0.0/24"
24+
zone_id = data.volcengine_zones.foo.zones[0].id
25+
vpc_id = volcengine_vpc.foo.id
26+
}
27+
28+
resource "volcengine_security_group" "foo" {
29+
security_group_name = "acc-test-security-group"
30+
vpc_id = volcengine_vpc.foo.id
31+
}
32+
33+
data "volcengine_images" "foo" {
34+
os_type = "Linux"
35+
visibility = "public"
36+
instance_type_id = "ecs.g3il.large"
37+
}
38+
39+
resource "volcengine_ecs_instance" "foo" {
40+
instance_name = "acc-test-ecs"
41+
description = "acc-test"
42+
host_name = "tf-acc-test"
43+
image_id = data.volcengine_images.foo.images[0].image_id
44+
instance_type = "ecs.g3il.large"
45+
password = "93f0cb0614Aab12"
46+
instance_charge_type = "PostPaid"
47+
system_volume_type = "ESSD_PL0"
48+
system_volume_size = 40
49+
subnet_id = volcengine_subnet.foo.id
50+
security_group_ids = [volcengine_security_group.foo.id]
51+
project_name = "default"
52+
tags {
53+
key = "k1"
54+
value = "v1"
55+
}
56+
}
57+
58+
resource "volcengine_volume" "foo" {
59+
volume_name = "acc-test-volume"
60+
volume_type = "ESSD_PL0"
61+
description = "acc-test"
62+
kind = "data"
63+
size = 500
64+
zone_id = data.volcengine_zones.foo.zones[0].id
65+
volume_charge_type = "PostPaid"
66+
project_name = "default"
67+
}
68+
69+
resource "volcengine_volume_attach" "foo" {
70+
instance_id = volcengine_ecs_instance.foo.id
71+
volume_id = volcengine_volume.foo.id
72+
}
73+
74+
resource "volcengine_ebs_snapshot_group" "foo" {
75+
volume_ids = [volcengine_ecs_instance.foo.system_volume_id, volcengine_volume.foo.id]
76+
instance_id = volcengine_ecs_instance.foo.id
77+
name = "acc-test-snapshot-group"
78+
description = "acc-test"
79+
project_name = "default"
80+
tags {
81+
key = "k1"
82+
value = "v1"
83+
}
84+
depends_on = [volcengine_volume_attach.foo]
85+
}
86+
87+
data "volcengine_ebs_snapshot_groups" "foo" {
88+
ids = [volcengine_ebs_snapshot_group.foo.id]
89+
}
90+
```
91+
## Argument Reference
92+
The following arguments are supported:
93+
* `ids` - (Optional) A list of snapshot group IDs.
94+
* `instance_id` - (Optional) The instance id of snapshot group.
95+
* `name_regex` - (Optional) A Name Regex of Resource.
96+
* `name` - (Optional) The name of snapshot group.
97+
* `output_file` - (Optional) File name where to save data source results.
98+
* `project_name` - (Optional) The project name of snapshot group.
99+
* `status` - (Optional) A list of snapshot group status. Valid values: `creating`, `available`, `failed`.
100+
101+
## Attributes Reference
102+
In addition to all arguments above, the following attributes are exported:
103+
* `snapshot_groups` - The collection of query.
104+
* `creation_time` - The creation time of the snapshot group.
105+
* `description` - The description of the snapshot group.
106+
* `id` - The id of the snapshot group.
107+
* `image_id` - The image id of the snapshot group.
108+
* `instance_id` - The instance id of the snapshot group.
109+
* `name` - The name of the snapshot group.
110+
* `project_name` - The project name of the snapshot group.
111+
* `snapshot_group_id` - The id of the snapshot group.
112+
* `snapshots` - The snapshots of the snapshot group.
113+
* `creation_time` - The creation time of the snapshot.
114+
* `description` - The description of the snapshot.
115+
* `image_id` - The image id of the snapshot.
116+
* `progress` - The progress of the snapshot.
117+
* `project_name` - The id of the snapshot.
118+
* `retention_days` - The id of the snapshot.
119+
* `snapshot_id` - The id of the snapshot.
120+
* `snapshot_name` - The name of the snapshot.
121+
* `snapshot_type` - The type of the snapshot.
122+
* `status` - The status of the snapshot.
123+
* `tags` - Tags.
124+
* `key` - The Key of Tags.
125+
* `value` - The Value of Tags.
126+
* `volume_id` - The volume id of the snapshot.
127+
* `volume_kind` - The volume kind of the snapshot.
128+
* `volume_name` - The volume name of the snapshot.
129+
* `volume_size` - The volume size of the snapshot.
130+
* `volume_status` - The volume status of the snapshot.
131+
* `volume_type` - The volume type of the snapshot.
132+
* `zone_id` - The zone id of the snapshot.
133+
* `status` - The status of the snapshot group.
134+
* `tags` - Tags.
135+
* `key` - The Key of Tags.
136+
* `value` - The Value of Tags.
137+
* `total_count` - The total count of query.
138+
139+
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
subcategory: "EBS"
3+
layout: "volcengine"
4+
page_title: "Volcengine: volcengine_ebs_snapshots"
5+
sidebar_current: "docs-volcengine-datasource-ebs_snapshots"
6+
description: |-
7+
Use this data source to query detailed information of ebs snapshots
8+
---
9+
# volcengine_ebs_snapshots
10+
Use this data source to query detailed information of ebs snapshots
11+
## Example Usage
12+
```hcl
13+
data "volcengine_zones" "foo" {
14+
}
15+
16+
resource "volcengine_volume" "foo" {
17+
volume_name = "acc-test-volume"
18+
volume_type = "ESSD_PL0"
19+
description = "acc-test"
20+
kind = "data"
21+
size = 500
22+
zone_id = data.volcengine_zones.foo.zones[0].id
23+
volume_charge_type = "PostPaid"
24+
project_name = "default"
25+
}
26+
27+
resource "volcengine_ebs_snapshot" "foo" {
28+
volume_id = volcengine_volume.foo.id
29+
snapshot_name = "acc-test-snapshot"
30+
description = "acc-test"
31+
retention_days = 3
32+
project_name = "default"
33+
tags {
34+
key = "k1"
35+
value = "v1"
36+
}
37+
count = 2
38+
}
39+
40+
data "volcengine_ebs_snapshots" "foo" {
41+
ids = volcengine_ebs_snapshot.foo[*].id
42+
}
43+
```
44+
## Argument Reference
45+
The following arguments are supported:
46+
* `ids` - (Optional) A list of snapshot IDs.
47+
* `name_regex` - (Optional) A Name Regex of Resource.
48+
* `output_file` - (Optional) File name where to save data source results.
49+
* `project_name` - (Optional) The project name of snapshot.
50+
* `snapshot_status` - (Optional) A list of snapshot status.
51+
* `tags` - (Optional) Tags.
52+
* `zone_id` - (Optional) The zone id of snapshot.
53+
54+
The `tags` object supports the following:
55+
56+
* `key` - (Required) The Key of Tags.
57+
* `value` - (Required) The Value of Tags.
58+
59+
## Attributes Reference
60+
In addition to all arguments above, the following attributes are exported:
61+
* `snapshots` - The collection of query.
62+
* `creation_time` - The creation time of the snapshot.
63+
* `description` - The description of the snapshot.
64+
* `id` - The id of the snapshot.
65+
* `project_name` - The project name of the snapshot.
66+
* `retention_days` - The retention days of the snapshot.
67+
* `snapshot_id` - The id of the snapshot.
68+
* `snapshot_name` - The name of the snapshot.
69+
* `snapshot_type` - The type of the snapshot.
70+
* `status` - The status of the snapshot.
71+
* `tags` - Tags.
72+
* `key` - The Key of Tags.
73+
* `value` - The Value of Tags.
74+
* `volume_id` - The volume id of the snapshot.
75+
* `volume_kind` - The volume kind of the snapshot.
76+
* `volume_name` - The volume name of the snapshot.
77+
* `volume_size` - The volume size of the snapshot.
78+
* `volume_status` - The volume status of the snapshot.
79+
* `volume_type` - The volume type of the snapshot.
80+
* `zone_id` - The zone id of the snapshot.
81+
* `total_count` - The total count of query.
82+
83+
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
subcategory: "ECS"
3+
layout: "volcengine"
4+
page_title: "Volcengine: volcengine_ecs_hpc_clusters"
5+
sidebar_current: "docs-volcengine-datasource-ecs_hpc_clusters"
6+
description: |-
7+
Use this data source to query detailed information of ecs hpc clusters
8+
---
9+
# volcengine_ecs_hpc_clusters
10+
Use this data source to query detailed information of ecs hpc clusters
11+
## Example Usage
12+
```hcl
13+
data "volcengine_ecs_hpc_clusters" "foo" {
14+
zone_id = "cn-beijing-a"
15+
}
16+
```
17+
## Argument Reference
18+
The following arguments are supported:
19+
* `name_regex` - (Optional) A Name Regex of Resource.
20+
* `output_file` - (Optional) File name where to save data source results.
21+
* `zone_id` - (Optional) The zone id of the hpc cluster.
22+
23+
## Attributes Reference
24+
In addition to all arguments above, the following attributes are exported:
25+
* `hpc_clusters` - The collection of query.
26+
* `created_at` - The created time of the hpc cluster.
27+
* `description` - The description of the hpc cluster.
28+
* `hpc_cluster_id` - The id of the hpc cluster.
29+
* `id` - The id of the hpc cluster.
30+
* `name` - The name of the hpc cluster.
31+
* `updated_at` - The updated time of the hpc cluster.
32+
* `vpc_id` - The vpc id of the hpc cluster.
33+
* `zone_id` - The zone id of the hpc cluster.
34+
* `total_count` - The total count of query.
35+
36+

website/docs/d/ecs_instance_types.html.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ data "volcengine_ecs_instance_types" "foo" {}
1515
## Argument Reference
1616
The following arguments are supported:
1717
* `ids` - (Optional) A list of instance type IDs. When the number of ids is greater than 10, only the first 10 are effective.
18+
* `image_id` - (Optional) The id of image.
1819
* `output_file` - (Optional) File name where to save data source results.
1920

2021
## Attributes Reference

website/docs/d/ecs_instances.html.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,14 @@ data "volcengine_ecs_instances" "foo" {
6868
## Argument Reference
6969
The following arguments are supported:
7070
* `deployment_set_ids` - (Optional) A list of DeploymentSet IDs.
71+
* `eip_addresses` - (Optional) A list of Eip addresses.
7172
* `hpc_cluster_id` - (Optional) The hpc cluster ID of ECS instance.
7273
* `ids` - (Optional) A list of ECS instance IDs.
7374
* `instance_charge_type` - (Optional) The charge type of ECS instance.
7475
* `instance_name` - (Optional) The name of ECS instance. This field support fuzzy query.
76+
* `instance_type_families` - (Optional) A list of instance type families.
77+
* `instance_type_ids` - (Optional) A list of instance type IDs.
78+
* `ipv6_addresses` - (Optional) A list of ipv6 addresses.
7579
* `key_pair_name` - (Optional) The key pair name of ECS instance.
7680
* `name_regex` - (Optional) A Name Regex of ECS instance.
7781
* `output_file` - (Optional) File name where to save data source results.

0 commit comments

Comments
 (0)