Add optional message to be shown to template

Show example with current values already in place.

Currently just shown as regular INFO log messages.

Signed-off-by: Anders F Björklund <[email protected]>

Author: afbjorklund

examples/docker.yaml

@@ -66,3 +66,7 @@ probes:
 portForwards:
   - guestSocket: "/run/user/{{.UID}}/docker.sock"
     hostSocket: "{{.Dir}}/sock/docker.sock"
+message: |
+  To run `docker` on the host (assumes docker-cli is installed):
+  $ export DOCKER_HOST=unix://{{.Dir}}/sock/docker.sock
+  $ docker ...

examples/podman.yaml

@@ -53,3 +53,7 @@ probes:
 portForwards:
   - guestSocket: "/run/user/{{.UID}}/podman/podman.sock"
     hostSocket: "{{.Dir}}/sock/podman.sock"
+message: |
+  To run `podman` on the host (assumes podman-remote is installed):
+  $ export CONTAINER_HOST=unix://{{.Dir}}/sock/podman.sock
+  $ podman --remote ...

pkg/limayaml/default.yaml

@@ -196,6 +196,12 @@ networks:
 #     hostPortRange: [1, 65535]
 #   # Any port still not matched by a rule will not be forwarded (ignored)
 
+# Message. Information to be shown to the user, given as a Go template for the instance.
+# The same template variables as for listing instances can be used, for example {{.Dir}}.
+# You can view the complete list of variables using `limactl list --list-fields` command.
+# message: |
+#   This will be shown to the user.
+
 # Extra environment variables that will be loaded into the VM at start up.
 # These variables are consumed by internal init scripts, and also added
 # to /etc/environment.

pkg/limayaml/limayaml.go

@@ -20,6 +20,7 @@ type LimaYAML struct {
 	Containerd        Containerd        `yaml:"containerd,omitempty" json:"containerd,omitempty"`
 	Probes            []Probe           `yaml:"probes,omitempty" json:"probes,omitempty"`
 	PortForwards      []PortForward     `yaml:"portForwards,omitempty" json:"portForwards,omitempty"`
+	Message           string            `yaml:"message,omitempty" json:"message,omitempty"`
 	Networks          []Network         `yaml:"networks,omitempty" json:"networks,omitempty"`
 	Network           NetworkDeprecated `yaml:"network,omitempty" json:"network,omitempty"` // DEPRECATED, use `networks` instead
 	Env               map[string]string `yaml:"env,omitempty" json:"env,omitempty"`

pkg/start/start.go

@@ -1,12 +1,15 @@
 package start
 
 import (
+	"bufio"
+	"bytes"
 	"context"
 	"errors"
 	"fmt"
 	"os"
 	"os/exec"
 	"path/filepath"
+	"text/template"
 	"time"
 
 	"github.com/lima-vm/lima/pkg/downloader"
@@ -147,7 +150,7 @@ func Start(ctx context.Context, inst *store.Instance) error {
 
 	watchErrCh := make(chan error)
 	go func() {
-		watchErrCh <- watchHostAgentEvents(ctx, inst.Name, haStdoutPath, haStderrPath, begin)
+		watchErrCh <- watchHostAgentEvents(ctx, inst, haStdoutPath, haStderrPath, begin)
 		close(watchErrCh)
 	}()
 	waitErrCh := make(chan error)
@@ -181,7 +184,7 @@ func waitHostAgentStart(ctx context.Context, haPIDPath, haStderrPath string) err
 	}
 }
 
-func watchHostAgentEvents(ctx context.Context, instName, haStdoutPath, haStderrPath string, begin time.Time) error {
+func watchHostAgentEvents(ctx context.Context, inst *store.Instance, haStdoutPath, haStderrPath string, begin time.Time) error {
 	ctx2, cancel := context.WithTimeout(ctx, 10*time.Minute)
 	defer cancel()
 
@@ -210,7 +213,8 @@ func watchHostAgentEvents(ctx context.Context, instName, haStdoutPath, haStderrP
 				return true
 			}
 
-			logrus.Infof("READY. Run `%s` to open the shell.", LimactlShellCmd(instName))
+			logrus.Infof("READY. Run `%s` to open the shell.", LimactlShellCmd(inst.Name))
+			ShowMessage(inst)
 			err = nil
 			return true
 		}
@@ -239,3 +243,29 @@ func LimactlShellCmd(instName string) string {
 	}
 	return shellCmd
 }
+
+func ShowMessage(inst *store.Instance) error {
+	if inst.Message == "" {
+		return nil
+	}
+	t, err := template.New("message").Parse(inst.Message)
+	if err != nil {
+		return err
+	}
+	data, err := store.AddGlobalFields(inst)
+	if err != nil {
+		return err
+	}
+	var b bytes.Buffer
+	if err := t.Execute(&b, data); err != nil {
+		return err
+	}
+	scanner := bufio.NewScanner(&b)
+	for scanner.Scan() {
+		logrus.Info(scanner.Text())
+	}
+	if err := scanner.Err(); err != nil {
+		return err
+	}
+	return nil
+}

pkg/store/instance.go

@@ -35,6 +35,7 @@ type Instance struct {
 	CPUs         int                `json:"cpus,omitempty"`
 	Memory       int64              `json:"memory,omitempty"` // bytes
 	Disk         int64              `json:"disk,omitempty"`   // bytes
+	Message      string             `json:"message,omitempty"`
 	Networks     []limayaml.Network `json:"network,omitempty"`
 	SSHLocalPort int                `json:"sshLocalPort,omitempty"`
 	HostAgentPID int                `json:"hostAgentPID,omitempty"`
@@ -82,6 +83,7 @@ func Inspect(instName string) (*Instance, error) {
 	if err == nil {
 		inst.Disk = disk
 	}
+	inst.Message = y.Message
 	inst.Networks = y.Networks
 	inst.SSHLocalPort = *y.SSH.LocalPort // maybe 0