Skip to content

Commit bf659d3

Browse files
author
sylviamoss
committed
Consolidate docs
1 parent 1e3f5c4 commit bf659d3

11 files changed

+862
-13
lines changed

builder/tencentcloud/version/version.go

Lines changed: 0 additions & 13 deletions
This file was deleted.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!-- Code generated from the comments of the TencentCloudAccessConfig struct in builder/tencentcloud/cvm/access_config.go; DO NOT EDIT MANUALLY -->
2+
3+
- `skip_region_validation` (bool) - Do not check region and zone when validate.
4+
5+
<!-- End of code generated from the comments of the TencentCloudAccessConfig struct in builder/tencentcloud/cvm/access_config.go; -->
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!-- Code generated from the comments of the TencentCloudAccessConfig struct in builder/tencentcloud/cvm/access_config.go; DO NOT EDIT MANUALLY -->
2+
3+
- `secret_id` (string) - Tencentcloud secret id. You should set it directly,
4+
or set the TENCENTCLOUD_ACCESS_KEY environment variable.
5+
6+
- `secret_key` (string) - Tencentcloud secret key. You should set it directly,
7+
or set the TENCENTCLOUD_SECRET_KEY environment variable.
8+
9+
- `region` (string) - The region where your cvm will be launch. You should
10+
reference Region and Zone
11+
for parameter taking.
12+
13+
- `zone` (string) - The zone where your cvm will be launch. You should
14+
reference Region and Zone
15+
for parameter taking.
16+
17+
<!-- End of code generated from the comments of the TencentCloudAccessConfig struct in builder/tencentcloud/cvm/access_config.go; -->
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- Code generated from the comments of the TencentCloudImageConfig struct in builder/tencentcloud/cvm/image_config.go; DO NOT EDIT MANUALLY -->
2+
3+
- `image_description` (string) - Image description.
4+
5+
- `reboot` (bool) - Whether shutdown cvm to create Image. Default value is
6+
false.
7+
8+
- `force_poweroff` (bool) - Whether to force power off cvm when create image.
9+
Default value is false.
10+
11+
- `sysprep` (bool) - Whether enable Sysprep during creating windows image.
12+
13+
- `image_force_delete` (bool) - Image Force Delete
14+
15+
- `image_copy_regions` ([]string) - regions that will be copied to after
16+
your image created.
17+
18+
- `image_share_accounts` ([]string) - accounts that will be shared to
19+
after your image created.
20+
21+
- `skip_region_validation` (bool) - Do not check region and zone when validate.
22+
23+
<!-- End of code generated from the comments of the TencentCloudImageConfig struct in builder/tencentcloud/cvm/image_config.go; -->
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!-- Code generated from the comments of the TencentCloudImageConfig struct in builder/tencentcloud/cvm/image_config.go; DO NOT EDIT MANUALLY -->
2+
3+
- `image_name` (string) - The name you want to create your customize image,
4+
it should be composed of no more than 60 characters, of letters, numbers
5+
or minus sign.
6+
7+
<!-- End of code generated from the comments of the TencentCloudImageConfig struct in builder/tencentcloud/cvm/image_config.go; -->
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<!-- Code generated from the comments of the TencentCloudRunConfig struct in builder/tencentcloud/cvm/run_config.go; DO NOT EDIT MANUALLY -->
2+
3+
- `associate_public_ip_address` (bool) - Whether allocate public ip to your cvm.
4+
Default value is false.
5+
6+
- `source_image_id` (string) - The base image id of Image you want to create
7+
your customized image from.
8+
9+
- `source_image_name` (string) - The base image name of Image you want to create your
10+
customized image from.Conflict with SourceImageId.
11+
12+
- `instance_name` (string) - Instance name.
13+
14+
- `disk_type` (string) - Root disk type your cvm will be launched by, default is `CLOUD_PREMIUM`. you could
15+
reference Disk Type
16+
for parameter taking.
17+
18+
- `disk_size` (int64) - Root disk size your cvm will be launched by. values range(in GB):
19+
20+
- `data_disks` ([]tencentCloudDataDisk) - Add one or more data disks to the instance before creating the image.
21+
Note that if the source image has data disk snapshots, this argument
22+
will be ignored, and the running instance will use source image data
23+
disk settings, in such case, `disk_type` argument will be used as disk
24+
type for all data disks, and each data disk size will use the origin
25+
value in source image.
26+
The data disks allow for the following argument:
27+
- `disk_type` - Type of the data disk. Valid choices: `CLOUD_BASIC`, `CLOUD_PREMIUM` and `CLOUD_SSD`.
28+
- `disk_size` - Size of the data disk.
29+
- `disk_snapshot_id` - Id of the snapshot for a data disk.
30+
31+
- `vpc_id` (string) - Specify vpc your cvm will be launched by.
32+
33+
- `vpc_name` (string) - Specify vpc name you will create. if vpc_id is not set, packer will
34+
create a vpc for you named this parameter.
35+
36+
- `vpc_ip` (string) - Vpc Ip
37+
38+
- `subnet_id` (string) - Specify subnet your cvm will be launched by.
39+
40+
- `subnet_name` (string) - Specify subnet name you will create. if subnet_id is not set, packer will
41+
create a subnet for you named this parameter.
42+
43+
- `cidr_block` (string) - Specify cider block of the vpc you will create if vpc_id not set
44+
45+
- `subnect_cidr_block` (string) - Specify cider block of the subnet you will create if
46+
subnet_id not set
47+
48+
- `internet_charge_type` (string) - Internet Charge Type
49+
50+
- `internet_max_bandwidth_out` (int64) - Max bandwidth out your cvm will be launched by(in MB).
51+
values can be set between 1 ~ 100.
52+
53+
- `security_group_id` (string) - Specify securitygroup your cvm will be launched by.
54+
55+
- `security_group_name` (string) - Specify security name you will create if security_group_id not set.
56+
57+
- `user_data` (string) - userdata.
58+
59+
- `user_data_file` (string) - userdata file.
60+
61+
- `host_name` (string) - host name.
62+
63+
- `run_tags` (map[string]string) - Key/value pair tags to apply to the instance that is *launched* to
64+
create the image. These tags are *not* applied to the resulting image.
65+
66+
- `run_tag` ([]{key string, value string}) - Same as [`run_tags`](#run_tags) but defined as a singular repeatable
67+
block containing a `key` and a `value` field. In HCL2 mode the
68+
[`dynamic_block`](/docs/templates/hcl_templates/expressions#dynamic-blocks)
69+
will allow you to create those programatically.
70+
71+
- `ssh_private_ip` (bool) - SSH Private Ip
72+
73+
<!-- End of code generated from the comments of the TencentCloudRunConfig struct in builder/tencentcloud/cvm/run_config.go; -->
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<!-- Code generated from the comments of the TencentCloudRunConfig struct in builder/tencentcloud/cvm/run_config.go; DO NOT EDIT MANUALLY -->
2+
3+
- `instance_type` (string) - The instance type your cvm will be launched by.
4+
You should reference Instace Type
5+
for parameter taking.
6+
7+
<!-- End of code generated from the comments of the TencentCloudRunConfig struct in builder/tencentcloud/cvm/run_config.go; -->
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!-- Code generated from the comments of the tencentCloudDataDisk struct in builder/tencentcloud/cvm/run_config.go; DO NOT EDIT MANUALLY -->
2+
3+
- `disk_type` (string) - Disk Type
4+
5+
- `disk_size` (int64) - Disk Size
6+
7+
- `disk_snapshot_id` (string) - Snapshot Id
8+
9+
<!-- End of code generated from the comments of the tencentCloudDataDisk struct in builder/tencentcloud/cvm/run_config.go; -->

go.mod

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
module github.com/hashicorp/packer-plugin-tencentcloud
2+
3+
go 1.16
4+
5+
require (
6+
github.com/hashicorp/hcl/v2 v2.10.0
7+
github.com/hashicorp/packer-plugin-sdk v0.2.0
8+
github.com/pkg/errors v0.9.1
9+
github.com/tencentcloud/tencentcloud-sdk-go v1.0.140
10+
github.com/zclconf/go-cty v1.8.2
11+
)

0 commit comments

Comments
 (0)