support snapshot tags

Author: mikatong

.web-docs/components/builder/cvm/README.md

@@ -59,6 +59,9 @@ a [communicator](/packer/docs/templates/legacy_json_templates/communicator) can
 - `vpc_endpoint` (string) - The endpoint you want to reach the cloud endpoint,
   if tce cloud you should set a tce vpc endpoint.
 
+- `tag_endpoint` (string) - The endpoint you want to reach the cloud endpoint,
+  if tce cloud you should set a tce tag endpoint.
+
 - `security_token` (string) - STS access token, can be set through template or by exporting
   as environment variable such as `export TENCENTCLOUD_SECURITY_TOKEN=value`.
 
@@ -101,6 +104,8 @@ a [communicator](/packer/docs/templates/legacy_json_templates/communicator) can
 
 - `image_tags` (map[string]string) - Key/value pair tags that will be applied to the resulting image.
 
+- `snapshot_tags` (map[string]string) - Snapshot Tags
+
 - `skip_create_image` (bool) - Skip creating an image. When set to true, you don't need to enter target image information, share, copy, etc. The default value is false.
 
 <!-- End of code generated from the comments of the TencentCloudImageConfig struct in builder/tencentcloud/cvm/image_config.go; -->

builder/tencentcloud/cvm/access_config.go

@@ -13,6 +13,7 @@ import (
 
 	"github.com/hashicorp/packer-plugin-sdk/template/interpolate"
 	cvm "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm/v20170312"
+	tag "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag/v20180813"
 	vpc "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/vpc/v20170312"
 )
 
