examples: unembed default.yaml

Signed-off-by: Akihiro Suda <[email protected]>

Author: AkihiroSuda

Makefile

@@ -23,8 +23,10 @@ binaries: \
 	_output/bin/nerdctl.lima \
 	_output/share/lima/lima-guestagent.Linux-x86_64 \
 	_output/share/lima/lima-guestagent.Linux-aarch64
+	cp -aL examples _output/share/lima
 	mkdir -p _output/share/doc/lima
-	cp -aL README.md LICENSE docs examples _output/share/doc/lima
+	cp -aL README.md LICENSE docs _output/share/doc/lima
+	ln -sf ../../lima/examples _output/share/doc/lima
 	echo $(VERSION) > _output/share/doc/lima/VERSION
 
 .PHONY: _output/bin/lima
@@ -56,7 +58,8 @@ _output/share/lima/lima-guestagent.Linux-aarch64:
 .PHONY: install
 install:
 	mkdir -p "$(DEST)"
-	cp -av _output/* "$(DEST)"
+	# Use tar rather than cp, for better symlink handling
+	( cd _output && tar c * | tar Cxv "$(DEST)" )
 	if [ "$(shell uname -s )" != "Linux" -a ! -e "$(DEST)/bin/nerdctl" ]; then ln -sf nerdctl.lima "$(DEST)/bin/nerdctl"; fi
 
 .PHONY: uninstall

README.md

@@ -177,7 +177,7 @@ Especially, the following data might be easily lost:
 
 ### Configuration
 
-See [`./pkg/limayaml/default.yaml`](./pkg/limayaml/default.yaml).
+See [`./examples/default.yaml`](./examples/default.yaml).
 
 The current default spec:
 - OS: Ubuntu 21.10 (Impish Indri)

cmd/limactl/info.go

@@ -28,7 +28,11 @@ type Info struct {
 }
 
 func infoAction(cmd *cobra.Command, args []string) error {
-	y, err := limayaml.Load(limayaml.DefaultTemplate, "")
+	b, err := readDefaultTemplate()
+	if err != nil {
+		return err
+	}
+	y, err := limayaml.Load(b, "")
 	if err != nil {
 		return err
 	}

cmd/limactl/start.go

@@ -21,6 +21,7 @@ import (
 	"github.com/lima-vm/lima/pkg/store"
 	"github.com/lima-vm/lima/pkg/store/dirnames"
 	"github.com/lima-vm/lima/pkg/store/filenames"
+	"github.com/lima-vm/lima/pkg/usrlocalsharelima"
 	"github.com/mattn/go-isatty"
 	"github.com/norouter/norouter/cmd/norouter/editorcmd"
 	"github.com/sirupsen/logrus"
@@ -39,6 +40,15 @@ func newStartCommand() *cobra.Command {
 	return startCommand
 }
 
+func readDefaultTemplate() ([]byte, error) {
+	dir, err := usrlocalsharelima.Dir()
+	if err != nil {
+		return nil, err
+	}
+	defaultYAMLPath := filepath.Join(dir, "examples", "default.yaml")
+	return os.ReadFile(defaultYAMLPath)
+}
+
 func loadOrCreateInstance(cmd *cobra.Command, args []string) (*store.Instance, error) {
 	var arg string
 	if len(args) == 0 {
@@ -47,11 +57,12 @@ func loadOrCreateInstance(cmd *cobra.Command, args []string) (*store.Instance, e
 		arg = args[0]
 	}
 
-	var (
-		instName string
-		yBytes   = limayaml.DefaultTemplate
-		err      error
-	)
+	yBytes, err := readDefaultTemplate()
+	if err != nil {
+		return nil, err
+	}
+
+	var instName string
 
 	const yBytesLimit = 4 * 1024 * 1024 // 4MiB
 

examples/README.md

@@ -2,7 +2,7 @@
 
 ⭐ = ["Tier 1"](#tier-1)
 
-Default: [`default.yaml`](../pkg/limayaml/default.yaml) (⭐Ubuntu, with containerd/nerdctl)
+Default: [`default.yaml`](./default.yaml) (⭐Ubuntu, with containerd/nerdctl)
 
 Distro:
 - [`almalinux.yaml`](./almalinux.yaml): AlmaLinux