Skip to content

Commit b33c40b

Browse files
authored
Merge pull request #2758 from AkihiroSuda/clean-up-experimental
Remove experimental notice for vz, 9p, user-v2 net, grpc forwarder
2 parents 4b12ecc + d138966 commit b33c40b

File tree

8 files changed

+20
-36
lines changed

8 files changed

+20
-36
lines changed

examples/default.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,8 @@ mounts:
126126
# 🟢 Builtin default: null
127127
mountTypesUnsupported: null
128128

129-
# Mount type for above mounts, such as "reverse-sshfs" (from sshocker), "9p" (EXPERIMENTAL until Lima v1.0, from QEMU’s virtio-9p-pci, aka virtfs),
130-
# or "virtiofs" (EXPERIMENTAL, needs `vmType: vz`; will graduate from experimental in Lima v1.0)
129+
# Mount type for above mounts, such as "reverse-sshfs" (from sshocker), "9p" (QEMU’s virtio-9p-pci, aka virtfs),
130+
# or "virtiofs" (experimental on Linux; needs `vmType: vz` on macOS).
131131
# 🟢 Builtin default: "default" (resolved to be "9p" for QEMU since Lima v1.0, "virtiofs" for vz)
132132
mountType: null
133133

@@ -296,7 +296,7 @@ cpuType:
296296
# x86_64: "qemu64" # (or "host,-pdpe1gb" when running on x86_64 host)
297297

298298
rosetta:
299-
# Enable Rosetta for Linux (EXPERIMENTAL; will graduate from experimental in Lima v1.0).
299+
# Enable Rosetta inside the VM; needs `vmType: vz`
300300
# Hint: try `softwareupdate --install-rosetta` if Lima gets stuck at `Installing rosetta...`
301301
# 🟢 Builtin default: false
302302
enabled: null
@@ -372,7 +372,7 @@ networks:
372372

373373

374374
# The "vzNAT" IP address is accessible from the host, but not from other guests.
375-
# Needs `vmType: vz` (EXPERIMENTAL; will graduate from experimental in Lima v1.0).
375+
# Needs `vmType: vz`
376376
# - vzNAT: true
377377

378378
# Port forwarding rules. Forwarding between ports 22 and ssh.localPort cannot be overridden.

pkg/hostagent/hostagent.go