@@ -81,6 +82,9 @@ type TencentCloudAccessConfig struct {
 	// The endpoint you want to reach the cloud endpoint,
 	// if tce cloud you should set a tce vpc endpoint.
 	VpcEndpoint string `mapstructure:"vpc_endpoint" required:"false"`
+	// The endpoint you want to reach the cloud endpoint,
+	// if tce cloud you should set a tce tag endpoint.
+	TagEndpoint string `mapstructure:"tag_endpoint" required:"false"`
 	// The region validation can be skipped if this value is true, the default
 	// value is false.
 	skipValidation bool
@@ -121,26 +125,31 @@ type TencentCloudAccessRole struct {
 	SessionDuration int `mapstructure:"session_duration" required:"false"`
 }
 
-func (cf *TencentCloudAccessConfig) Client() (*cvm.Client, *vpc.Client, error) {
+func (cf *TencentCloudAccessConfig) Client() (*cvm.Client, *vpc.Client, *tag.Client, error) {
 	var (
 		err        error
 		cvm_client *cvm.Client
 		vpc_client *vpc.Client
+		tag_client *tag.Client
 	)
 
 	if err = cf.validateRegion(); err != nil {
-		return nil, nil, err
+		return nil, nil, nil, err
 	}
 
 	if cvm_client, err = NewCvmClient(cf); err != nil {
-		return nil, nil, err
+		return nil, nil, nil, err
 	}
 
 	if vpc_client, err = NewVpcClient(cf); err != nil {
-		return nil, nil, err
+		return nil, nil, nil, err
+	}
+
+	if tag_client, err = NewTagClient(cf); err != nil {
+		return nil, nil, nil, err
 	}
 
-	return cvm_client, vpc_client, nil
+	return cvm_client, vpc_client, tag_client, nil
 }
 
 func (cf *TencentCloudAccessConfig) Prepare(ctx *interpolate.Context) []error {
@@ -150,9 +159,8 @@ func (cf *TencentCloudAccessConfig) Prepare(ctx *interpolate.Context) []error {
 		errs = append(errs, err)
 	}
 
-	if (cf.CvmEndpoint != "" && cf.VpcEndpoint == "") ||
-		(cf.CvmEndpoint == "" && cf.VpcEndpoint != "") {
-		errs = append(errs, fmt.Errorf("parameter cvm_endpoint and vpc_endpoint must be set simultaneously"))
+	if cf.CvmEndpoint == "" || cf.VpcEndpoint == "" || cf.TagEndpoint == "" {
+		errs = append(errs, fmt.Errorf("parameter cvm_endpoint, vpc_endpoint and tag_endpoint must be set simultaneously"))
 	}
 
 	if cf.Region == "" {

builder/tencentcloud/cvm/builder.go

@@ -75,7 +75,7 @@ func (b *Builder) Prepare(raws ...interface{}) ([]string, []string, error) {
 }
 
 func (b *Builder) Run(ctx context.Context, ui packersdk.Ui, hook packersdk.Hook) (packersdk.Artifact, error) {
-	cvmClient, vpcClient, err := b.config.Client()
+	cvmClient, vpcClient, tagClient, err := b.config.Client()
 	if err != nil {
 		return nil, err
 	}
@@ -84,6 +84,7 @@ func (b *Builder) Run(ctx context.Context, ui packersdk.Ui, hook packersdk.Hook)
 	state.Put("config", &b.config)
 	state.Put("cvm_client", cvmClient)
 	state.Put("vpc_client", vpcClient)
+	state.Put("tag_client", tagClient)
 	state.Put("hook", hook)
 	state.Put("ui", ui)
 

builder/tencentcloud/cvm/builder.hcl2spec.go

@@ -8,6 +8,7 @@ import (
 	"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
 	cvm "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm/v20170312"
 	sts "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/sts/v20180813"
+	tag "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag/v20180813"
 	vpc "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/vpc/v20170312"
 )
 
@@ -20,6 +21,7 @@ type TencentCloudClient struct {
 	vpcConn *vpc.Client
 	cvmConn *cvm.Client
 	stsConn *sts.Client
+	tagConn *tag.Client
 }
 
 func (me *TencentCloudClient) UseVpcClient(cpf *profile.ClientProfile) *vpc.Client {
@@ -53,3 +55,13 @@ func (me *TencentCloudClient) UseStsClient() *sts.Client {
 
 	return me.stsConn
 }
+
+func (me *TencentCloudClient) UseTagClient(cpf *profile.ClientProfile) *tag.Client {
+	if me.tagConn != nil {
+		return me.tagConn
+	}
+
+	me.tagConn, _ = tag.NewClient(me.Credential, me.Region, cpf)
+
+	return me.tagConn
+}

builder/tencentcloud/cvm/client.go

@@ -19,6 +19,7 @@ import (
 	"github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common/profile"
 	cvm "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm/v20170312"
 	sts "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/sts/v20180813"
+	tag "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag/v20180813"
 	vpc "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/vpc/v20170312"
 )
 
@@ -78,6 +79,27 @@ func WaitForImageReady(ctx context.Context, client *cvm.Client, imageName string
 	}
 }
 
+func AddResourceTag(ctx context.Context, client *tag.Client, resourceName string, tags map[string]string) error {
+	request := tag.NewModifyResourceTagsRequest()
+	request.Resource = &resourceName
+	request.ReplaceTags = make([]*tag.Tag, 0, len(tags))
+	for k, v := range tags {
+		key := k
+		value := v
+		replaceTag := &tag.Tag{
+			TagKey:   &key,
+			TagValue: &value,
+		}
+		request.ReplaceTags = append(request.ReplaceTags, replaceTag)
+	}
+
+	err := Retry(ctx, func(ctx context.Context) error {
+		_, e := client.ModifyResourceTags(request)
+		return e
+	})
+	return err
+}
+
 // GetImageByName get image by image name
 func GetImageByName(ctx context.Context, client *cvm.Client, imageName string) (*cvm.Image, error) {
 	req := cvm.NewDescribeImagesRequest()
@@ -143,6 +165,22 @@ func NewVpcClient(cf *TencentCloudAccessConfig) (client *vpc.Client, err error)
 	return
 }
 
+// UseTagClient returns a new tag client
+func NewTagClient(cf *TencentCloudAccessConfig) (client *tag.Client, err error) {
+	apiV3Conn, err := packerConfigClient(cf)
+	if err != nil {
+		return nil, err
+	}
+
+	tagClientProfile, err := newClientProfile(cf.TagEndpoint)
+	if err != nil {
+		return nil, err
+	}
+	client = apiV3Conn.UseTagClient(tagClientProfile)
+
+	return
+}
+
 // CheckResourceIdFormat check resource id format
 func CheckResourceIdFormat(resource string, id string) bool {
 	regex := regexp.MustCompile(fmt.Sprintf("%s-[0-9a-z]{8}$", resource))
@@ -322,3 +360,10 @@ func IntUint64(i int) *uint64 {
 	u := uint64(i)
 	return &u
 }
+
+// BuildTagResourceName builds the Tencent Cloud specific name of a resource description.
+// The format is `qcs:project_id:service_type:region:account:resource`.
+// For more information, go to https://cloud.tencent.com/document/product/598/10606.
+func BuildTagResourceName(serviceType, resourceType, region, id string) string {
+	return fmt.Sprintf("qcs::%s:%s:uin/:%s/%s", serviceType, region, resourceType, id)
+}

builder/tencentcloud/cvm/common.go

@@ -32,6 +32,7 @@ type TencentCloudImageConfig struct {
 	ImageShareAccounts []string `mapstructure:"image_share_accounts" required:"false"`
 	// Key/value pair tags that will be applied to the resulting image.
 	ImageTags      map[string]string `mapstructure:"image_tags" required:"false"`
+	SnapshotTags   map[string]string `mapstructure:"snapshot_tags" required:"false"`
 	skipValidation bool
 	// Skip creating an image. When set to true, you don't need to enter target image information, share, copy, etc. The default value is false.
 	SkipCreateImage bool `mapstructure:"skip_create_image" required:"false"`
@@ -79,6 +80,9 @@ func (cf *TencentCloudImageConfig) Prepare(ctx *interpolate.Context) []error {
 	if cf.ImageTags == nil {
 		cf.ImageTags = make(map[string]string)
 	}
+	if cf.SnapshotTags == nil {
+		cf.SnapshotTags = make(map[string]string)
+	}
 
 	if len(errs) > 0 {
 		return errs

builder/tencentcloud/cvm/image_config.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/hashicorp/packer-plugin-sdk/multistep"
 	cvm "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm/v20170312"
+	tag "github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag/v20180813"
 )
 
 type stepCreateImage struct {
@@ -18,6 +19,7 @@ type stepCreateImage struct {
 
 func (s *stepCreateImage) Run(ctx context.Context, state multistep.StateBag) multistep.StepAction {
 	client := state.Get("cvm_client").(*cvm.Client)
+	tagClient := state.Get("tag_client").(*tag.Client)
 
 	config := state.Get("config").(*Config)
 	instance := state.Get("instance").(*cvm.Instance)
@@ -106,6 +108,15 @@ func (s *stepCreateImage) Run(ctx context.Context, state multistep.StateBag) mul
 	state.Put("image", image)
 	Message(state, s.imageId, "Image created")
 
+	snapshotTags := config.SnapshotTags
+	if len(snapshotTags) > 0 {
+		for _, snapshot := range image.SnapshotSet {
+			resourceName := BuildTagResourceName("cvm", "snapshot", config.Region, *snapshot.SnapshotId)
+			err := AddResourceTag(ctx, tagClient, resourceName, snapshotTags)
+			return Halt(state, err, "Failed to set tag for snapshot")
+		}
+	}
+
 	tencentCloudImages := make(map[string]string)
 	tencentCloudImages[config.Region] = s.imageId
 	state.Put("tencentcloudimages", tencentCloudImages)

builder/tencentcloud/cvm/step_create_image.go

@@ -105,7 +105,7 @@ func (d *Datasource) Execute() (cty.Value, error) {
 }
 
 func (d *Datasource) ResolveImageByFilters() (*cvm.Image, error) {
-	client, _, err := d.config.Client()
+	client, _, _, err := d.config.Client()
 	if err != nil {
 		return nil, err
 	}
@@ -150,7 +150,7 @@ func (d *Datasource) ResolveImageByFilters() (*cvm.Image, error) {
 }
 
 func (d *Datasource) ResolveImageByImageFamily() (*cvm.Image, error) {
-	client, _, err := d.config.Client()
+	client, _, _, err := d.config.Client()
 	if err != nil {
 		return nil, err
 	}

datasource/tencentcloud/image/data.go

@@ -6,6 +6,9 @@
 - `vpc_endpoint` (string) - The endpoint you want to reach the cloud endpoint,
   if tce cloud you should set a tce vpc endpoint.
 
+- `tag_endpoint` (string) - The endpoint you want to reach the cloud endpoint,
+  if tce cloud you should set a tce tag endpoint.
+
 - `security_token` (string) - STS access token, can be set through template or by exporting
   as environment variable such as `export TENCENTCLOUD_SECURITY_TOKEN=value`.
 

datasource/tencentcloud/image/data.hcl2spec.go

@@ -15,6 +15,8 @@
 
 - `image_tags` (map[string]string) - Key/value pair tags that will be applied to the resulting image.
 
+- `snapshot_tags` (map[string]string) - Snapshot Tags
+
 - `skip_create_image` (bool) - Skip creating an image. When set to true, you don't need to enter target image information, share, copy, etc. The default value is false.
 
 <!-- End of code generated from the comments of the TencentCloudImageConfig struct in builder/tencentcloud/cvm/image_config.go; -->

docs-partials/builder/tencentcloud/cvm/TencentCloudAccessConfig-not-required.mdx

@@ -6,13 +6,19 @@ require (
 	github.com/hashicorp/hcl/v2 v2.19.1
 	github.com/hashicorp/packer-plugin-sdk v0.5.2
 	github.com/pkg/errors v0.9.1
-	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.1072
+	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/common v1.0.1175
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/cvm v1.0.1072
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/sts v1.0.797
+	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/tag v1.0.1175
 	github.com/tencentcloud/tencentcloud-sdk-go/tencentcloud/vpc v1.0.1072
 	github.com/zclconf/go-cty v1.13.3
 )
 
+require (
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
+	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
+)
+
 require (
 	cloud.google.com/go v0.105.0 // indirect
 	cloud.google.com/go/compute v1.12.1 // indirect