refactor: decouple driver-specific settings for internal drivers #3901

unsuman · 2025-08-24T20:14:55Z

Note

This is the second PR out of the three PRs, which depends on #3900. Merging all will close #3769.

Key Changes

Validation and filling of driver-specific values are now done through AcceptConfig() and FillConfig(), respectively, for all three drivers. These actions are performed before configuring the driver(driverutil/vm.go).
The driver resolution has been updated. If a user doesn’t specify the driver type explicitly, Lima will choose the default type based on the operating system(OSX: [VZ], Linux: [QEMU], Windows: [WSL2]). Lima will no longer guess the vm-type based on the config and will throw an error if a setting is incompatible or the driver is not available. Users must specify the vm-type to use other VMs.
Inspecting the status of an instance(driver.InspectStatus()) and providing boot scripts(driver.BootScripts()) are all done at the driver level. InspectStatus() has been implemented by all the drivers(~wsl2. Others return "" because their status is figured out through PID files). VM-specific boot scripts(vz and wsl2), only wsl2 is left to be decoupled(already done in refactor: move driver specific code to drivers #3770, but having some problems connecting to hostagent through ssh).
Deleted Register() and Unregister() from the driver interface. Renamed Initialize() to Create() and added its counterpart Delete(). Also added two driver features DynamicSSHAddress and SkipSocketForwarding, these were added only for WSL2(not in this PR but soon if that error gets fixed) and future drivers.

AkihiroSuda · 2025-08-25T16:00:24Z

Still draft?

unsuman · 2025-08-25T16:15:47Z

Still draft?

I'll open it shortly, testing some more things.

… drivers Signed-off-by: Ansuman Sahoo <[email protected]> experiment with wsl2 in ha Signed-off-by: Ansuman Sahoo <[email protected]> boot scripts for wsl2 Signed-off-by: Ansuman Sahoo <[email protected]>

AkihiroSuda · 2025-08-25T17:48:47Z

cmd/limactl/editflags/editflags.go

 		return []string{"10", "30", "50", "100", "200"}, cobra.ShellCompDirectiveNoFileComp
 	})
+
+	flags.String("vm-type", "", commentPrefix+"Virtual machine type")


--vm-type is not guaranteed to work as an edit flag.

e.g., this will probably not work

limactl create --vm-type qemu limactl edit --vm-type vz

Probably we need a warning when --vm-type is specified as an edit flag for an existing instance, but it can be worked out later.

AkihiroSuda · 2025-08-25T17:49:45Z

pkg/driver/driver.go

-	VirtioPort  string `json:"virtioPort"`
-	InstanceDir string `json:"instanceDir,omitempty"`
+	DriverName  string         `json:"driverName"`
+	CanRunGUI   bool           `json:"canRunGui,omitempty"`


Shouldn't this be in a "DriverFeatures" ?

Can be fixed later

AkihiroSuda

Thanks

norio-nomura · 2025-08-26T03:13:16Z

Is copying pkg/driver/vz/boot/05-rosetta-volume.sh intended instead of moving it?

norio-nomura · 2025-08-27T06:34:04Z

pkg/cidata/cidata.go

+		args.RosettaEnabled = *instConfig.VMOpts.VZ.Rosetta.Enabled
+	}
+	if instConfig.VMOpts.VZ.Rosetta.BinFmt != nil {
+		args.RosettaEnabled = *instConfig.VMOpts.VZ.Rosetta.BinFmt


- args.RosettaEnabled = *instConfig.VMOpts.VZ.Rosetta.BinFmt + args.RosettaBinFmt = *instConfig.VMOpts.VZ.Rosetta.BinFmt

opened #3921

lima-vm#3901 (comment) Signed-off-by: Norio Nomura <[email protected]>

AkihiroSuda · 2025-08-27T09:05:48Z

Lima will no longer guess the vm-type based on the config and will throw an error if a setting is incompatible or the driver is not available. Users must specify the vm-type to use other VMs.

Linking the discussion: https://cloud-native.slack.com/archives/C08KKELMQ92/p1754425219854189?thread_ts=1754414764.412809&cid=C08KKELMQ92 (Aug 6)

AkihiroSuda · 2025-08-27T09:14:15Z

pkg/driver/qemu/qemu_driver.go

+				return nil
+			}
+		}
+	}


These remnant of ResolveVMType could be removed.

I'll open a PR.

PR

driver: remove AcceptConfig #3923

Thanks a lot🙇‍♂️

afbjorklund · 2025-09-06T16:26:32Z

