Skip to content

Commit 2205e2c

Browse files
committed
docs: config/vmtype: add flowchart to choose the best vmType
Signed-off-by: Akihiro Suda <[email protected]>
1 parent 6046136 commit 2205e2c

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

website/content/en/docs/Config/VMType/_index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@ Lima supports two ways of running guest machines:
1010
The vmType can be specified only on creating the instance.
1111
The vmType of existing instances cannot be changed.
1212

13+
See the following flowchart to choose the best vmType for you:
14+
```mermaid
15+
flowchart
16+
host{"Host OS"} -- "Windows" --> wsl2["WSL2"]
17+
host -- "Linux" --> qemu["QEMU"]
18+
host -- "macOS" --> intel_on_arm{"Need to run <br> Intel binaries <br> on ARM?"}
19+
intel_on_arm -- "Yes" --> just_elf{"Just need to <br> run Intel userspace (fast), <br> or entire Intel VM (slow)?"}
20+
just_elf -- "Userspace (fast)" --> vz
21+
just_elf -- "VM (slow)" --> qemu
22+
intel_on_arm -- "No" --> vz["VZ"]
23+
```
24+
1325
## QEMU
1426
"qemu" option makes use of QEMU to run guest operating system.
1527
This option is used by default if "vmType" is not set.

website/hugo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,9 @@ enable = false
178178
icon = "fab fa-slack"
179179
desc = "Chat with other project users"
180180

181+
[params.mermaid]
182+
enable = true
183+
181184
[[menus.main]]
182185
name = "Github"
183186
url = "https://github.com/lima-vm/lima"

0 commit comments

Comments
 (0)