-5
Original file line numberDiff line numberDiff line change
@@ -189,11 +189,6 @@ func New(instName string, stdout io.Writer, signalCh chan os.Signal, opts ...Opt
189189
limayaml.FillPortForwardDefaults(&rule, inst.Dir, inst.Param)
190190
rules = append(rules, rule)
191191

192-
env, _ := strconv.ParseBool(os.Getenv("LIMA_SSH_PORT_FORWARDER"))
193-
if !env {
194-
logrus.Warn("GRPC port forwarding is experimental")
195-
}
196-
197192
limaDriver := driverutil.CreateTargetDriverInstance(&driver.BaseDriver{
198193
Instance: inst,
199194
SSHLocalPort: sshLocalPort,

website/content/en/docs/config/Port/_index.md

-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,6 @@ LIMA_SSH_PORT_FORWARDER=true limactl start
2424

2525
### Using GRPC (Default since Lima v1.0)
2626

27-
> **Warning**
28-
> This mode is experimental
29-
3027
| ⚡ Requirement | Lima >= 1.0 |
3128
|---------------|-------------|
3229

website/content/en/docs/config/mount/_index.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ Lima supports several methods for mounting the host filesystem into the guest.
77

88
The default mount type is shown in the following table:
99

10-
| Lima Version | Default |
11-
| ---------------- | ------------------------------------------------------------- |
12-
| < 0.10 | reverse-sshfs + Builtin SFTP server |
13-
| >= 0.10 | reverse-sshfs + OpenSSH SFTP server |
14-
| >= 0.17 | reverse-sshfs + OpenSSH SFTP server for QEMU, virtiofs for VZ |
15-
| >= 1.0 (Planned) | 9p for QEMU, virtiofs for VZ |
10+
| Lima Version | Default |
11+
| ------------ | ------------------------------------------------------------- |
12+
| < 0.10 | reverse-sshfs + Builtin SFTP server |
13+
| >= 0.10 | reverse-sshfs + OpenSSH SFTP server |
14+
| >= 0.17 | reverse-sshfs + OpenSSH SFTP server for QEMU, virtiofs for VZ |
15+
| >= 1.0 | 9p for QEMU, virtiofs for VZ |
1616

1717
## Mount types
1818

@@ -62,8 +62,6 @@ Lima prior to v0.10 had used "builtin" as the SFTP driver.
6262
- A compromised `sshfs` process in the guest may have access to unexposed host directories.
6363

6464
### 9p
65-
> **Warning**
66-
> "9p" mode is experimental (will graduate from experimental in Lima v1.0)
6765

6866
The "9p" mount type is implemented by using QEMU's virtio-9p-pci devices.
6967
virtio-9p-pci is also known as "virtfs", but note that this is unrelated to [virtio-fs](https://virtio-fs.gitlab.io/).
@@ -108,7 +106,7 @@ The "9p" mount type requires Lima v0.10.0 or later.
108106

109107
### virtiofs
110108
> **Warning**
111-
> "virtiofs" mode is experimental
109+
> "virtiofs" mode is experimental on Linux hosts
112110

113111
| ⚡ Requirement | Lima >= 0.14, macOS >= 13.0 | Lima >= 0.17.0, Linux, QEMU 4.2.0+, virtiofsd (Rust version) |
114112
|-------------------|-----------------------------| ------------------------------------------------------------ |

website/content/en/docs/config/multi-arch/_index.md

-3
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,6 @@ See also https://github.com/containerd/nerdctl/blob/master/docs/multi-platform.m
6262

6363
## [Fast mode 2 (Rosetta): Intel containers on ARM VM on ARM Host](#fast-mode-2)
6464

65-
> **Warning**
66-
> "vz" mode, including support for Rosetta, is experimental (will graduate from experimental in Lima v1.0)
67-
6865
| ⚡ Requirement | Lima >= 0.14, macOS >= 13.0, ARM |
6966
|-------------------|----------------------------------|
7067

website/content/en/docs/config/network/_index.md

-6
Original file line numberDiff line numberDiff line change
@@ -208,9 +208,6 @@ networks:
208208

209209
### vzNAT
210210

211-
> **Warning**
212-
> "vz" mode is experimental (will graduate from experimental in Lima v1.0)
213-
214211
| ⚡ Requirement | Lima >= 0.14, macOS >= 13.0 |
215212
|-------------------|-----------------------------|
216213

@@ -240,9 +237,6 @@ The "vzNAT" network does not need the `socket_vmnet` binary and the `sudoers` fi
240237

241238
user-v2 network provides a user-mode networking similar to the [default user-mode network](#user-mode-network--1921685024-) and also provides support for `vm -> vm` communication.
242239

243-
> **Warning**
244-
> This network mode is experimental
245-
246240
To enable this network mode, define a network with `mode: user-v2` in networks.yaml
247241

248242
By default, the below network configuration is already applied (Since v0.18).

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

-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ unless the config is incompatible with VZ. (e.g., legacyBIOS or 9p is enabled)
3030
"qemu" option makes use of QEMU to run guest operating system.
3131

3232
## VZ
33-
> **Warning**
34-
> "vz" mode is experimental (will graduate from experimental in Lima v1.0)
3533

3634
| ⚡ Requirement | Lima >= 0.14, macOS >= 13.0 |
3735
|-------------------|-----------------------------|

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

+9-4
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,23 @@ weight: 10
66

77
The following features are experimental and subject to change:
88

9-
- `mountType: 9p` (will graduate from experimental in Lima v1.0)
109
- `mountType: virtiofs` on Linux
11-
- `vmType: vz` and relevant configurations (`mountType: virtiofs`, `rosetta`, `[]networks.vzNAT`)
12-
(will graduate from experimental in Lima v1.0)
1310
- `vmType: wsl2` and relevant configurations (`mountType: wsl2`)
1411
- `arch: riscv64`
1512
- `video.display: vnc` and relevant configuration (`video.vnc.display`)
16-
- `mode: user-v2` in `networks.yml` and relevant configuration in `lima.yaml`
1713
- `audio.device`
1814
- `arch: armv7l`
1915
- `mountInotify: true`
2016

2117
The following commands are experimental and subject to change:
2218

2319
- `limactl snapshot *`
20+
21+
## Graduated
22+
23+
The following features were experimental in the past:
24+
25+
### Until v1.0
26+
- `mountType: 9p`
27+
- `vmType: vz` and relevant configurations (`mountType: virtiofs`, `rosetta`, `[]networks.vzNAT`)
28+
- `mode: user-v2` in `networks.yml` and relevant configuration in `lima.yaml`

0 commit comments

Comments
 (0)