Allow extra parameters for additional disks

Default to a simple string with name, just like before.

Signed-off-by: Anders F Björklund <[email protected]>

Author: afbjorklund

cmd/limactl/disk.go

@@ -245,7 +245,7 @@ func diskDeleteAction(cmd *cobra.Command, args []string) error {
 			for _, inst := range instances {
 				if len(inst.AdditionalDisks) > 0 {
 					for _, d := range inst.AdditionalDisks {
-						if d == diskName {
+						if d.Name == diskName {
 							refInstances = append(refInstances, inst.Name)
 						}
 					}

cmd/limactl/stop.go

@@ -113,7 +113,8 @@ func stopInstanceForcibly(inst *store.Instance) {
 		logrus.Infof("The %s driver process seems already stopped", inst.VMType)
 	}
 
-	for _, diskName := range inst.AdditionalDisks {
+	for _, d := range inst.AdditionalDisks {
+		diskName := d.Name
 		disk, err := store.InspectDisk(diskName)
 		if err != nil {
 			logrus.Warnf("Disk %q does not exist", diskName)

examples/default.yaml

@@ -105,8 +105,10 @@ mountType: null
 # `/mnt/lima-${VOLUME}`.
 # 🟢 Builtin default: null
 additionalDisks:
-# disks should be a list of disk name strings, for example:
+# disks should either be a list of disk name strings, for example:
 # - "data"
+# or a list of disk objects with extra parameters, for example:
+# - name: "data"
 
 ssh:
   # A localhost port of the host. Forwarded to port 22 of the guest.

pkg/cidata/cidata.go

@@ -203,9 +203,9 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML, udpDNSLocalPort
 		args.MountType = "virtiofs"
 	}
 
-	for i, disk := range y.AdditionalDisks {
+	for i, d := range y.AdditionalDisks {
 		args.Disks = append(args.Disks, Disk{
-			Name:   disk,
+			Name:   d.Name,
 			Device: diskDeviceNameFromOrder(i),
 		})
 	}

pkg/hostagent/hostagent.go

@@ -436,7 +436,7 @@ sudo chown -R "${USER}" /run/host-services`
 		a.onClose = append(a.onClose, func() error {
 			var unlockMErr error
 			for _, d := range a.y.AdditionalDisks {
-				disk, inspectErr := store.InspectDisk(d)
+				disk, inspectErr := store.InspectDisk(d.Name)
 				if inspectErr != nil {
 					unlockMErr = multierror.Append(unlockMErr, inspectErr)
 					continue

pkg/limayaml/defaults_test.go

@@ -277,7 +277,7 @@ func TestFillDefault(t *testing.T) {
 		Memory: pointer.String("5GiB"),
 		Disk:   pointer.String("105GiB"),
 		AdditionalDisks: []Disk{
-			"data",
+			{Name: "data"},
 		},
 		GuestInstallPrefix: pointer.String("/opt"),
 		Containerd: Containerd{
@@ -413,7 +413,7 @@ func TestFillDefault(t *testing.T) {
 
 	y = filledDefaults
 	y.DNS = []net.IP{net.ParseIP("8.8.8.8")}
-	y.AdditionalDisks = []Disk{"overridden"}
+	y.AdditionalDisks = []Disk{{Name: "overridden"}}
 
 	expect = y
 
@@ -454,7 +454,7 @@ func TestFillDefault(t *testing.T) {
 		Memory: pointer.String("7GiB"),
 		Disk:   pointer.String("117GiB"),
 		AdditionalDisks: []Disk{
-			"test",
+			{Name: "test"},
 		},
 		GuestInstallPrefix: pointer.String("/usr"),
 		Containerd: Containerd{

pkg/limayaml/limayaml.go

@@ -79,7 +79,9 @@ type Image struct {
 	Initrd *File   `yaml:"initrd,omitempty" json:"initrd,omitempty"`
 }
 
-type Disk = string
+type Disk struct {
+	Name string `yaml:"name" json:"name"` // REQUIRED
+}
 
 type Mount struct {
 	Location   string   `yaml:"location" json:"location"` // REQUIRED

pkg/limayaml/load.go

@@ -13,16 +13,36 @@ import (
 	yamlv3 "gopkg.in/yaml.v3"
 )
 
+func unmarshalDisk(dst *Disk, b []byte) error {
+	var s string
+	if err := yaml.Unmarshal(b, &s); err == nil {
+		*dst = Disk{Name: s}
+		return nil
+	}
+	return yaml.Unmarshal(b, dst)
+}
+
+func (d *Disk) UnmarshalYAML(value *yamlv3.Node) error {
+	var v interface{}
+	if err := value.Decode(&v); err != nil {
+		return err
+	}
+	if s, ok := v.(string); ok {
+		*d = Disk{Name: s}
+	}
+	return nil
+}
+
 func unmarshalYAML(data []byte, v interface{}, comment string) error {
-	if err := yaml.UnmarshalWithOptions(data, v, yaml.DisallowDuplicateKey()); err != nil {
+	if err := yaml.UnmarshalWithOptions(data, v, yaml.DisallowDuplicateKey(), yaml.CustomUnmarshaler[Disk](unmarshalDisk)); err != nil {
 		return fmt.Errorf("failed to unmarshal YAML (%s): %w", comment, err)
 	}
 	// the go-yaml library doesn't catch all markup errors, unfortunately
 	// make sure to get a "second opinion", using the same library as "yq"
 	if err := yamlv3.Unmarshal(data, v); err != nil {
 		return fmt.Errorf("failed to unmarshal YAML (%s): %w", comment, err)
 	}
-	if err := yaml.UnmarshalWithOptions(data, v, yaml.Strict()); err != nil {
+	if err := yaml.UnmarshalWithOptions(data, v, yaml.Strict(), yaml.CustomUnmarshaler[Disk](unmarshalDisk)); err != nil {
 		logrus.WithField("comment", comment).WithError(err).Warn("Non-strict YAML is deprecated and will be unsupported in a future version of Lima")
 		// Non-strict YAML is known to be used by Rancher Desktop:
 		// https://github.com/rancher-sandbox/rancher-desktop/blob/c7ea7508a0191634adf16f4675f64c73198e8d37/src/backend/lima.ts#L114-L117

pkg/limayaml/load_test.go

@@ -30,3 +30,25 @@ provision:
 	_, err := Load([]byte(s), "error.yaml")
 	assert.ErrorContains(t, err, "failed to unmarshal YAML")
 }
+
+func TestLoadDiskString(t *testing.T) {
+	s := `
+additionalDisks:
+- name
+`
+	y, err := Load([]byte(s), "disk.yaml")
+	assert.NilError(t, err)
+	assert.Equal(t, len(y.AdditionalDisks), 1)
+	assert.Equal(t, y.AdditionalDisks[0].Name, "name")
+}
+
+func TestLoadDiskStruct(t *testing.T) {
+	s := `
+additionalDisks:
+- name: "name"
+`
+	y, err := Load([]byte(s), "disk.yaml")
+	assert.NilError(t, err)
+	assert.Assert(t, len(y.AdditionalDisks) == 1)
+	assert.Equal(t, y.AdditionalDisks[0].Name, "name")
+}

pkg/qemu/qemu.go

@@ -587,24 +587,25 @@ func Cmdline(cfg Config) (string, []string, error) {
 	diffDisk := filepath.Join(cfg.InstanceDir, filenames.DiffDisk)
 	extraDisks := []string{}
 	if len(y.AdditionalDisks) > 0 {
-		for _, diskName := range y.AdditionalDisks {
-			d, err := store.InspectDisk(diskName)
+		for _, d := range y.AdditionalDisks {
+			diskName := d.Name
+			disk, err := store.InspectDisk(diskName)
 			if err != nil {
 				logrus.Errorf("could not load disk %q: %q", diskName, err)
 				return "", nil, err
 			}
 
-			if d.Instance != "" {
-				logrus.Errorf("could not attach disk %q, in use by instance %q", diskName, d.Instance)
+			if disk.Instance != "" {
+				logrus.Errorf("could not attach disk %q, in use by instance %q", diskName, disk.Instance)
 				return "", nil, err
 			}
-			logrus.Infof("Mounting disk %q on %q", diskName, d.MountPoint)
-			err = d.Lock(cfg.InstanceDir)
+			logrus.Infof("Mounting disk %q on %q", diskName, disk.MountPoint)
+			err = disk.Lock(cfg.InstanceDir)
 			if err != nil {
 				logrus.Errorf("could not lock disk %q: %q", diskName, err)
 				return "", nil, err
 			}
-			dataDisk := filepath.Join(d.Dir, filenames.DataDisk)
+			dataDisk := filepath.Join(disk.Dir, filenames.DataDisk)
 			extraDisks = append(extraDisks, dataDisk)
 		}
 	}