packer-cn/builder/triton/target_image_config.go

//go:generate struct-markdown

package triton

import (
	"fmt"

	"github.com/hashicorp/packer-plugin-sdk/template/config"
	"github.com/hashicorp/packer-plugin-sdk/template/interpolate"
)

// TargetImageConfig represents the configuration for the image to be created
// from the source machine.
type TargetImageConfig struct {
	// The name the finished image in Triton will be
	// assigned. Maximum 512 characters but should in practice be much shorter
	// (think between 5 and 20 characters). For example postgresql-95-server for
	// an image used as a PostgreSQL 9.5 server.
	ImageName string `mapstructure:"image_name" required:"true"`
	// The version string for this image. Maximum 128
	// characters. Any string will do but a format of Major.Minor.Patch is
	// strongly advised by Joyent. See Semantic Versioning
	// for more information on the Major.Minor.Patch versioning format.
	ImageVersion string `mapstructure:"image_version" required:"true"`
	// Description of the image. Maximum 512
	// characters.
	ImageDescription string `mapstructure:"image_description" required:"false"`
	// URL of the homepage where users can find
	// information about the image. Maximum 128 characters.
	ImageHomepage string `mapstructure:"image_homepage" required:"false"`
	// URL of the End User License Agreement (EULA)
	// for the image. Maximum 128 characters.
	ImageEULA string `mapstructure:"image_eula_url" required:"false"`
	// The UUID's of the users which will have
	// access to this image. When omitted only the owner (the Triton user whose
	// credentials are used) will have access to the image.
	ImageACL []string `mapstructure:"image_acls" required:"false"`
	// Name/Value tags applied to the image.
	ImageTags map[string]string `mapstructure:"image_tags" required:"false"`
	// Same as [`image_tags`](#image_tags) but defined as a singular repeatable
	// block containing a `name` and a `value` field. In HCL2 mode the
	// [`dynamic_block`](/docs/templates/hcl_templates/expressions#dynamic-blocks)
	// will allow you to create those programatically.
	ImageTag config.NameValues `mapstructure:"image_tag" required:"false"`
}

// Prepare performs basic validation on a TargetImageConfig struct.
func (c *TargetImageConfig) Prepare(ctx *interpolate.Context) []error {
	var errs []error

	errs = append(errs, c.ImageTag.CopyOn(&c.ImageTags)...)

	if c.ImageName == "" {
		errs = append(errs, fmt.Errorf("An image_name must be specified"))
	}

	if c.ImageVersion == "" {
		errs = append(errs, fmt.Errorf("An image_version must be specified"))
	}

	if len(errs) > 0 {
		return errs
	}

	return nil
}