Skip to content

Commit f5b80cb

Browse files
AkihiroSudaAkihiroSuda
authored
Merge pull request #4297 from AkihiroSuda/docs
docs
2 parents 483a694 + d98a351 commit f5b80cb

File tree

9 files changed

+70
-8
lines changed

9 files changed

+70
-8
lines changed

‎website/content/en/docs/config/ai/inside/_index.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@ weight: 10
66
Lima is useful for running AI agents (e.g., Claude Code, Codex, Gemini)
77
inside a VM, so as to prevent agents from directly reading, writing, or executing the host files.
88

9-
See [Examples » AI](../../../examples/ai.md).
9+
See also:
10+
- [Examples » AI](../../../examples/ai.md).
11+
- [Config » GPU](../../gpu.md)

‎website/content/en/docs/config/gpu.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: GPU acceleration
3+
weight: 90
4+
---
5+
6+
Lima VM supports GPU acceleration for the following VM types:
7+
- [krunkit](./vmtype/krunkit.md).
8+
9+
{{% alert title="Note" color=success %}}
10+
"Lima" in this web site refers to [the Lima VM project](https://lima-vm.io).
11+
12+
The Lima VM project is unrelated to [the Lima driver project (driver for ARM Mali GPUs)](https://gitlab.freedesktop.org/lima),
13+
which appears as "Lima" in the documentations of [Mesa 3D](https://docs.mesa3d.org/drivers/lima.html), etc.
14+
{{% /alert %}}

‎website/content/en/docs/config/plugin/cli.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
2-
title: CLI plugins (Experimental)
2+
title: CLI plugins
33
weight: 2
44
---
55

6+
> **Warning**
7+
> Support for CLI plugins is experimental
8+
69
| ⚡ Requirement | Lima >= 2.0 |
710
|----------------|-------------|
811

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ title: Krunkit
33
weight: 4
44
---
55

6-
> Warning
6+
> **Warning**
77
> "krunkit" is experimental
88
9-
| ⚡ Requirement | Lima >= 2.0, macOS >= 13 (Ventura+), Apple Silicon (arm64) |
9+
| ⚡ Requirement | Lima >= 2.0, macOS >= 14 (Sonoma+), Apple Silicon (arm64) |
1010
| ------------- | ----------------------------------------------------------- |
1111

1212
Krunkit runs super‑light VMs on macOS/ARM64 with a focus on GPU access. It builds on [libkrun](https://github.com/containers/libkrun), a library that embeds a VMM so apps can launch processes in a hardware‑isolated VM (HVF on macOS, KVM on Linux). The standout feature is GPU support in the guest via Mesa’s Venus Vulkan driver ([venus](https://docs.mesa3d.org/drivers/venus.html)), enabling Vulkan workloads inside the VM. See the project: [containers/krunkit](https://github.com/containers/krunkit).

‎website/content/en/docs/examples/ai.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,4 @@ See also <https://github.com/github/copilot-cli>.
119119
## See also
120120

121121
- [Config » AI](../config/ai/)
122+
- [Config » GPU](../config/gpu.md)

‎website/content/en/docs/releases/_index.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,13 @@ weight: 300
44
---
55

66
See <https://github.com/lima-vm/lima/releases> for the latest release.
7+
8+
## Lifecycle
9+
10+
| Release | Begin | End |
11+
|---------|------------|----------------------------------|
12+
| v2.x | 2025-11-06 | Undecided (v3 Begin + 3 months) |
13+
| v1.x | 2024-11-06 | 2026-02-06 (v2 Begin + 3 months) |
14+
| v0.x | 2021-05-14 | 2024-11-06 (v1 Begin + 0 days) |
15+
16+
Since Lima v1.x, each major release receives security updates and critical bug fixes until three months after the next major release.

‎website/content/en/docs/releases/breaking.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Breaking changes
3+
weight: 20
4+
---
5+
6+
## [v2.0.0](https://github.com/lima-vm/lima/releases/tag/v2.0.0)
7+
- `/tmp/lima` is no longer mounted by default.
8+
- SSH port is no longer hard-coded to 60022 for the "default" instance.
9+
- Port forwarding with `sudo nerdctl run -p` no longer works with nerdctl prior to v2.1.6.
10+
- The default of `guestIPMustBeZero` was changed from `false` to `true` when `guestIP` is `0.0.0.0`.
11+
12+
## [v1.1.0](https://github.com/lima-vm/lima/releases/tag/v1.1.0)
13+
- The `lima-additional-guestagent` package was split from the main `lima` package.
14+
15+
## [v1.0.0](https://github.com/lima-vm/lima/releases/tag/v1.0.0)
16+
- The default [VM type](../config/vmtype/_index.md) was changed from `qemu` to `vz` on macOS hosts with the support for `vz`.
17+
- The default [mount type](../config/mount.md) was changed from `reverse-sshfs` to `virtiofs` for `vz`, `9p` for `qemu`.
18+
- `socket_vmnet` binary has to be strictly owned by root.
19+
- The default value of `ssh.loadDotSSHPubKeys` was changed from `true` to `false`.
20+
- Several templates were removed or renamed.
21+
22+
## [v0.22.0](https://github.com/lima-vm/lima/releases/tag/v0.22.0)
23+
- Support for `vde_vmnet` was dropped in favor of `socket_vmnet`.
24+
25+
## [v0.3.0](https://github.com/lima-vm/lima/releases/tag/v0.3.0)
26+
- `limactl start` no longer starts a VM in the foreground.
27+
28+
See also <https://github.com/lima-vm/lima/releases>.

‎website/content/en/docs/releases/deprecated.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ weight: 10
55

66
The following features are deprecated:
77

8-
- CentOS 7 support
9-
- Loading non-strict YAMLs (i.e., YAMLs with unknown properties)
10-
- `limactl show-ssh` command (Use `ssh -F ~/.lima/default/ssh.config lima-default` instead)
11-
- Ansible provisioning mode (Use `ansible-playbook playbook.yaml` after the start instead)
8+
- `limactl show-ssh` command: deprecated in v0.18.0 (Use `ssh -F ~/.lima/default/ssh.config lima-default` instead)
9+
- Ansible provisioning mode: deprecated in Lima v1.1.0 (Use `ansible-playbook playbook.yaml` after the start instead)
10+
- `limactl --yes` flag: deprecated in Lima v2.0.0 (Use `limactl (clone|rename|edit|shell) --start` instead)
1211

1312
## Removed features
1413
- YAML property `network`: deprecated in [Lima v0.7.0](https://github.com/lima-vm/lima/commit/07e68230e70b21108d2db3ca5e0efd0e43842fbd)
@@ -17,3 +16,7 @@ The following features are deprecated:
1716
and removed in Lima v0.14.0,in favor of `hostResolver.enabled`
1817
- VDE support, including VNL and `vde_vmnet`: deprecated in [Lima v0.12.0](https://github.com/lima-vm/lima/pull/851/commits/b5e0d5abd0fb2f74b7ddf8faea7a855b5a14ceda)
1918
and removed in Lima v0.22.0, in favor of `socket_vmnet`
19+
- CentOS 7 guest support: deprecated in Lima v0.9.2 and removed in Lima v0.23.0, in favor of CentOS Stream, AlmaLinux, and Rocky Linux.
20+
21+
## Undeprecated features
22+
- Loading non-strict YAMLs (i.e., YAMLs with unknown properties): once deprecated in Lima v0.12.0, but undeprecated in Lima v1.0.4

‎website/content/en/docs/releases/experimental.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The following features are experimental and subject to change:
1313
- `audio.device`
1414
- `mountInotify: true`
1515
- `External drivers`: building and using drivers as separate executables (see [Virtual Machine Drivers](../dev/drivers))
16+
- [`vmType: krunkit`](../config/vmtype/krunkit.md)
1617

1718
The following commands are experimental and subject to change:
1819

0 commit comments

Comments
 (0)