feat: add presets to the 'cluster create qemu' command

* add 'iso', 'pxe', 'disk-image', 'maintenance' and 'secureboot' presets
* swith the image-factory e2e test to use the create qemu command with presets

Signed-off-by: Orzelius <[email protected]>

Author: Orzelius

cmd/talosctl/cmd/constants/constants.go

@@ -0,0 +1,13 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package constants
+
+const (
+	// ImageFactoryEmptySchematicID is the ID of an empty image factory schematic.
+	ImageFactoryEmptySchematicID = "376567988ad370138ad8b2698212367b8edcb69b5fd68c80be1f2ec7d603b4ba"
+
+	// ImageFactoryURL is the url of the Sidero hosted image factory.
+	ImageFactoryURL = "https://factory.talos.dev/"
+)

cmd/talosctl/cmd/mgmt/cluster/create/clusterops/configmaker/preset/disk_image_preset.go

@@ -0,0 +1,41 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package preset
+
+import (
+	"fmt"
+	"net/url"
+
+	"github.com/siderolabs/talos/cmd/talosctl/cmd/mgmt/cluster/create/clusterops"
+)
+
+// DiskImage configures Talos to boot from a disk image from the image factory.
+type DiskImage struct{}
+
+// Name implements the Preset interface.
+func (DiskImage) Name() string { return "disk-image" }
+
+// Description implements the Preset interface.
+func (DiskImage) Description() string {
+	return "Configure Talos to boot from a disk image from the image factory."
+}
+
+// ModifuOptions implements the Preset interface.
+func (DiskImage) ModifuOptions(presetOps Options, cOps *clusterops.Common, qOps *clusterops.Qemu) error {
+	diskImageURL, err := url.JoinPath(presetOps.ImageFactoryURL.String(), "image", presetOps.SchematicID, cOps.TalosVersion, "metal-"+qOps.TargetArch)
+	if presetOps.secureBoot {
+		diskImageURL += secureBootSuffix
+	}
+
+	diskImageURL += ".raw.zst"
+
+	if err != nil {
+		return fmt.Errorf("failed to build an image factory disk-image url: %w", err)
+	}
+
+	qOps.NodeDiskImagePath = diskImageURL
+
+	return nil
+}

cmd/talosctl/cmd/mgmt/cluster/create/clusterops/configmaker/preset/iso_preset.go

@@ -0,0 +1,41 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package preset
+
+import (
+	"fmt"
+	"net/url"
+
+	"github.com/siderolabs/talos/cmd/talosctl/cmd/mgmt/cluster/create/clusterops"
+)
+
+// ISO configures Talos to boot from an iso from the image factory.
+type ISO struct{}
+
+// Name implements the Preset interface.
+func (ISO) Name() string { return "iso" }
+
+// Description implements the Preset interface.
+func (ISO) Description() string {
+	return "Configure Talos to boot from an ISO from the image factory."
+}
+
+// ModifuOptions implements the Preset interface.
+func (ISO) ModifuOptions(presetOps Options, cOps *clusterops.Common, qOps *clusterops.Qemu) error {
+	isoURL, err := url.JoinPath(presetOps.ImageFactoryURL.String(), "image", presetOps.SchematicID, cOps.TalosVersion, "metal-"+qOps.TargetArch)
+	if err != nil {
+		return fmt.Errorf("failed to build an image factory iso url: %w", err)
+	}
+
+	if presetOps.secureBoot {
+		isoURL += secureBootSuffix
+	}
+
+	isoURL += ".iso"
+
+	qOps.NodeISOPath = isoURL
+
+	return nil
+}

cmd/talosctl/cmd/mgmt/cluster/create/clusterops/configmaker/preset/maintenance_preset.go

@@ -0,0 +1,26 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package preset
+
+import "github.com/siderolabs/talos/cmd/talosctl/cmd/mgmt/cluster/create/clusterops"
+
+// Maintenance configures Talos to boot from a disk image from the image factory.
+type Maintenance struct{}
+
+// Name implements the Preset interface.
+func (Maintenance) Name() string { return "maintenance" }
+
+// Description implements the Preset interface.
+func (Maintenance) Description() string {
+	return "Skip applying machine configuration and leave the machines in maintenance mode. The machine configuration files are written to the working path."
+}
+
+// ModifuOptions implements the Preset interface.
+func (Maintenance) ModifuOptions(presetOps Options, cOps *clusterops.Common, qOps *clusterops.Qemu) error {
+	cOps.SkipInjectingConfig = true
+	cOps.ApplyConfigEnabled = false
+
+	return nil
+}

