(vsphere-iso) add ability to define multiple disks

Closes #8749

builder/vsphere/driver/vm.go

@@ -52,10 +52,7 @@ type NIC struct {
 }
 
 type CreateConfig struct {
-	DiskThinProvisioned bool
-	DiskEagerlyScrub    bool
 	DiskControllerType string // example: "scsi", "pvscsi"
-	DiskSize            int64
 
 	Annotation    string
 	Name          string
@@ -69,6 +66,13 @@ type CreateConfig struct {
 	USBController bool
 	Version       uint   // example: 10
 	Firmware      string // efi or bios
+	Storage       []Disk
+}
+
+type Disk struct {
+	DiskSize            int64
+	DiskEagerlyScrub    bool
+	DiskThinProvisioned bool
 }
 
 func (d *Driver) NewVM(ref *types.ManagedObjectReference) *VirtualMachine {
@@ -488,6 +492,10 @@ func (vm *VirtualMachine) GetDir() (string, error) {
 }
 
 func addDisk(_ *Driver, devices object.VirtualDeviceList, config *CreateConfig) (object.VirtualDeviceList, error) {
+	if len(config.Storage) == 0 {
+		return nil, errors.New("no storage devices have been defined")
+	}
+
 	device, err := devices.CreateSCSIController(config.DiskControllerType)
 	if err != nil {
 		return nil, err
@@ -498,20 +506,22 @@ func addDisk(_ *Driver, devices object.VirtualDeviceList, config *CreateConfig)
 		return nil, err
 	}
 
+	for _, dc := range config.Storage {
 		disk := &types.VirtualDisk{
 			VirtualDevice: types.VirtualDevice{
 				Key: devices.NewKey(),
 				Backing: &types.VirtualDiskFlatVer2BackingInfo{
 					DiskMode:        string(types.VirtualDiskModePersistent),
-				ThinProvisioned: types.NewBool(config.DiskThinProvisioned),
+					ThinProvisioned: types.NewBool(dc.DiskThinProvisioned),
-				EagerlyScrub:    types.NewBool(config.DiskEagerlyScrub),
+					EagerlyScrub:    types.NewBool(dc.DiskEagerlyScrub),
 				},
 			},
-		CapacityInKB: config.DiskSize * 1024,
+			CapacityInKB: dc.DiskSize * 1024,
 		}
 
 		devices.AssignController(disk, controller)
 		devices = append(devices, disk)
+	}
 
 	return devices, nil
 }

builder/vsphere/iso/config.hcl2spec.go

@@ -31,6 +31,7 @@ type FlatConfig struct {
 	DiskSize                  *int64            `mapstructure:"disk_size" cty:"disk_size"`
 	DiskThinProvisioned       *bool             `mapstructure:"disk_thin_provisioned" cty:"disk_thin_provisioned"`
 	DiskEagerlyScrub          *bool             `mapstructure:"disk_eagerly_scrub" cty:"disk_eagerly_scrub"`
+	Storage                   []FlatDiskConfig  `mapstructure:"storage" cty:"storage"`
 	Network                   *string           `mapstructure:"network" cty:"network"`
 	NetworkCard               *string           `mapstructure:"network_card" cty:"network_card"`
 	NICs                      []FlatNIC         `mapstructure:"network_adapters" cty:"network_adapters"`
@@ -153,6 +154,7 @@ func (*FlatConfig) HCL2Spec() map[string]hcldec.Spec {
 		"disk_size":                    &hcldec.AttrSpec{Name: "disk_size", Type: cty.Number, Required: false},
 		"disk_thin_provisioned":        &hcldec.AttrSpec{Name: "disk_thin_provisioned", Type: cty.Bool, Required: false},
 		"disk_eagerly_scrub":           &hcldec.AttrSpec{Name: "disk_eagerly_scrub", Type: cty.Bool, Required: false},
+		"storage":                      &hcldec.BlockListSpec{TypeName: "storage", Nested: hcldec.ObjectSpec((*FlatDiskConfig)(nil).HCL2Spec())},
 		"network":                      &hcldec.AttrSpec{Name: "network", Type: cty.String, Required: false},
 		"network_card":                 &hcldec.AttrSpec{Name: "network_card", Type: cty.String, Required: false},
 		"network_adapters":             &hcldec.BlockListSpec{TypeName: "network_adapters", Nested: hcldec.ObjectSpec((*FlatNIC)(nil).HCL2Spec())},

builder/vsphere/iso/step_create.go

@@ -1,5 +1,5 @@
 //go:generate struct-markdown
-//go:generate mapstructure-to-hcl2 -type NIC,CreateConfig
+//go:generate mapstructure-to-hcl2 -type NIC,CreateConfig,DiskConfig
 
 package iso
 
@@ -24,6 +24,15 @@ type NIC struct {
 	Passthrough *bool `mapstructure:"passthrough"`
 }
 
+type DiskConfig struct {
+	// Set the size of the disk
+	DiskSize int64 `mapstructure:"disk_size" required:"true"`
+	// Enable VMDK thin provisioning for VM. Defaults to `false`.
+	DiskThinProvisioned bool `mapstructure:"disk_thin_provisioned"`
+	// Enable VMDK eager scrubbing for VM. Defaults to `false`.
+	DiskEagerlyScrub bool `mapstructure:"disk_eagerly_scrub"`
+}
+
 type CreateConfig struct {
 	// Set VM hardware version. Defaults to the most current VM hardware
 	// version supported by vCenter. See
@@ -44,6 +53,8 @@ type CreateConfig struct {
 	DiskThinProvisioned bool `mapstructure:"disk_thin_provisioned"`
 	// Enable VMDK eager scrubbing for VM. Defaults to `false`.
 	DiskEagerlyScrub bool `mapstructure:"disk_eagerly_scrub"`
+	// Storage
+	Storage []DiskConfig `mapstructure:"storage"`
 	// Set network VM will be connected to.
 	Network string `mapstructure:"network"`
 	// Set VM network card type. Example `vmxnet3`.
@@ -115,11 +126,27 @@ func (s *StepCreateVM) Run(_ context.Context, state multistep.StateBag) multiste
 		})
 	}
 
-	vm, err = d.CreateVM(&driver.CreateConfig{
+	// add disk as the first drive for backwards compatibility if the type is defined
-		DiskThinProvisioned: s.Config.DiskThinProvisioned,
+	var disks []driver.Disk
-		DiskEagerlyScrub:    s.Config.DiskEagerlyScrub,
+	if s.Config.DiskSize != 0 {
-		DiskControllerType:  s.Config.DiskControllerType,
+		disks = append(disks, driver.Disk{
 			DiskSize:            s.Config.DiskSize,
+			DiskEagerlyScrub:    s.Config.DiskEagerlyScrub,
+			DiskThinProvisioned: s.Config.DiskThinProvisioned,
+		})
+	}
+	for _, disk := range s.Config.Storage {
+		disks = append(disks, driver.Disk{
+			DiskSize:            disk.DiskSize,
+			DiskEagerlyScrub:    disk.DiskEagerlyScrub,
+			DiskThinProvisioned: disk.DiskThinProvisioned,
+		})
+	}
+
+	vm, err = d.CreateVM(&driver.CreateConfig{
+		DiskControllerType: s.Config.DiskControllerType,
+		Storage:            disks,
+		Annotation:         s.Config.Notes,
 		Name:               s.Location.VMName,
 		Folder:             s.Location.Folder,
 		Cluster:            s.Location.Cluster,
@@ -131,7 +158,6 @@ func (s *StepCreateVM) Run(_ context.Context, state multistep.StateBag) multiste
 		USBController:      s.Config.USBController,
 		Version:            s.Config.Version,
 		Firmware:           s.Config.Firmware,
-		Annotation:          s.Config.Notes,
 	})
 	if err != nil {
 		state.Put("error", fmt.Errorf("error creating vm: %v", err))

builder/vsphere/iso/step_create.hcl2spec.go

@@ -1,4 +1,4 @@
-// Code generated by "mapstructure-to-hcl2 -type NIC,CreateConfig"; DO NOT EDIT.
+// Code generated by "mapstructure-to-hcl2 -type NIC,CreateConfig,DiskConfig"; DO NOT EDIT.
 package iso
 
 import (
@@ -16,6 +16,7 @@ type FlatCreateConfig struct {
 	DiskSize            *int64           `mapstructure:"disk_size" cty:"disk_size"`
 	DiskThinProvisioned *bool            `mapstructure:"disk_thin_provisioned" cty:"disk_thin_provisioned"`
 	DiskEagerlyScrub    *bool            `mapstructure:"disk_eagerly_scrub" cty:"disk_eagerly_scrub"`
+	Storage             []FlatDiskConfig `mapstructure:"storage" cty:"storage"`
 	Network             *string          `mapstructure:"network" cty:"network"`
 	NetworkCard         *string          `mapstructure:"network_card" cty:"network_card"`
 	NICs                []FlatNIC        `mapstructure:"network_adapters" cty:"network_adapters"`
@@ -42,6 +43,7 @@ func (*FlatCreateConfig) HCL2Spec() map[string]hcldec.Spec {
 		"disk_size":             &hcldec.AttrSpec{Name: "disk_size", Type: cty.Number, Required: false},
 		"disk_thin_provisioned": &hcldec.AttrSpec{Name: "disk_thin_provisioned", Type: cty.Bool, Required: false},
 		"disk_eagerly_scrub":    &hcldec.AttrSpec{Name: "disk_eagerly_scrub", Type: cty.Bool, Required: false},
+		"storage":               &hcldec.BlockListSpec{TypeName: "storage", Nested: hcldec.ObjectSpec((*FlatDiskConfig)(nil).HCL2Spec())},
 		"network":               &hcldec.AttrSpec{Name: "network", Type: cty.String, Required: false},
 		"network_card":          &hcldec.AttrSpec{Name: "network_card", Type: cty.String, Required: false},
 		"network_adapters":      &hcldec.BlockListSpec{TypeName: "network_adapters", Nested: hcldec.ObjectSpec((*FlatNIC)(nil).HCL2Spec())},
@@ -51,6 +53,33 @@ func (*FlatCreateConfig) HCL2Spec() map[string]hcldec.Spec {
 	return s
 }
 
+// FlatDiskConfig is an auto-generated flat version of DiskConfig.
+// Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.
+type FlatDiskConfig struct {
+	DiskSize            *int64 `mapstructure:"disk_size" required:"true" cty:"disk_size"`
+	DiskThinProvisioned *bool  `mapstructure:"disk_thin_provisioned" cty:"disk_thin_provisioned"`
+	DiskEagerlyScrub    *bool  `mapstructure:"disk_eagerly_scrub" cty:"disk_eagerly_scrub"`
+}
+
+// FlatMapstructure returns a new FlatDiskConfig.
+// FlatDiskConfig is an auto-generated flat version of DiskConfig.
+// Where the contents a fields with a `mapstructure:,squash` tag are bubbled up.
+func (*DiskConfig) FlatMapstructure() interface{ HCL2Spec() map[string]hcldec.Spec } {
+	return new(FlatDiskConfig)
+}
+
+// HCL2Spec returns the hcl spec of a DiskConfig.
+// This spec is used by HCL to read the fields of DiskConfig.
+// The decoded values from this spec will then be applied to a FlatDiskConfig.
+func (*FlatDiskConfig) HCL2Spec() map[string]hcldec.Spec {
+	s := map[string]hcldec.Spec{
+		"disk_size":             &hcldec.AttrSpec{Name: "disk_size", Type: cty.Number, Required: false},
+		"disk_thin_provisioned": &hcldec.AttrSpec{Name: "disk_thin_provisioned", Type: cty.Bool, Required: false},
+		"disk_eagerly_scrub":    &hcldec.AttrSpec{Name: "disk_eagerly_scrub", Type: cty.Bool, Required: false},
+	}
+	return s
+}
+
 // FlatNIC is an auto-generated flat version of NIC.
 // Where the contents of a field with a `mapstructure:,squash` tag are bubbled up.
 type FlatNIC struct {

website/source/docs/builders/vsphere-iso.html.md.erb

@@ -70,6 +70,12 @@ necessary for this build to succeed and can be found further down the page.
 ### Network Adapter Configuration
 <%= partial "partials/builder/vsphere/iso/NIC-required" %>
 
+### Storage Configuration
+<%= partial "partials/builder/vsphere/iso/DiskConfig-required" %>
+
+### Optional Storage Configuration
+<%= partial "partials/builder/vsphere/iso/DiskConfig-not-required" %>
+
 ### Floppy Configuration
 <%= partial "partials/builder/vsphere/iso/FloppyConfig-not-required" %>
 

website/source/partials/builder/vsphere/iso/_CreateConfig-not-required.html.md

@@ -19,6 +19,8 @@
     
 -   `disk_eagerly_scrub` (bool) - Enable VMDK eager scrubbing for VM. Defaults to `false`.
     
+-   `storage` ([]DiskConfig) - Storage
+    
 -   `network` (string) - Set network VM will be connected to.
     
 -   `network_card` (string) - Set VM network card type. Example `vmxnet3`.

website/source/partials/builder/vsphere/iso/_DiskConfig-not-required.html.md

@@ -0,0 +1,6 @@
+<!-- Code generated from the comments of the DiskConfig struct in builder/vsphere/iso/step_create.go; DO NOT EDIT MANUALLY -->
+
+-   `disk_thin_provisioned` (bool) - Enable VMDK thin provisioning for VM. Defaults to `false`.
+    
+-   `disk_eagerly_scrub` (bool) - Enable VMDK eager scrubbing for VM. Defaults to `false`.
+    

website/source/partials/builder/vsphere/iso/_DiskConfig-required.html.md

@@ -0,0 +1,4 @@
+<!-- Code generated from the comments of the DiskConfig struct in builder/vsphere/iso/step_create.go; DO NOT EDIT MANUALLY -->
+
+-   `disk_size` (int64) - Set the size of the disk
+