Add command to install the guest components

This will install the lima-guestagent in the instance.

It will install nerdctl-full.tgz, if it has been enabled.

Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>

Author: afbjorklund

cmd/limactl/guest-install.go

@@ -0,0 +1,108 @@
+// SPDX-FileCopyrightText: Copyright The Lima Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package main
+
+import (
+	"fmt"
+	"context"
+	"os"
+	"os/exec"
+	"path/filepath"
+
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+
+	"github.com/lima-vm/lima/v2/pkg/cacheutil"
+	"github.com/lima-vm/lima/v2/pkg/limatype"
+	"github.com/lima-vm/lima/v2/pkg/limatype/filenames"
+	"github.com/lima-vm/lima/v2/pkg/store"
+	"github.com/lima-vm/lima/v2/pkg/usrlocalsharelima"
+)
+
+func newGuestInstallCommand() *cobra.Command {
+	guestInstallCommand := &cobra.Command{
+		Use:               "guest-install INSTANCE",
+		Short:             "Install guest components",
+		Args:              WrapArgsError(cobra.MaximumNArgs(1)),
+		RunE:              guestInstallAction,
+		ValidArgsFunction: cobra.NoFileCompletions,
+		Hidden:            true,
+	}
+	return guestInstallCommand
+}
+
+func runCmd(ctx context.Context, name string, flags []string, args ...string) error {
+	cmd := exec.CommandContext(ctx, name, append(flags, args...)...)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	logrus.Debugf("executing %v", cmd.Args)
+	return cmd.Run()
+}
+
+func guestInstallAction(cmd *cobra.Command, args []string) error {
+	instName := DefaultInstanceName
+	if len(args) > 0 {
+		instName = args[0]
+	}
+
+	inst, err := store.Inspect(cmd.Context(), instName)
+	if err != nil {
+		return err
+	}
+	if inst.Status == limatype.StatusStopped {
+		return fmt.Errorf("instance %q is stopped, run `limactl start %s` to start the instance", instName, instName)
+	}
+
+	ctx := cmd.Context()
+
+	sshExe := "ssh"
+	sshConfig := filepath.Join(inst.Dir, filenames.SSHConfig)
+	sshFlags := []string{"-F", sshConfig}
+
+	scpExe := "scp"
+	scpFlags := sshFlags
+
+	hostname := fmt.Sprintf("lima-%s", inst.Name)
+	prefix := *inst.Config.GuestInstallPrefix
+
+	// lima-guestagent
+	guestAgentBinary, err := usrlocalsharelima.GuestAgentBinary(*inst.Config.OS, *inst.Config.Arch)
+	if err != nil {
+		return err
+	}
+	tmp := "/tmp/lima-guestagent"
+	bin := prefix + "/bin/lima-guestagent"
+	logrus.Infof("Copying %q to %s", guestAgentBinary, hostname)
+	scpArgs := []string{guestAgentBinary, hostname + ":" + tmp}
+	if err := runCmd(ctx, scpExe, scpFlags, scpArgs...); err != nil {
+		return nil
+	}
+	logrus.Infof("Installing %s to %s", tmp, bin)
+	sshArgs := []string{hostname, "sudo", "install", "-m", "755", tmp, bin}
+	if err := runCmd(ctx, sshExe, sshFlags, sshArgs...); err != nil {
+		return nil
+	}
+
+	// nerdctl-full.tgz
+	nerdctlFilename := cacheutil.NerdctlArchive(inst.Config)
+	if nerdctlFilename != "" {
+		nerdctlArchive, err := cacheutil.EnsureNerdctlArchiveCache(cmd.Context(), inst.Config, false)
+		if err != nil {
+			return err
+		}
+		tmp := "/tmp/nerdctl-full.tgz"
+		logrus.Infof("Copying %q to %s", nerdctlFilename, hostname)
+		scpArgs := []string{nerdctlArchive, hostname + ":" + tmp}
+		if err := runCmd(ctx, scpExe, scpFlags, scpArgs...); err != nil {
+			return nil
+		}
+		logrus.Infof("Installing %s in %s", tmp, prefix)
+		sshArgs := []string{hostname, "sudo", "tar", "Cxzf", prefix, tmp}
+		if err := runCmd(ctx, sshExe, sshFlags, sshArgs...); err != nil {
+			return nil
+		}
+	}
+
+	return nil
+}

cmd/limactl/main.go

@@ -173,6 +173,7 @@ func newApp() *cobra.Command {
 		newValidateCommand(),
 		newPruneCommand(),
 		newHostagentCommand(),
+		newGuestInstallCommand(),
 		newInfoCommand(),
 		newShowSSHCommand(),
 		newDebugCommand(),

pkg/cacheutil/cacheutil.go

@@ -6,14 +6,25 @@ package cacheutil
 import (
 	"context"
 	"fmt"
+	"path"
 
 	"github.com/lima-vm/lima/v2/pkg/downloader"
 	"github.com/lima-vm/lima/v2/pkg/fileutils"
 	"github.com/lima-vm/lima/v2/pkg/limatype"
 )
 
-// EnsureNerdctlArchiveCache prefetches the archive into the cache.
-//
+// NerdctlArchive returns the basename of the archive.
+func NerdctlArchive(y *limatype.LimaYAML) string {
+	if *y.Containerd.System || *y.Containerd.User {
+		for _, f := range y.Containerd.Archives {
+			if f.Arch == *y.Arch {
+				return path.Base(f.Location)
+			}
+		}
+	}
+	return ""
+}
+
 // EnsureNerdctlArchiveCache prefetches the nerdctl-full-VERSION-GOOS-GOARCH.tar.gz archive
 // into the cache before launching the hostagent process, so that we can show the progress in tty.
 // https://github.com/lima-vm/lima/issues/326