Merge pull request #2758 from AkihiroSuda/clean-up-experimental

Remove experimental notice for vz, 9p, user-v2 net, grpc forwarder
lima-vm · Oct 17, 2024 · b33c40b · b33c40b
2 parents 4b12ecc + d138966
commit b33c40b
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 36 deletions.
diff --git a/examples/default.yaml b/examples/default.yaml
@@ -126,8 +126,8 @@ mounts:
 # 🟢 Builtin default: null
 mountTypesUnsupported: null
 
-# 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),
-# or "virtiofs" (EXPERIMENTAL, needs `vmType: vz`; will graduate from experimental in Lima v1.0)
+# Mount type for above mounts, such as "reverse-sshfs" (from sshocker), "9p" (QEMU’s virtio-9p-pci, aka virtfs),
+# or "virtiofs" (experimental on Linux; needs `vmType: vz` on macOS).
 # 🟢 Builtin default: "default" (resolved to be "9p" for QEMU since Lima v1.0, "virtiofs" for vz)
 mountType: null
 
@@ -296,7 +296,7 @@ cpuType:
 #   x86_64: "qemu64" # (or "host,-pdpe1gb" when running on x86_64 host)
 
 rosetta:
-  # Enable Rosetta for Linux (EXPERIMENTAL; will graduate from experimental in Lima v1.0).
+  # Enable Rosetta inside the VM; needs `vmType: vz`
   # Hint: try `softwareupdate --install-rosetta` if Lima gets stuck at `Installing rosetta...`
   # 🟢 Builtin default: false
   enabled: null
@@ -372,7 +372,7 @@ networks:
 
 
 # The "vzNAT" IP address is accessible from the host, but not from other guests.
-# Needs `vmType: vz` (EXPERIMENTAL; will graduate from experimental in Lima v1.0).
+# Needs `vmType: vz`
 # - vzNAT: true
 
 # Port forwarding rules. Forwarding between ports 22 and ssh.localPort cannot be overridden.