This PR broke the SSHStatus, reverting to the previous setup when always returning localhost for all instances.

Add fallback for busybox hostname with wsl2 #3842

i.e. not a pure refactoring

unsuman force-pushed the refactor/internal-drivers branch 4 times, most recently from c3a8755 to e887f1c Compare August 24, 2025 22:34

AkihiroSuda added gsoc/2025 Google Summer of Code 2025 area/vmdrivers VM driver infrastructure labels Aug 24, 2025

AkihiroSuda added this to the v2.0.0 milestone Aug 24, 2025

unsuman force-pushed the refactor/internal-drivers branch 3 times, most recently from 258c9b2 to 5fc24e4 Compare August 25, 2025 13:37

AkihiroSuda added the impact/changelog label Aug 25, 2025

unsuman force-pushed the refactor/internal-drivers branch 2 times, most recently from c2e8e60 to aa26f46 Compare August 25, 2025 15:20

AkihiroSuda requested a review from a team August 25, 2025 16:44

unsuman force-pushed the refactor/internal-drivers branch from aa26f46 to 0a74ee7 Compare August 25, 2025 16:53

decouple vm-type specific default filling and validation for internal…

2076ff1

… drivers Signed-off-by: Ansuman Sahoo <[email protected]> experiment with wsl2 in ha Signed-off-by: Ansuman Sahoo <[email protected]> boot scripts for wsl2 Signed-off-by: Ansuman Sahoo <[email protected]>

unsuman force-pushed the refactor/internal-drivers branch from 0a74ee7 to 2076ff1 Compare August 25, 2025 17:08

unsuman marked this pull request as ready for review August 25, 2025 17:29

AkihiroSuda reviewed Aug 25, 2025

View reviewed changes

AkihiroSuda approved these changes Aug 25, 2025

View reviewed changes

This was referenced Aug 25, 2025

refactor: support external drivers for the recent changes #3910

Merged

editflags: --vm-type is not guaranteed to work as an edit flag. #3911

Open

AkihiroSuda merged commit 6aceec3 into lima-vm:master Aug 25, 2025
62 of 63 checks passed

norio-nomura reviewed Aug 27, 2025

View reviewed changes

norio-nomura added a commit to norio-nomura/lima that referenced this pull request Aug 27, 2025

cidata.go: Fix RosettaBinFmt did not pass to lima.env

ff3b714

lima-vm#3901 (comment) Signed-off-by: Norio Nomura <[email protected]>

norio-nomura mentioned this pull request Aug 27, 2025

cidata.go: Fix RosettaBinFmt did not pass to lima.env #3921

Merged

AkihiroSuda reviewed Aug 27, 2025

View reviewed changes

This was referenced Aug 27, 2025

driver: remove AcceptConfig #3923

Merged

vzNAT: fix regression #3942

Merged

unsuman mentioned this pull request Sep 23, 2025

Use driver feature instead of checking the name #4076

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refactor: decouple driver-specific settings for internal drivers #3901

refactor: decouple driver-specific settings for internal drivers #3901

Uh oh!

unsuman commented Aug 24, 2025

Uh oh!

AkihiroSuda commented Aug 25, 2025

Uh oh!

unsuman commented Aug 25, 2025

Uh oh!

AkihiroSuda Aug 25, 2025

Uh oh!

AkihiroSuda Aug 25, 2025

Uh oh!

AkihiroSuda left a comment

Uh oh!

Uh oh!

norio-nomura commented Aug 26, 2025

Uh oh!

norio-nomura Aug 27, 2025

Uh oh!

norio-nomura Aug 27, 2025

Uh oh!

unsuman Aug 27, 2025

Uh oh!

AkihiroSuda commented Aug 27, 2025

Uh oh!

AkihiroSuda Aug 27, 2025

Uh oh!

AkihiroSuda Aug 27, 2025

Uh oh!

unsuman Aug 27, 2025

Uh oh!

afbjorklund commented Sep 6, 2025

Uh oh!

Uh oh!

refactor: decouple driver-specific settings for internal drivers #3901

refactor: decouple driver-specific settings for internal drivers #3901

Uh oh!

Conversation

unsuman commented Aug 24, 2025

Key Changes

Uh oh!

AkihiroSuda commented Aug 25, 2025

Uh oh!

unsuman commented Aug 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AkihiroSuda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

norio-nomura commented Aug 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AkihiroSuda commented Aug 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

afbjorklund commented Sep 6, 2025

Uh oh!

Uh oh!