Merge pull request #280 from AkihiroSuda/custom-nerdctl-archive

AkihiroSuda · web-flow · commit 3f5a75678f1e · 2021-10-05T16:35:07.000+09:00
yaml: support overriding the location of `nerdctl-full-X.Y.Z-linux-ARCH.tar.gz`
diff --git a/cmd/limactl/info.go b/cmd/limactl/info.go
@@ -0,0 +1,43 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/lima-vm/lima/pkg/limayaml"
+	"github.com/lima-vm/lima/pkg/version"
+	"github.com/spf13/cobra"
+)
+
+func newInfoCommand() *cobra.Command {
+	infoCommand := &cobra.Command{
+		Use:   "info",
+		Short: "Show diagnostic information",
+		Args:  cobra.NoArgs,
+		RunE:  infoAction,
+	}
+	return infoCommand
+}
+
+type Info struct {
+	Version         string             `json:"version"`
+	DefaultTemplate *limayaml.LimaYAML `json:"defaultTemplate"`
+	// TODO: add diagnostic info of QEMU
+}
+
+func infoAction(cmd *cobra.Command, args []string) error {
+	y, err := limayaml.Load(limayaml.DefaultTemplate, "")
+	if err != nil {
+		return err
+	}
+	info := &Info{
+		Version:         version.Version,
+		DefaultTemplate: y,
+	}
+	j, err := json.MarshalIndent(info, "", "    ")
+	if err != nil {
+		return err
+	}
+	_, err = fmt.Fprintln(cmd.OutOrStdout(), string(j))
+	return err
+}
diff --git a/cmd/limactl/main.go b/cmd/limactl/main.go
@@ -79,6 +79,7 @@ func newApp() *cobra.Command {
 		newSudoersCommand(),
 		newPruneCommand(),
 		newHostagentCommand(),
+		newInfoCommand(),
 	)
 	return rootCmd
 }
diff --git a/pkg/cidata/cidata.go b/pkg/cidata/cidata.go
@@ -17,24 +17,12 @@ import (
 	"github.com/lima-vm/lima/pkg/limayaml"
 	"github.com/lima-vm/lima/pkg/localpathutil"
 	"github.com/lima-vm/lima/pkg/osutil"
-	"github.com/lima-vm/lima/pkg/qemu/const"
+	qemu "github.com/lima-vm/lima/pkg/qemu/const"
 	"github.com/lima-vm/lima/pkg/sshutil"
 	"github.com/lima-vm/lima/pkg/store/filenames"
-	"github.com/opencontainers/go-digest"
 	"github.com/sirupsen/logrus"
 )
 