cmd/talosctl/cmd/mgmt/cluster/create/clusterops/configmaker/preset/preset.go

@@ -0,0 +1,147 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+package preset
+
+import (
+	"errors"
+	"fmt"
+	"net/url"
+	"runtime"
+
+	"gopkg.in/typ.v4/slices"
+
+	"github.com/siderolabs/talos/cmd/talosctl/cmd/mgmt/cluster/create/clusterops"
+)
+
+const secureBootSuffix = "-secureboot"
+
+// Preset modifies cluster create options to achieve certain behavior.
+type Preset interface {
+	Name() string
+	Description() string
+
+	// ModifuOptions modifies configs to achieve the desired behavior
+	ModifuOptions(presetOps Options, cOps *clusterops.Common, qOps *clusterops.Qemu) error
+}
+
+// Options are the options required for presets to function.
+type Options struct {
+	SchematicID     string
+	ImageFactoryURL *url.URL
+
+	// secureBoot preset also affects other presets so this option needs to be shared.
+	secureBoot bool
+}
+
+// Presets is a list of all available presets.
+var Presets = [...]Preset{
+	ISO{},
+	PXE{},
+	DiskImage{},
+	Maintenance{},
+	SecureBoot{},
+}
+
+// Apply validates and applies a set of multiple presets.
+func Apply(presetOps Options, cOps *clusterops.Common, qOps *clusterops.Qemu, presetNames []string) error {
+	presets, err := slices.MapErr(presetNames, func(name string) (Preset, error) {
+		if name == (SecureBoot{}).Name() {
+			presetOps.secureBoot = true
+		}
+
+		for _, p := range Presets {
+			if p.Name() == name {
+				return p, nil
+			}
+		}
+
+		return nil, fmt.Errorf("error: unknown preset: %q", name)
+	})
+	if err != nil {
+		return err
+	}
+
+	err = Validate(presetNames, presetOps)
+	if err != nil {
+		return err
+	}
+
+	if err := applyDefaultSettings(presetOps, cOps, qOps); err != nil {
+		return err
+	}
+
+	for _, p := range presets {
+		err = p.ModifuOptions(presetOps, cOps, qOps)
+		if err != nil {
+			return fmt.Errorf("failed to apply %q preset: %w", p.Name(), err)
+		}
+	}
+
+	return nil
+}
+
+// Validate checks if the provided presets are valid and compatible.
+//
+//nolint:gocyclo
+func Validate(presetNames []string, presetOps Options) error {
+	bootMethodPresets := []string{ISO{}.Name(), PXE{}.Name(), DiskImage{}.Name()}
+
+	// check if at least one boot method preset is selected, but no more than one
+	bootMethodPresetCount := 0
+
+	for _, name := range presetNames {
+		for _, bm := range bootMethodPresets {
+			if name == bm {
+				bootMethodPresetCount++
+			}
+		}
+	}
+
+	if bootMethodPresetCount == 0 {
+		return fmt.Errorf("error: at least one boot method preset must be specified (one of %v)", bootMethodPresets)
+	}
+
+	if bootMethodPresetCount > 1 {
+		return fmt.Errorf("error: multiple boot method presets specified, please select only one (one of %v)", bootMethodPresets)
+	}
+
+	if presetOps.secureBoot && runtime.GOOS == "darwin" {
+		return errors.New("error: 'secureboot' preset is currently not supported on darwin")
+	}
+
+	// when secure boot is enabled ensure that iso preset is selected
+	if presetOps.secureBoot {
+		found := false
+		isoPresetName := ISO{}.Name()
+
+		for _, name := range presetNames {
+			if name == isoPresetName {
+				found = true
+			}
+		}
+
+		if !found {
+			return fmt.Errorf("error: secureboot preset can only be used with the iso preset")
+		}
+	}
+
+	return nil
+}
+
+func applyDefaultSettings(presetOps Options, cOps *clusterops.Common, qOps *clusterops.Qemu) error {
+	installerName := "metal-installer"
+	if presetOps.secureBoot {
+		installerName += secureBootSuffix
+	}
+
+	installerURL, err := url.JoinPath(presetOps.ImageFactoryURL.Host, installerName, presetOps.SchematicID+":"+cOps.TalosVersion)
+	if err != nil {
+		return fmt.Errorf("failed to build installer image URL: %w", err)
+	}
+
+	qOps.NodeInstallImage = installerURL
+
+	return nil
+}