Merge pull request #674 from AkihiroSuda/choose-examples

limactl start: support `limactl start template://TEMPLATE`

Author: AkihiroSuda

Makefile

@@ -17,14 +17,16 @@ GO_BUILD := $(GO) build -ldflags="-s -w -X $(PACKAGE)/pkg/version.Version=$(VERS
 all: binaries
 
 .PHONY: binaries
-binaries: \
+binaries: clean \
 	_output/bin/lima \
 	_output/bin/limactl \
 	_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 *.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
@@ -54,14 +56,15 @@ _output/share/lima/lima-guestagent.Linux-aarch64:
 	chmod 644 $@
 
 .PHONY: install
-install:
+install: uninstall
 	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
 uninstall:
-	@test -f "$(DEST)/bin/lima" || (echo "lima not found in $(DEST) prefix"; exit 1)
+	@test -f "$(DEST)/bin/lima" || echo "lima not found in $(DEST) prefix"
 	rm -rf \
 		"$(DEST)/bin/lima" \
 		"$(DEST)/bin/limactl" \

README.md

@@ -144,10 +144,28 @@ Detailed usage:
 
 - Run `limactl start <INSTANCE> [--tty=false]` to start the Linux instance.
   The default instance name is "default".
-  Lima automatically opens an editor (`vi`) for reviewing and modifying the configuration.
   Wait until "READY" to be printed on the host terminal.
   `--tty=false` disables the interactive prompt to open an editor.
 
+```
+To create an instance "default" (if not created yet) from the default Ubuntu template, and start it:
+$ limactl start
+
+To create an instance "default" from a template "docker":
+$ limactl start --name=default template://docker
+
+To see the template list:
+$ limactl start --list-templates
+
+To create an instance "default" from a local file:
+$ limactl start --name=default /usr/local/share/lima/examples/fedora.yaml
+
+To create an instance "default" from a remote URL (use carefully, with a trustable source):
+$ limactl start --name=default https://raw.githubusercontent.com/lima-vm/lima/master/examples/alpine.yaml
+```
+NOTE: `limactl start template://TEMPLATE` requires Lima v0.9.0 or later.
+Older releases require `limactl start /usr/local/share/doc/lima/examples/TEMPLATE.yaml` instead.
+
 - Run `limactl shell <INSTANCE> <COMMAND>` to launch `<COMMAND>` on Linux.
   For the "default" instance, this command can be shortened as `lima <COMMAND>`.
   The `lima` command also accepts the instance name as the environment variable `$LIMA_INSTANCE`.
@@ -178,7 +196,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/edit.go

@@ -56,7 +56,7 @@ func editAction(cmd *cobra.Command, args []string) error {
 	hdr += "# and an empty file will abort the edit.\n"
 	hdr += "\n"
 	hdr += generateEditorWarningHeader()
-	yBytes, err := openEditor(cmd, instName, yContent, hdr)
+	yBytes, err := openEditor(instName, yContent, hdr)
 	if err != nil {
 		return err
 	}

cmd/limactl/info.go

@@ -20,22 +20,36 @@ func newInfoCommand() *cobra.Command {
 	return infoCommand
 }
 
+type TemplateYAML struct {
+	Name     string `json:"name"`
+	Location string `json:"location"`
+}
+
 type Info struct {
 	Version         string             `json:"version"`
+	Templates       []TemplateYAML     `json:"templates"`
 	DefaultTemplate *limayaml.LimaYAML `json:"defaultTemplate"`
 	LimaHome        string             `json:"limaHome"`
 	// TODO: add diagnostic info of QEMU
 }
 
 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
 	}
 	info := &Info{
 		Version:         version.Version,
 		DefaultTemplate: y,
 	}
+	info.Templates, err = listTemplateYAMLs()
+	if err != nil {
+		return err
+	}
 	info.LimaHome, err = dirnames.LimaDir()
 	if err != nil {
 		return err