diff --git a/pkg/hostagent/hostagent.go b/pkg/hostagent/hostagent.go
@@ -189,11 +189,6 @@ func New(instName string, stdout io.Writer, signalCh chan os.Signal, opts ...Opt
 	limayaml.FillPortForwardDefaults(&rule, inst.Dir, inst.Param)
 	rules = append(rules, rule)
 
-	env, _ := strconv.ParseBool(os.Getenv("LIMA_SSH_PORT_FORWARDER"))
-	if !env {
-		logrus.Warn("GRPC port forwarding is experimental")
-	}
-
 	limaDriver := driverutil.CreateTargetDriverInstance(&driver.BaseDriver{
 		Instance:     inst,
 		SSHLocalPort: sshLocalPort,

diff --git a/website/content/en/docs/config/Port/_index.md b/website/content/en/docs/config/Port/_index.md
@@ -24,9 +24,6 @@ LIMA_SSH_PORT_FORWARDER=true limactl start
 
 ### Using GRPC (Default since Lima v1.0)
 
-> **Warning**
-> This mode is experimental
-
 | ⚡ Requirement | Lima >= 1.0 |
 |---------------|-------------|
 

diff --git a/website/content/en/docs/config/mount/_index.md b/website/content/en/docs/config/mount/_index.md
@@ -7,12 +7,12 @@ Lima supports several methods for mounting the host filesystem into the guest.
 
 The default mount type is shown in the following table:
 
-| Lima Version     | Default                                                       |
-| ---------------- | ------------------------------------------------------------- |
-| < 0.10           | reverse-sshfs + Builtin SFTP server                           |
-| >= 0.10          | reverse-sshfs + OpenSSH SFTP server                           |
-| >= 0.17          | reverse-sshfs + OpenSSH SFTP server for QEMU, virtiofs for VZ |
-| >= 1.0 (Planned) | 9p for QEMU, virtiofs for VZ                                  |
+| Lima Version | Default                                                       |
+| ------------ | ------------------------------------------------------------- |
+| < 0.10       | reverse-sshfs + Builtin SFTP server                           |
+| >= 0.10      | reverse-sshfs + OpenSSH SFTP server                           |
+| >= 0.17      | reverse-sshfs + OpenSSH SFTP server for QEMU, virtiofs for VZ |
+| >= 1.0       | 9p for QEMU, virtiofs for VZ                                  |
 
 ## Mount types
 
@@ -62,8 +62,6 @@ Lima prior to v0.10 had used "builtin" as the SFTP driver.
 - A compromised `sshfs` process in the guest may have access to unexposed host directories.
 
 ### 9p
-> **Warning**
-> "9p" mode is experimental (will graduate from experimental in Lima v1.0)
 
 The "9p" mount type is implemented by using QEMU's virtio-9p-pci devices.
 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.
 
 ### virtiofs
 > **Warning**
-> "virtiofs" mode is experimental
+> "virtiofs" mode is experimental on Linux hosts
 
 | ⚡ Requirement | Lima >= 0.14, macOS >= 13.0 | Lima >= 0.17.0, Linux, QEMU 4.2.0+, virtiofsd (Rust version) |
 |-------------------|-----------------------------| ------------------------------------------------------------ |

diff --git a/website/content/en/docs/config/multi-arch/_index.md b/website/content/en/docs/config/multi-arch/_index.md
@@ -62,9 +62,6 @@ See also https://github.com/containerd/nerdctl/blob/master/docs/multi-platform.m
 
 ## [Fast mode 2 (Rosetta): Intel containers on ARM VM on ARM Host](#fast-mode-2)
 
-> **Warning**
-> "vz" mode, including support for Rosetta, is experimental (will graduate from experimental in Lima v1.0)
-
 | ⚡ Requirement | Lima >= 0.14, macOS >= 13.0, ARM |
 |-------------------|----------------------------------|
 

diff --git a/website/content/en/docs/config/network/_index.md b/website/content/en/docs/config/network/_index.md
@@ -208,9 +208,6 @@ networks:
 
 ### vzNAT
 
-> **Warning**
-> "vz" mode is experimental (will graduate from experimental in Lima v1.0)
-
 | ⚡ Requirement | Lima >= 0.14, macOS >= 13.0 |
 |-------------------|-----------------------------|
 
@@ -240,9 +237,6 @@ The "vzNAT" network does not need the `socket_vmnet` binary and the `sudoers` fi
 
 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.
 
-> **Warning**
-> This network mode is experimental
-
 To enable this network mode, define a network with `mode: user-v2` in networks.yaml
 
 By default, the below network configuration is already applied (Since v0.18).

diff --git a/website/content/en/docs/config/vmtype/_index.md b/website/content/en/docs/config/vmtype/_index.md
@@ -30,8 +30,6 @@ unless the config is incompatible with VZ. (e.g., legacyBIOS or 9p is enabled)
 "qemu" option makes use of QEMU to run guest operating system. 
 
 ## VZ
-> **Warning**
-> "vz" mode is experimental (will graduate from experimental in Lima v1.0)
 
 | ⚡ Requirement | Lima >= 0.14, macOS >= 13.0 |
 |-------------------|-----------------------------|

diff --git a/website/content/en/docs/releases/experimental/_index.md b/website/content/en/docs/releases/experimental/_index.md
@@ -6,18 +6,23 @@ weight: 10
 
 The following features are experimental and subject to change:
 
-- `mountType: 9p` (will graduate from experimental in Lima v1.0)
 - `mountType: virtiofs` on Linux
-- `vmType: vz` and relevant configurations (`mountType: virtiofs`, `rosetta`, `[]networks.vzNAT`)
-  (will graduate from experimental in Lima v1.0)
 - `vmType: wsl2` and relevant configurations (`mountType: wsl2`)
 - `arch: riscv64`
 - `video.display: vnc` and relevant configuration (`video.vnc.display`)
-- `mode: user-v2` in `networks.yml` and relevant configuration in `lima.yaml`
 - `audio.device`
 - `arch: armv7l`
 - `mountInotify: true`
 
 The following commands are experimental and subject to change:
 
 - `limactl snapshot *`
+
+## Graduated
+
+The following features were experimental in the past:
+
+### Until v1.0
+- `mountType: 9p`
+- `vmType: vz` and relevant configurations (`mountType: virtiofs`, `rosetta`, `[]networks.vzNAT`)
+- `mode: user-v2` in `networks.yml` and relevant configuration in `lima.yaml`