vz: graduate from experimental

examples/experimental/vz.yaml is retained until v1.0 RC, to avoid breaking existing bookmarks. Signed-off-by: Akihiro Suda <[email protected]>
lima-vm · Oct 26, 2023 · 52c68fa · 52c68fa
1 parent 367a348
commit 52c68fa
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 10 deletions.
diff --git a/cmd/limactl/editflags/editflags.go b/cmd/limactl/editflags/editflags.go
@@ -187,7 +187,7 @@ func YQExpressions(flags *flag.FlagSet, newInstance bool) ([]string, error) {
 				return fmt.Sprintf(".rosetta.enabled = %v | .rosetta.binfmt = %v", b, b), nil
 			},
 			false,
-			true},
+			false},
 		{"set", d("%s"), false, false},
 		{"video",
 			func(_ *flag.Flag) (string, error) {

diff --git a/examples/default.yaml b/examples/default.yaml
@@ -99,7 +99,7 @@ mounts:
   writable: true
 
 # Mount type for above mounts, such as "reverse-sshfs" (from sshocker), "9p" (EXPERIMENTAL, from QEMU’s virtio-9p-pci, aka virtfs),
-# or "virtiofs" (EXPERIMENTAL, needs `vmType: vz`)
+# or "virtiofs" (EXPERIMENTAL, needs `vmType: vz`; will graduate from experimental in Lima v1.0)
 # 🟢 Builtin default: "reverse-sshfs" (for QEMU), "virtiofs" (for vz)
 mountType: null
 
@@ -251,7 +251,7 @@ cpuType:
   x86_64: null
 
 rosetta:
-  # Enable Rosetta for Linux (EXPERIMENTAL).
+  # Enable Rosetta for Linux (EXPERIMENTAL; will graduate from experimental in Lima v1.0).
   # Hint: try `softwareupdate --install-rosetta` if Lima gets stuck at `Installing rosetta...`
   # 🟢 Builtin default: false
   enabled: null
@@ -312,7 +312,7 @@ networks:
 
 
 # The "vzNAT" IP address is accessible from the host, but not from other guests.
-# Needs `vmType: vz` (EXPERIMENTAL).
+# Needs `vmType: vz` (EXPERIMENTAL; will graduate from experimental in Lima v1.0).
 # - vzNAT: true
 
 # vnl (virtual network locator) points to the vde_switch socket directory,

diff --git a/examples/experimental/vz.yaml b/examples/experimental/vz.yaml
@@ -1,3 +1,11 @@
+# ⚠️ ⚠️ ⚠️ `template://experimental/vz` will be removed in in Lima v1.0,
+# as vz will graduate from experimental and will be the default vmType.
+#
+# Use the following command instead:
+# ```
+# limactl create --vm-type=vz --rosetta template://default
+# ```
+
 # A template to run ubuntu using vmType: vz instead of qemu (Default)
 # This template requires Lima v0.14.0 or later and macOS 13.
 vmType: "vz"

diff --git a/pkg/limayaml/validate.go b/pkg/limayaml/validate.go
@@ -460,9 +460,6 @@ func warnExperimental(y LimaYAML) {
 	if *y.MountType == VIRTIOFS && runtime.GOOS == "linux" {
 		logrus.Warn("`mountType: virtiofs` on Linux is experimental")
 	}
-	if *y.VMType == VZ {
-		logrus.Warn("`vmType: vz` is experimental")
-	}
 	if *y.Arch == RISCV64 {
 		logrus.Warn("`arch: riscv64` is experimental")
 	}

diff --git a/website/content/en/docs/Config/Multi-arch/_index.md b/website/content/en/docs/Config/Multi-arch/_index.md
@@ -63,7 +63,7 @@ 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
+> "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
@@ -185,7 +185,7 @@ networks:
 ### vzNAT
 
 > **Warning**
-> "vz" mode is experimental
+> "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/Config/VMType/_index.md b/website/content/en/docs/Config/VMType/_index.md
@@ -28,7 +28,7 @@ This option is used by default if "vmType" is not set.
 
 ## VZ
 > **Warning**
-> "vz" mode is experimental
+> "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
@@ -9,6 +9,7 @@ The following features are experimental and subject to change:
 - `mountType: 9p`
 - `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`)