-const (
-	NerdctlVersion = "0.12.0"
-)
-
-var (
-	NerdctlFullDigests = map[limayaml.Arch]digest.Digest{
-		limayaml.X8664:   "sha256:7789800cfdd19fa9eccadb5e4a911e4ba759799ad9ec0b7929c983b9d149bc98",
-		limayaml.AARCH64: "sha256:ebb05e22ac6a3c25ac88ca4f747feed89bfae8e447a626d0fedf3b4f40ac3303",
-	}
-)
-
 func setupEnv(y *limayaml.LimaYAML) (map[string]string, error) {
 	// Start with the proxy variables from the system settings.
 	env, err := osutil.ProxySettings()
@@ -177,33 +165,32 @@ func GenerateISO9660(instDir, name string, y *limayaml.LimaYAML) error {
 	}
 
 	if args.Containerd.System || args.Containerd.User {
-		var nftgzBase string
-		switch y.Arch {
-		case limayaml.X8664:
-			nftgzBase = fmt.Sprintf("nerdctl-full-%s-linux-amd64.tar.gz", NerdctlVersion)
-		case limayaml.AARCH64:
-			nftgzBase = fmt.Sprintf("nerdctl-full-%s-linux-arm64.tar.gz", NerdctlVersion)
-		default:
-			return fmt.Errorf("unexpected arch %q", y.Arch)
+		var nftgz *limayaml.File
+		for i := range y.Containerd.Archives {
+			f := &y.Containerd.Archives[i]
+			if f.Arch != y.Arch {
+				continue
+			}
+			nftgz = f
+		}
+		if nftgz == nil {
+			return fmt.Errorf("no containerd archive was provided for arch %q", y.Arch)
 		}
 		td, err := ioutil.TempDir("", "lima-download-nerdctl")
 		if err != nil {
 			return err
 		}
 		defer os.RemoveAll(td)
-		nftgzLocal := filepath.Join(td, nftgzBase)
-		nftgzURL := fmt.Sprintf("https://github.com/containerd/nerdctl/releases/download/v%s/%s",
-			NerdctlVersion, nftgzBase)
-		nftgzDigest := NerdctlFullDigests[y.Arch]
-		logrus.Infof("Downloading %q (%s)", nftgzURL, nftgzDigest)
-		res, err := downloader.Download(nftgzLocal, nftgzURL, downloader.WithCache(), downloader.WithExpectedDigest(nftgzDigest))
+		nftgzLocal := filepath.Join(td, "nerdctl-full.tgz")
+		logrus.Infof("Downloading %q (%s)", nftgz.Location, nftgz.Digest)
+		res, err := downloader.Download(nftgzLocal, nftgz.Location, downloader.WithCache(), downloader.WithExpectedDigest(nftgz.Digest))
 		if err != nil {
-			return fmt.Errorf("failed to download %q: %w", nftgzURL, err)
+			return fmt.Errorf("failed to download %q: %w", nftgz.Location, err)
 		}
 		logrus.Debugf("res.ValidatedDigest=%v", res.ValidatedDigest)
 		switch res.Status {
 		case downloader.StatusDownloaded:
-			logrus.Infof("Downloaded %q", nftgzBase)
+			logrus.Infof("Downloaded %q", nftgz.Location)
 		case downloader.StatusUsedCache:
 			logrus.Infof("Using cache %q", res.CachePath)
 		default:
diff --git a/pkg/limayaml/default.yaml b/pkg/limayaml/default.yaml
@@ -70,6 +70,12 @@ containerd:
   # Enable user-scoped (aka rootless) containerd and its dependencies
   # Default: true
   user: true
+#  # Override containerd archive
+#  # Default: hard-coded URL with hard-coded digest (see the output of `limactl info | jq .defaultTemplate.containerd.archives`)
+#  archives:
+#    - location: "~/Downloads/nerdctl-full-X.Y.Z-linux-amd64.tar.gz"
+#      arch: "x86_64"
+#      digest: "sha256:..."
 
 # Provisioning scripts need to be idempotent because they might be called
 # multiple times, e.g. when the host VM is being restarted.
diff --git a/pkg/limayaml/defaults.go b/pkg/limayaml/defaults.go
@@ -11,6 +11,25 @@ import (
 	"github.com/lima-vm/lima/pkg/osutil"
 )
 
+func defaultContainerdArchives() []File {
+	const nerdctlVersion = "0.12.0"
+	location := func(goarch string) string {
+		return "https://github.com/containerd/nerdctl/releases/download/v" + nerdctlVersion + "/nerdctl-full-" + nerdctlVersion + "-linux-" + goarch + ".tar.gz"
+	}
+	return []File{
+		{
+			Location: location("amd64"),
+			Arch:     X8664,
+			Digest:   "sha256:7789800cfdd19fa9eccadb5e4a911e4ba759799ad9ec0b7929c983b9d149bc98",
+		},
+		{
+			Location: location("arm64"),
+			Arch:     AARCH64,
+			Digest:   "sha256:ebb05e22ac6a3c25ac88ca4f747feed89bfae8e447a626d0fedf3b4f40ac3303",
+		},
+	}
+}
+
 func MACAddress(uniqueID string) string {
 	sha := sha256.Sum256([]byte(osutil.MachineID() + uniqueID))
 	// "5" is the magic number in the Lima ecosystem.
@@ -59,6 +78,15 @@ func FillDefault(y *LimaYAML, filePath string) {
 	if y.Containerd.User == nil {
 		y.Containerd.User = &[]bool{true}[0]
 	}
+	if len(y.Containerd.Archives) == 0 {
+		y.Containerd.Archives = defaultContainerdArchives()
+	}
+	for i := range y.Containerd.Archives {
+		f := &y.Containerd.Archives[i]
+		if f.Arch == "" {
+			f.Arch = y.Arch
+		}
+	}
 	for i := range y.Probes {
 		probe := &y.Probes[i]
 		if probe.Mode == "" {
@@ -79,10 +107,10 @@ func FillDefault(y *LimaYAML, filePath string) {
 	if len(y.Network.VDEDeprecated) > 0 && len(y.Networks) == 0 {
 		for _, vde := range y.Network.VDEDeprecated {
 			network := Network{
-				Interface: vde.Name,
+				Interface:  vde.Name,
 				MACAddress: vde.MACAddress,
 				SwitchPort: vde.SwitchPort,
-				VNL: vde.VNL,
+				VNL:        vde.VNL,
 			}
 			y.Networks = append(y.Networks, network)
 		}
diff --git a/pkg/limayaml/limayaml.go b/pkg/limayaml/limayaml.go
@@ -7,24 +7,24 @@ import (
 )
 
 type LimaYAML struct {
-	Arch            Arch              `yaml:"arch,omitempty"`
-	Images          []File            `yaml:"images"` // REQUIRED
-	CPUs            int               `yaml:"cpus,omitempty"`
-	Memory          string            `yaml:"memory,omitempty"` // go-units.RAMInBytes
-	Disk            string            `yaml:"disk,omitempty"`   // go-units.RAMInBytes
-	Mounts          []Mount           `yaml:"mounts,omitempty"`
-	SSH             SSH               `yaml:"ssh,omitempty"` // REQUIRED (FIXME)
-	Firmware        Firmware          `yaml:"firmware,omitempty"`
-	Video           Video             `yaml:"video,omitempty"`
-	Provision       []Provision       `yaml:"provision,omitempty"`
-	Containerd      Containerd        `yaml:"containerd,omitempty"`
-	Probes          []Probe           `yaml:"probes,omitempty"`
-	PortForwards    []PortForward     `yaml:"portForwards,omitempty"`
-	Networks        []Network         `yaml:"networks,omitempty"`
-	Network         NetworkDeprecated `yaml:"network,omitempty"` // DEPRECATED, use `networks` instead
-	Env             map[string]string `yaml:"env,omitempty"`
-	DNS             []net.IP          `yaml:"dns,omitempty"`
-	UseHostResolver *bool             `yaml:"useHostResolver,omitempty"`
+	Arch            Arch              `yaml:"arch,omitempty" json:"arch,omitempty"`
+	Images          []File            `yaml:"images" json:"images"` // REQUIRED
+	CPUs            int               `yaml:"cpus,omitempty" json:"cpus,omitempty"`
+	Memory          string            `yaml:"memory,omitempty" json:"memory,omitempty"` // go-units.RAMInBytes
+	Disk            string            `yaml:"disk,omitempty" json:"disk,omitempty"`     // go-units.RAMInBytes
+	Mounts          []Mount           `yaml:"mounts,omitempty" json:"mounts,omitempty"`
+	SSH             SSH               `yaml:"ssh,omitempty" json:"ssh,omitempty"` // REQUIRED (FIXME)
+	Firmware        Firmware          `yaml:"firmware,omitempty" json:"firmware,omitempty"`
+	Video           Video             `yaml:"video,omitempty" json:"video,omitempty"`
+	Provision       []Provision       `yaml:"provision,omitempty" json:"provision,omitempty"`
+	Containerd      Containerd        `yaml:"containerd,omitempty" json:"containerd,omitempty"`
+	Probes          []Probe           `yaml:"probes,omitempty" json:"probes,omitempty"`
+	PortForwards    []PortForward     `yaml:"portForwards,omitempty" json:"portForwards,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"`
+	DNS             []net.IP          `yaml:"dns,omitempty" json:"dns,omitempty"`
+	UseHostResolver *bool             `yaml:"useHostResolver,omitempty" json:"useHostResolver,omitempty"`
 }
 
 type Arch = string
@@ -35,33 +35,33 @@ const (
 )
 
 type File struct {
-	Location string        `yaml:"location"` // REQUIRED
-	Arch     Arch          `yaml:"arch,omitempty"`
-	Digest   digest.Digest `yaml:"digest,omitempty"`
+	Location string        `yaml:"location" json:"location"` // REQUIRED
+	Arch     Arch          `yaml:"arch,omitempty" json:"arch,omitempty"`
+	Digest   digest.Digest `yaml:"digest,omitempty" json:"digest,omitempty"`
 }
 
 type Mount struct {
-	Location string `yaml:"location"` // REQUIRED
-	Writable bool   `yaml:"writable,omitempty"`
+	Location string `yaml:"location" json:"location"` // REQUIRED
+	Writable bool   `yaml:"writable,omitempty" json:"writable,omitempty"`
 }
 
 type SSH struct {
-	LocalPort int `yaml:"localPort,omitempty"` // REQUIRED (FIXME: auto assign)
+	LocalPort int `yaml:"localPort,omitempty" json:"localPort,omitempty"` // REQUIRED (FIXME: auto assign)
 
 	// LoadDotSSHPubKeys loads ~/.ssh/*.pub in addition to $LIMA_HOME/_config/user.pub .
 	// Default: true
-	LoadDotSSHPubKeys *bool `yaml:"loadDotSSHPubKeys,omitempty"`
+	LoadDotSSHPubKeys *bool `yaml:"loadDotSSHPubKeys,omitempty" json:"loadDotSSHPubKeys,omitempty"`
 }
 
 type Firmware struct {
 	// LegacyBIOS disables UEFI if set.
 	// LegacyBIOS is ignored for aarch64.
-	LegacyBIOS bool `yaml:"legacyBIOS,omitempty"`
+	LegacyBIOS bool `yaml:"legacyBIOS,omitempty" json:"legacyBIOS,omitempty"`
 }
 
 type Video struct {
 	// Display is a QEMU display string
-	Display string `yaml:"display,omitempty"`
+	Display string `yaml:"display,omitempty" json:"display,omitempty"`
 }
 
 type ProvisionMode = string
@@ -72,13 +72,14 @@ const (
 )
 
 type Provision struct {
-	Mode   ProvisionMode `yaml:"mode"` // default: "system"
-	Script string        `yaml:"script"`
+	Mode   ProvisionMode `yaml:"mode" json:"mode"` // default: "system"
+	Script string        `yaml:"script" json:"script"`
 }
 
 type Containerd struct {
-	System *bool `yaml:"system,omitempty"` // default: false
-	User   *bool `yaml:"user,omitempty"`   // default: true
+	System   *bool  `yaml:"system,omitempty" json:"system,omitempty"`     // default: false
+	User     *bool  `yaml:"user,omitempty" json:"user,omitempty"`         // default: true
+	Archives []File `yaml:"archives,omitempty" json:"archives,omitempty"` // default: see defaultContainerdArchives
 }
 
 type ProbeMode = string
@@ -101,25 +102,25 @@ const (
 )
 
 type PortForward struct {
-	GuestIP        net.IP `yaml:"guestIP,omitempty"`
-	GuestPort      int    `yaml:"guestPort,omitempty"`
-	GuestPortRange [2]int `yaml:"guestPortRange,omitempty"`
-	HostIP         net.IP `yaml:"hostIP,omitempty"`
-	HostPort       int    `yaml:"hostPort,omitempty"`
-	HostPortRange  [2]int `yaml:"hostPortRange,omitempty"`
-	Proto          Proto  `yaml:"proto,omitempty"`
-	Ignore         bool   `yaml:"ignore,omitempty"`
+	GuestIP        net.IP `yaml:"guestIP,omitempty" json:"guestIP,omitempty"`
+	GuestPort      int    `yaml:"guestPort,omitempty" json:"guestPort,omitempty"`
+	GuestPortRange [2]int `yaml:"guestPortRange,omitempty" json:"guestPortRange,omitempty"`
+	HostIP         net.IP `yaml:"hostIP,omitempty" json:"hostIP,omitempty"`
+	HostPort       int    `yaml:"hostPort,omitempty" json:"hostPort,omitempty"`
+	HostPortRange  [2]int `yaml:"hostPortRange,omitempty" json:"hostPortRange,omitempty"`
+	Proto          Proto  `yaml:"proto,omitempty" json:"proto,omitempty"`
+	Ignore         bool   `yaml:"ignore,omitempty" json:"ignore,omitempty"`
 }
 
 type Network struct {
 	// `Lima` and `VNL` are mutually exclusive; exactly one is required
-	Lima string `yaml:"lima,omitempty"`
+	Lima string `yaml:"lima,omitempty" json:"lima,omitempty"`
 	// VNL is a Virtual Network Locator (https://github.com/rd235/vdeplug4/commit/089984200f447abb0e825eb45548b781ba1ebccd).
 	// On macOS, only VDE2-compatible form (optionally with vde:// prefix) is supported.
-	VNL        string `yaml:"vnl,omitempty"`
-	SwitchPort uint16 `yaml:"switchPort,omitempty"` // VDE Switch port, not TCP/UDP port (only used by VDE networking)
-	MACAddress string `yaml:"macAddress,omitempty"`
-	Interface  string `yaml:"interface,omitempty"`
+	VNL        string `yaml:"vnl,omitempty" json:"vnl,omitempty"`
+	SwitchPort uint16 `yaml:"switchPort,omitempty" json:"switchPort,omitempty"` // VDE Switch port, not TCP/UDP port (only used by VDE networking)
+	MACAddress string `yaml:"macAddress,omitempty" json:"macAddress,omitempty"`
+	Interface  string `yaml:"interface,omitempty" json:"interface,omitempty"`
 }
 
 // DEPRECATED types below
@@ -128,14 +129,14 @@ type Network struct {
 // and to avoid accidental usage in new code.
 
 type NetworkDeprecated struct {
-	VDEDeprecated []VDEDeprecated `yaml:"vde,omitempty"`
+	VDEDeprecated []VDEDeprecated `yaml:"vde,omitempty" json:"vde,omitempty"`
 	// migrate will be true when `network.VDE` has been copied to `networks` by FillDefaults()
 	migrated bool
 }
 
 type VDEDeprecated struct {
-	VNL        string `yaml:"vnl,omitempty"`
-	SwitchPort uint16 `yaml:"switchPort,omitempty"` // VDE Switch port, not TCP/UDP port
-	MACAddress string `yaml:"macAddress,omitempty"`
-	Name       string `yaml:"name,omitempty"`
+	VNL        string `yaml:"vnl,omitempty" json:"vnl,omitempty"`
+	SwitchPort uint16 `yaml:"switchPort,omitempty" json:"switchPort,omitempty"` // VDE Switch port, not TCP/UDP port
+	MACAddress string `yaml:"macAddress,omitempty" json:"macAddress,omitempty"`
+	Name       string `yaml:"name,omitempty" json:"name,omitempty"`
 }
diff --git a/pkg/limayaml/validate.go b/pkg/limayaml/validate.go
@@ -14,7 +14,7 @@ import (
 	"github.com/lima-vm/lima/pkg/localpathutil"
 	"github.com/lima-vm/lima/pkg/networks"
 	"github.com/lima-vm/lima/pkg/osutil"
-	"github.com/lima-vm/lima/pkg/qemu/const"
+	qemu "github.com/lima-vm/lima/pkg/qemu/const"
 	"github.com/sirupsen/logrus"
 )
 
@@ -109,6 +109,10 @@ func Validate(y LimaYAML, warn bool) error {
 				i, ProvisionModeSystem, ProvisionModeUser)
 		}
 	}
+	needsContainerdArchives := (y.Containerd.User != nil && *y.Containerd.User) || (y.Containerd.System != nil && *y.Containerd.System)
+	if needsContainerdArchives && len(y.Containerd.Archives) == 0 {
+		return fmt.Errorf("field `containerd.archives` must be provided")
+	}
 	for i, p := range y.Probes {
 		switch p.Mode {
 		case ProbeModeReadiness:
@@ -161,7 +165,7 @@ func Validate(y LimaYAML, warn bool) error {
 		// processed sequentially and the first matching rule for a guest port determines forwarding behavior.
 	}
 
-	if *y.UseHostResolver && len(y.DNS) > 0 {
+	if y.UseHostResolver != nil && *y.UseHostResolver && len(y.DNS) > 0 {
 		return fmt.Errorf("field `dns` must be empty when field `useHostResolver` is true")
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@ func newApp() *cobra.Command {`
`79`	`79`	`newSudoersCommand(),`
`80`	`80`	`newPruneCommand(),`
`81`	`81`	`newHostagentCommand(),`
	`82`	`+ newInfoCommand(),`
`82`	`83`	`)`
`83`	`84`	`return rootCmd`
`84`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import (`
`14`	`14`	`"github.com/lima-vm/lima/pkg/localpathutil"`
`15`	`15`	`"github.com/lima-vm/lima/pkg/networks"`
`16`	`16`	`"github.com/lima-vm/lima/pkg/osutil"`
`17`		`- "github.com/lima-vm/lima/pkg/qemu/const"`
	`17`	`+ qemu "github.com/lima-vm/lima/pkg/qemu/const"`
`18`	`18`	`"github.com/sirupsen/logrus"`
`19`	`19`	`)`
`20`	`20`
`@@ -109,6 +109,10 @@ func Validate(y LimaYAML, warn bool) error {`
`109`	`109`	`i, ProvisionModeSystem, ProvisionModeUser)`
`110`	`110`	`}`
`111`	`111`	`}`
	`112`	`+ needsContainerdArchives := (y.Containerd.User != nil && y.Containerd.User) \|\| (y.Containerd.System != nil && y.Containerd.System)`
	`113`	`+ if needsContainerdArchives && len(y.Containerd.Archives) == 0 {`
	`114`	+ return fmt.Errorf("field `containerd.archives` must be provided")
	`115`	`+ }`
`112`	`116`	`for i, p := range y.Probes {`
`113`	`117`	`switch p.Mode {`
`114`	`118`	`case ProbeModeReadiness:`
`@@ -161,7 +165,7 @@ func Validate(y LimaYAML, warn bool) error {`
`161`	`165`	`// processed sequentially and the first matching rule for a guest port determines forwarding behavior.`
`162`	`166`	`}`
`163`	`167`
`164`		`- if *y.UseHostResolver && len(y.DNS) > 0 {`
	`168`	`+ if y.UseHostResolver != nil && *y.UseHostResolver && len(y.DNS) > 0 {`
`165`	`169`	return fmt.Errorf("field `dns` must be empty when field `useHostResolver` is true")
`166`	`170`	`}`
`167`	`171`