Merge pull request #17 from perimeter-81/master

Added template_name configuration parameter

Author: maxfrei

README.md

@@ -169,6 +169,7 @@ This section describes the available configuration options for the builder. Plea
 * `storage_size` (int) The storage size in gigabytes. Defaults to `25`. Changing this value is useful if you aim to build a template for larger server configurations where the preconfigured server disk is larger than 25 GB. The operating system disk can also be later extended if needed. Note that Windows templates require large storage size, than default 25 Gb.
 * `state_timeout_duration` (string) The amount of time to wait for resource state changes. Defaults to `5m`.
 * `template_prefix` (string) The prefix to use for the generated template title. Defaults to an empty string, meaning the prefix will be the storage title. You can use this option to easily differentiate between different templates.
+* `template_name` (string) Similarly to `template_prefix`, but this will allow you to set the full template name and not just the prefix. Defaults to an empty string, meaning the name will be the storage title. You can use this option to easily differentiate between different templates. It cannot be used in conjunction with the prefix setting.
 * `clone_zones` ([]string) The array of extra zones (locations) where created templates should be cloned. Note that default `state_timeout_duration` is not enough for cloning, better to increase a value depending on storage size.
 * `ssh_private_key_path` (string) Path to SSH Private Key that will be used for provisioning and stored in the template.
 * `ssh_public_key_path` (string) Path to SSH Public Key that will be used for provisioning.

builder/upcloud/builder.go

@@ -105,6 +105,7 @@ func (b *Builder) Run(ctx context.Context, ui packersdk.Ui, hook packersdk.Hook)
 		StateData: map[string]interface{}{
 			"generated_data":  state.Get("generated_data"),
 			"template_prefix": b.config.TemplatePrefix,
+			"template_name":   b.config.TemplateName,
 		},
 	}
 

builder/upcloud/config.go

@@ -50,6 +50,7 @@ type Config struct {
 
 	// Optional configuration values
 	TemplatePrefix string        `mapstructure:"template_prefix"`
+	TemplateName   string        `mapstructure:"template_name"`
 	StorageSize    int           `mapstructure:"storage_size"`
 	Timeout        time.Duration `mapstructure:"state_timeout_duration"`
 	CloneZones     []string      `mapstructure:"clone_zones"`
@@ -78,7 +79,7 @@ func (c *Config) Prepare(raws ...interface{}) ([]string, error) {
 	c.setEnv()
 
 	// defaults
-	if c.TemplatePrefix == "" {
+	if c.TemplatePrefix == "" && len(c.TemplateName) == 0{
 		c.TemplatePrefix = DefaultTemplatePrefix
 	}
 
@@ -152,6 +153,18 @@ func (c *Config) Prepare(raws ...interface{}) ([]string, error) {
 		)
 	}
 
+	if len(c.TemplateName) > 40 {
+		errs = packer.MultiErrorAppend(
+			errs, errors.New("'template_name' is limited to 40 characters"),
+		)
+	}
+
+	if len(c.TemplatePrefix) > 0 && len(c.TemplateName) > 0 {
+		errs = packer.MultiErrorAppend(
+			errs, errors.New("you can either use 'template_prefix' or 'template_name' in your configuration"),
+		)
+	}
+
 	if errs != nil && len(errs.Errors) > 0 {
 		return nil, errs
 	}

builder/upcloud/config.hcl2spec.go

@@ -71,6 +71,7 @@ type FlatConfig struct {
 	StorageUUID               *string           `mapstructure:"storage_uuid" cty:"storage_uuid"`
 	StorageName               *string           `mapstructure:"storage_name" cty:"storage_name"`
 	TemplatePrefix            *string           `mapstructure:"template_prefix" cty:"template_prefix"`
+	TemplateName              *string           `mapstructure:"template_name" cty:"template_name"`
 	StorageSize               *int              `mapstructure:"storage_size" cty:"storage_size"`
 	Timeout                   *string           `mapstructure:"state_timeout_duration" cty:"state_timeout_duration"`
 	CloneZones                []string          `mapstructure:"clone_zones" cty:"clone_zones"`
@@ -153,6 +154,7 @@ func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec {
 		"storage_uuid":                 &hcldec.AttrSpec{Name: "storage_uuid", Type: cty.String, Required: false},
 		"storage_name":                 &hcldec.AttrSpec{Name: "storage_name", Type: cty.String, Required: false},
 		"template_prefix":              &hcldec.AttrSpec{Name: "template_prefix", Type: cty.String, Required: false},
+		"template_name":                &hcldec.AttrSpec{Name: "template_name", Type: cty.String, Required: false},
 		"storage_size":                 &hcldec.AttrSpec{Name: "storage_size", Type: cty.Number, Required: false},
 		"state_timeout_duration":       &hcldec.AttrSpec{Name: "state_timeout_duration", Type: cty.String, Required: false},
 		"clone_zones":                  &hcldec.AttrSpec{Name: "clone_zones", Type: cty.List(cty.String), Required: false},

builder/upcloud/step_create_template.go

@@ -50,13 +50,21 @@ func (s *StepCreateTemplate) Run(_ context.Context, state multistep.StateBag) mu
 	// creating template
 	templates := []*upcloud.Storage{}
 
+	// we either use template name or prefix.
+	var templateTitle string
+	if len(s.Config.TemplatePrefix) > 0 {
+		templateTitle = fmt.Sprintf("%s-%s", s.Config.TemplatePrefix, internal.GetNowString())
+	} else {
+		templateTitle = s.Config.TemplateName
+	}
+
 	for _, uuid := range storageUuids {
 		ui.Say(fmt.Sprintf("Creating template for storage %q...", uuid))
-
-		t, err := driver.CreateTemplate(uuid, s.Config.TemplatePrefix)
+		t, err := driver.CreateTemplate(uuid, templateTitle)
 		if err != nil {
 			return internal.StepHaltWithError(state, err)
 		}
+
 		templates = append(templates, t)
 		ui.Say(fmt.Sprintf("Template for storage %q created...", uuid))
 	}

internal/driver.go

@@ -113,9 +113,8 @@ func (d *driver) StopServer(serverUuid string) error {
 	return nil
 }
 
-func (d *driver) CreateTemplate(serverStorageUuid, prefix string) (*upcloud.Storage, error) {
+func (d *driver) CreateTemplate(serverStorageUuid, templateTitle string) (*upcloud.Storage, error) {
 	// create image
-	templateTitle := fmt.Sprintf("%s-%s", prefix, GetNowString())
 	response, err := d.svc.TemplatizeStorage(&request.TemplatizeStorageRequest{
 		UUID:  serverStorageUuid,
 		Title: templateTitle,