Skip to content

Commit e7688d6

Browse files
committed
Add documentation and example for ext
Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
1 parent 1413cb9 commit e7688d6

File tree

4 files changed

+31
-0
lines changed

4 files changed

+31
-0
lines changed

pkg/limayaml/validate.go

+3
Original file line numberDiff line numberDiff line change
@@ -554,6 +554,9 @@ func warnExperimental(y *LimaYAML) {
554554
if *y.MountType == VIRTIOFS && runtime.GOOS == "linux" {
555555
logrus.Warn("`mountType: virtiofs` on Linux is experimental")
556556
}
557+
if *y.VMType == EXT {
558+
logrus.Warn("`vmType: ext` is experimental")
559+
}
557560
if *y.Arch == RISCV64 {
558561
logrus.Warn("`arch: riscv64` is experimental")
559562
}

templates/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ Distro:
3131
- [`experimental/gentoo`](./experimental/gentoo.yaml): [experimental] Gentoo
3232
- [`experimental/opensuse-tumbleweed`](./experimental/opensuse-tumbleweed.yaml): [experimental] openSUSE Tumbleweed
3333

34+
External:
35+
- [`experimental/ext`](./experimental/ext.yaml): [experimental] External Raspberry Pi Zero
36+
3437
Container engines:
3538
- [`apptainer`](./apptainer.yaml): Apptainer
3639
- [`apptainer-rootful`](./apptainer-rootful.yaml): Apptainer (rootful)

templates/experimental/ext.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
vmType: ext
2+
3+
arch: "aarch64"
4+
cpus: 4
5+
memory: 512MiB
6+
disk: 32GiB
7+
8+
mounts:
9+
- location: "~"
10+
- location: "/tmp/lima"
11+
writable: true
12+
13+
ssh:
14+
address: raspberrypi.local

website/content/en/docs/config/vmtype.md

+11
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Lima supports two ways of running guest machines:
77
- [qemu](#qemu)
88
- [vz](#vz)
99

10+
Lima also supports connecting to external machines:
11+
- [ext](#ext)
12+
1013
The vmType can be specified only on creating the instance.
1114
The vmType of existing instances cannot be changed.
1215

@@ -111,3 +114,11 @@ containerd:
111114
- When running lima using "wsl2", `${LIMA_HOME}/<INSTANCE>/serial.log` will not contain kernel boot logs
112115
- WSL2 requires a `tar` formatted rootfs archive instead of a VM image
113116
- 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.
117+
118+
## EXT
119+
> **Warning**
120+
> "ext" mode is experimental
121+
122+
"ext" option makes use of an external machine, either a virtual machine or a physical machine.
123+
124+
It is accessed using an address (for SSH), the keys are supposed to be set up for it already.

0 commit comments

Comments
 (0)