Mark the limactl template command and template embedding as experimental

Signed-off-by: Jan Dubois <[email protected]>

Author: jandubois

cmd/limactl/template.go

@@ -24,6 +24,9 @@ func newTemplateCommand() *cobra.Command {
 		// The template command is still hidden because the subcommands and options are still under development
 		// and subject to change at any time.
 		Hidden: true,
+		PreRun: func(*cobra.Command, []string) {
+			logrus.Warn("`limactl template` is experimental")
+		},
 	}
 	templateCommand.AddCommand(
 		newTemplateCopyCommand(),

pkg/limatmpl/embed.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"path/filepath"
 	"slices"
+	"sync"
 
 	"github.com/coreos/go-semver/semver"
 	"github.com/lima-vm/lima/pkg/store/dirnames"
@@ -15,6 +16,13 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+var warnBaseIsExperimental = sync.OnceFunc(func() {
+	logrus.Warn("`base` is experimental")
+})
+var warnFileIsExperimental = sync.OnceFunc(func() {
+	logrus.Warn("`provision[*].file` and `probes[*].file` are experimental")
+})
+
 // Embed will recursively resolve all "base" dependencies and update the
 // template with the merged result. It also inlines all external provisioning
 // and probe scripts.
@@ -64,6 +72,7 @@ func (tmpl *Template) embed(ctx context.Context, defaultBase bool, seen map[stri
 		}
 	}
 	for _, baseLocator := range bases {
+		warnBaseIsExperimental()
 		logrus.Debugf("Merging base template %q", baseLocator)
 		base, err := Read(ctx, "", baseLocator)
 		if err != nil {
@@ -497,6 +506,7 @@ func (tmpl *Template) embedAllScripts(ctx context.Context) error {
 	for i, p := range tmpl.Config.Probes {
 		// Don't overwrite existing file. This should throw an error during validation.
 		if p.File != nil && p.Script == "" {
+			warnFileIsExperimental()
 			scriptTmpl, err := Read(ctx, "", *p.File)
 			if err != nil {
 				return err
@@ -506,6 +516,7 @@ func (tmpl *Template) embedAllScripts(ctx context.Context) error {
 	}
 	for i, p := range tmpl.Config.Provision {
 		if p.File != nil && p.Script == "" {
+			warnFileIsExperimental()
 			scriptTmpl, err := Read(ctx, "", *p.File)
 			if err != nil {
 				return err

templates/default.yaml

@@ -211,8 +211,9 @@ containerd:
 # Provisioning scripts need to be idempotent because they might be called
 # multiple times, e.g. when the host VM is being restarted.
 # The scripts can use the following template variables: {{.Home}}, {{.Name}}, {{.Hostname}}, {{.UID}}, {{.User}}, and {{.Param.Key}}.
-# Alternatively the script can be provided using the "file" property. This file is read when the instance is created and then
-# stored under the "script" property. When "file" is specified, then "script" must be empty.
+#
+# EXPERIMENTAL Alternatively the script can be provided using the "file" property. This file is read when the instance
+# is created and then stored under the "script" property. When "file" is specified "script" must be empty.
 # Relative script files will be resolved relative to the location of the template file.
 # 🟢 Builtin default: []
 # provision:
@@ -252,8 +253,8 @@ containerd:
 # Probe scripts to check readiness.
 # The scripts run in user mode. They must start with a '#!' line.
 # The scripts can use the following template variables: {{.Home}}, {{.Name}}, {{.Hostname}}, {{.UID}}, {{.User}}, and {{.Param.Key}}.
-# Alternatively the script can be provided using the "file" property. This file is read when the instance is created and then
-# stored under the "script" property. When "file" is specified, then "script" must be empty.
+# EXPERIMENTAL Alternatively the script can be provided using the "file" property. This file is read when the instance
+# is created and then stored under the "script" property. When "file" is specified "script" must be empty.
 # Relative script files will be resolved relative to the location of the template file.
 # 🟢 Builtin default: []
 # probes:
@@ -280,6 +281,7 @@ containerd:
 # 🟢 Builtin default: not set
 minimumLimaVersion: null
 
+# EXPERIMENTAL
 # Default settings can be imported from base templates. These will be merged in when the instance
 # is created, and the combined template is stored in the instance directory.
 # This setting ca be either a single string, or a list of strings.
@@ -569,6 +571,7 @@ nestedVirtualization: null
 # on each restart. It can be used to globally override settings, e.g. make
 # the mount of the home directory writable.
 
+# EXPERIMENTAL
 # A third mechanism is $LIMA_HOME/_config/base.yaml. It is similar to
 # `default.yaml` but will be merged during the `base` template embedding
 # when the instance is created, and not on every start. It becomes part