Rename external driver to static driver

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

Author: afbjorklund

pkg/driverutil/driverutil.go

@@ -15,6 +15,6 @@ func Drivers() []string {
 	if wsl2.Enabled {
 		drivers = append(drivers, limayaml.WSL2)
 	}
-	drivers = append(drivers, limayaml.EXT)
+	drivers = append(drivers, limayaml.STATIC)
 	return drivers
 }

pkg/driverutil/instance.go

@@ -2,9 +2,9 @@ package driverutil
 
 import (
 	"github.com/lima-vm/lima/pkg/driver"
-	"github.com/lima-vm/lima/pkg/ext"
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/qemu"
+	"github.com/lima-vm/lima/pkg/static"
 	"github.com/lima-vm/lima/pkg/vz"
 	"github.com/lima-vm/lima/pkg/wsl2"
 )
@@ -17,8 +17,8 @@ func CreateTargetDriverInstance(base *driver.BaseDriver) driver.Driver {
 	if *limaDriver == limayaml.WSL2 {
 		return wsl2.New(base)
 	}
-	if *limaDriver == limayaml.EXT {
-		return ext.New(base)
+	if *limaDriver == limayaml.STATIC {
+		return static.New(base)
 	}
 	return qemu.New(base)
 }

pkg/ext/ext_driver.go

@@ -138,7 +138,7 @@ func New(instName string, stdout io.Writer, signalCh chan os.Signal, opts ...Opt
 	if err := cidata.GenerateCloudConfig(inst.Dir, instName, inst.Config); err != nil {
 		return nil, err
 	}
-	if *inst.Config.VMType != limayaml.EXT {
+	if *inst.Config.VMType != limayaml.STATIC {
 		if err := cidata.GenerateISO9660(inst.Dir, instName, inst.Config, udpDNSLocalPort, tcpDNSLocalPort, o.nerdctlArchive, vSockPort, virtioPort); err != nil {
 			return nil, err
 		}
@@ -503,7 +503,7 @@ sudo chown -R "${USER}" /run/host-services`
 			return errors.Join(unlockErrs...)
 		})
 	}
-	if *a.instConfig.VMType == limayaml.EXT {
+	if *a.instConfig.VMType == limayaml.STATIC {
 		if err := a.runProvisionScripts(); err != nil {
 			return err
 		}

pkg/hostagent/hostagent.go

@@ -128,7 +128,7 @@ If any private key under ~/.ssh is protected with a passphrase, you need to have
 	if *a.instConfig.Plain {
 		return req
 	}
-	if *a.instConfig.VMType != limayaml.EXT {
+	if *a.instConfig.VMType != limayaml.STATIC {
 		req = append(req,
 			requirement{
 				description: "user session is ready for ssh",
@@ -227,7 +227,7 @@ Also see "/var/log/cloud-init-output.log" in the guest.
 
 func (a *HostAgent) finalRequirements() []requirement {
 	req := make([]requirement, 0)
-	if *a.instConfig.VMType != limayaml.EXT {
+	if *a.instConfig.VMType != limayaml.STATIC {
 		req = append(req,
 			requirement{
 				description: "boot scripts must have finished",

pkg/hostagent/requirements.go

@@ -98,7 +98,7 @@ func Prepare(ctx context.Context, inst *store.Instance) (*Prepared, error) {
 	if err := limaDriver.CreateDisk(ctx); err != nil {
 		return nil, err
 	}
-	if *inst.Config.VMType == limayaml.EXT {
+	if *inst.Config.VMType == limayaml.STATIC {
 		// Created externally
 		created = true
 	}

pkg/instance/start.go

@@ -1071,8 +1071,8 @@ func NewVMType(driver string) VMType {
 		return QEMU
 	case "wsl2":
 		return WSL2
-	case "ext":
-		return EXT
+	case "static":
+		return STATIC
 	default:
 		logrus.Warnf("Unknown driver: %s", driver)
 		return driver

pkg/limayaml/defaults.go

@@ -72,17 +72,17 @@ const (
 	VIRTIOFS MountType = "virtiofs"
 	WSLMount MountType = "wsl2"
 
-	QEMU VMType = "qemu"
-	VZ   VMType = "vz"
-	WSL2 VMType = "wsl2"
-	EXT  VMType = "ext"
+	QEMU   VMType = "qemu"
+	VZ     VMType = "vz"
+	WSL2   VMType = "wsl2"
+	STATIC VMType = "static"
 )
 
 var (
 	OSTypes    = []OS{LINUX}
 	ArchTypes  = []Arch{X8664, AARCH64, ARMV7L, RISCV64}
 	MountTypes = []MountType{REVSSHFS, NINEP, VIRTIOFS, WSLMount}
-	VMTypes    = []VMType{QEMU, VZ, WSL2, EXT}
+	VMTypes    = []VMType{QEMU, VZ, WSL2, STATIC}
 )
 
 type User struct {

pkg/limayaml/limayaml.go

@@ -84,13 +84,13 @@ func Validate(y *LimaYAML, warn bool) error {
 		if !IsNativeArch(*y.Arch) {
 			return fmt.Errorf("field `arch` must be %q for VZ; got %q", NewArch(runtime.GOARCH), *y.Arch)
 		}
-	case EXT:
+	case STATIC:
 		// NOP
 	default:
-		return fmt.Errorf("field `vmType` must be %q, %q, %q, %q; got %q", QEMU, VZ, WSL2, EXT, *y.VMType)
+		return fmt.Errorf("field `vmType` must be %q, %q, %q, %q; got %q", QEMU, VZ, WSL2, STATIC, *y.VMType)
 	}
 
-	if len(y.Images) == 0 && *y.VMType != EXT {
+	if len(y.Images) == 0 && *y.VMType != STATIC {
 		return errors.New("field `images` must be set")
 	}
 	for i, f := range y.Images {
@@ -176,8 +176,8 @@ func Validate(y *LimaYAML, warn bool) error {
 		}
 	}
 
-	if *y.SSH.Address == "127.0.0.1" && *y.VMType == EXT {
-		return errors.New("field `ssh.address` must be set, for ext")
+	if *y.SSH.Address == "127.0.0.1" && *y.VMType == STATIC {
+		return errors.New("field `ssh.address` must be set")
 	}
 	if y.SSH.Address != nil {
 		if err := validateHost("ssh.address", *y.SSH.Address); err != nil {
@@ -547,8 +547,8 @@ func warnExperimental(y *LimaYAML) {
 	if *y.MountType == VIRTIOFS && runtime.GOOS == "linux" {
 		logrus.Warn("`mountType: virtiofs` on Linux is experimental")
 	}
-	if *y.VMType == EXT {
-		logrus.Warn("`vmType: ext` is experimental")
+	if *y.VMType == STATIC {
+		logrus.Warn("`vmType: static` is experimental")
 	}
 	if *y.Arch == RISCV64 {
 		logrus.Warn("`arch: riscv64` is experimental")

pkg/limayaml/validate.go

@@ -0,0 +1,15 @@
+package static
+
+import (
+	"github.com/lima-vm/lima/pkg/driver"
+)
+
+type LimaStaticDriver struct {
+	*driver.BaseDriver
+}
+
+func New(driver *driver.BaseDriver) *LimaStaticDriver {
+	return &LimaStaticDriver{
+		BaseDriver: driver,
+	}
+}

pkg/static/static_driver.go

@@ -189,7 +189,7 @@ func inspectStatusWithPIDFiles(instDir string, inst *Instance, y *limayaml.LimaY
 		inst.Status = StatusBroken
 		inst.Errors = append(inst.Errors, err)
 	}
-	if *y.VMType == limayaml.EXT {
+	if *y.VMType == limayaml.STATIC {
 		if inst.HostAgentPID > 0 {
 			inst.Status = StatusRunning
 		} else if inst.HostAgentPID == 0 {

pkg/store/instance.go

@@ -31,8 +31,8 @@ Distro:
 - [`experimental/gentoo`](./experimental/gentoo.yaml): [experimental] Gentoo
 - [`experimental/opensuse-tumbleweed`](./experimental/opensuse-tumbleweed.yaml): [experimental] openSUSE Tumbleweed
 
-External:
-- [`experimental/ext`](./experimental/ext.yaml): [experimental] External Raspberry Pi Zero
+Static:
+- [`experimental/static`](./experimental/static.yaml): [experimental] Static Raspberry Pi Zero
 
 Container engines:
 - [`apptainer`](./apptainer.yaml): Apptainer

templates/README.md

@@ -1,4 +1,4 @@
-vmType: ext
+vmType: static
 
 arch: "aarch64"
 cpus: 4

templates/experimental/ext.yaml renamed to templates/experimental/static.yaml

@@ -7,8 +7,8 @@ Lima supports two ways of running guest machines:
 - [qemu](#qemu)
 - [vz](#vz)
 
-Lima also supports connecting to external machines:
-- [ext](#ext)
+Lima also supports connecting to static machines:
+- [static](#static)
 
 The vmType can be specified only on creating the instance.
 The vmType of existing instances cannot be changed.
@@ -115,10 +115,10 @@ containerd:
 - WSL2 requires a `tar` formatted rootfs archive instead of a VM image
 - Windows doesn't ship with ssh.exe, gzip.exe, etc. which are used by Lima at various points. The easiest way around this is to run `winget install -e --id Git.MinGit` (winget is now built in to Windows as well), and add the resulting `C:\Program Files\Git\usr\bin\` directory to your path.
 
-## EXT
+## STATIC
 > **Warning**
-> "ext" mode is experimental
+> "static" mode is experimental
 
-"ext" option makes use of an external machine, either a virtual machine or a physical machine.
+"static" option makes use of an external machine, either a virtual machine or a physical machine.
 
 It is accessed using an address (for SSH), the keys are supposed to be set up for it already.