manifest: implement OSTreeDeployment pipeline

New pipeline for creating an ostree commit deployment.
Heavily based on the ostreeDeployPipeline from RHEL 9.x.

Co-Authored-By: Ondřej Budai <ondrej@budai.cz>

internal/manifest/commit_deployment.go

@@ -0,0 +1,179 @@
+package manifest
+
+import (
+	"os"
+
+	"github.com/osbuild/osbuild-composer/internal/common"
+	"github.com/osbuild/osbuild-composer/internal/disk"
+	"github.com/osbuild/osbuild-composer/internal/osbuild"
+	"github.com/osbuild/osbuild-composer/internal/platform"
+)
+
+// OSTreeDeployment represents the filesystem tree of a target image based
+// on a deployed ostree commit.
+type OSTreeDeployment struct {
+	Base
+	OSVersion string
+
+	osTreeCommit string
+	osTreeURL    string
+	osTreeRef    string
+
+	osName   string
+	remote   string
+	platform platform.Platform
+
+	PartitionTable *disk.PartitionTable
+}
+
+// NewOSTreeDeployment creates a pipeline for an ostree deployment from a
+// commit.
+func NewOSTreeDeployment(m *Manifest,
+	buildPipeline *Build,
+	ref string,
+	commit string,
+	url string,
+	osName string,
+	remote string,
+	platform platform.Platform) *OSTreeDeployment {
+
+	p := &OSTreeDeployment{
+		Base:         NewBase(m, "image-tree", buildPipeline),
+		osTreeCommit: commit,
+		osTreeURL:    url,
+		osTreeRef:    ref,
+		osName:       osName,
+		remote:       remote,
+		platform:     platform,
+	}
+	buildPipeline.addDependent(p)
+	m.addPipeline(p)
+	return p
+}
+
+func (p *OSTreeDeployment) getBuildPackages() []string {
+	packages := []string{
+		"rpm-ostree",
+	}
+	return packages
+}
+
+func (p *OSTreeDeployment) getOSTreeCommits() []osTreeCommit {
+	return []osTreeCommit{
+		{
+			checksum: p.osTreeCommit,
+			url:      p.osTreeURL,
+		},
+	}
+}
+
+func (p *OSTreeDeployment) serialize() osbuild.Pipeline {
+	const repoPath = "/ostree/repo"
+
+	pipeline := p.Base.serialize()
+
+	pipeline.AddStage(osbuild.OSTreeInitFsStage())
+	pipeline.AddStage(osbuild.NewOSTreePullStage(
+		&osbuild.OSTreePullStageOptions{Repo: repoPath, Remote: p.remote},
+		osbuild.NewOstreePullStageInputs("org.osbuild.source", p.osTreeCommit, p.osTreeRef),
+	))
+	pipeline.AddStage(osbuild.NewOSTreeOsInitStage(
+		&osbuild.OSTreeOsInitStageOptions{
+			OSName: p.osName,
+		},
+	))
+	pipeline.AddStage(osbuild.NewOSTreeConfigStage(
+		&osbuild.OSTreeConfigStageOptions{
+			Repo: repoPath,
+			Config: &osbuild.OSTreeConfig{
+				Sysroot: &osbuild.SysrootOptions{
+					ReadOnly:   common.BoolToPtr(true),
+					Bootloader: "none",
+				},
+			},
+		},
+	))
+	pipeline.AddStage(osbuild.NewMkdirStage(&osbuild.MkdirStageOptions{
+		Paths: []osbuild.Path{
+			{
+				Path: "/boot/efi",
+				Mode: os.FileMode(0700),
+			},
+		},
+	}))
+	kernelOpts := osbuild.GenImageKernelOptions(p.PartitionTable)
+	pipeline.AddStage(osbuild.NewOSTreeDeployStage(
+		&osbuild.OSTreeDeployStageOptions{
+			OsName: p.osName,
+			Ref:    p.osTreeRef,
+			Remote: p.remote,
+			Mounts: []string{"/boot", "/boot/efi"},
+			Rootfs: osbuild.Rootfs{
+				Label: "root",
+			},
+			KernelOpts: kernelOpts,
+		},
+	))
+
+	if p.osTreeURL != "" { // TODO: this should never be empty; fail early instead
+		pipeline.AddStage(osbuild.NewOSTreeRemotesStage(
+			&osbuild.OSTreeRemotesStageOptions{
+				Repo: "/ostree/repo",
+				Remotes: []osbuild.OSTreeRemote{
+					{
+						Name: p.remote,
+						URL:  p.osTreeURL,
+					},
+				},
+			},
+		))
+	}
+
+	pipeline.AddStage(osbuild.NewOSTreeFillvarStage(
+		&osbuild.OSTreeFillvarStageOptions{
+			Deployment: osbuild.OSTreeDeployment{
+				OSName: p.osName,
+				Ref:    p.osTreeRef,
+			},
+		},
+	))
+
+	fstabOptions := osbuild.NewFSTabStageOptions(p.PartitionTable)
+	fstabOptions.OSTree = &osbuild.OSTreeFstab{
+		Deployment: osbuild.OSTreeDeployment{
+			OSName: p.osName,
+			Ref:    p.osTreeRef,
+		},
+	}
+	pipeline.AddStage(osbuild.NewFSTabStage(fstabOptions))
+
+	// TODO: Add users?
+	// NOTE: Users can be embedded in a commit, but we should also support adding them at deploy time.
+
+	var bootloader *osbuild.Stage
+	switch p.platform.GetArch() {
+	case platform.ARCH_S390X:
+		bootloader = osbuild.NewZiplStage(new(osbuild.ZiplStageOptions))
+	default:
+		options := osbuild.NewGrub2StageOptionsUnified(p.PartitionTable,
+			"",
+			p.platform.GetUEFIVendor() != "",
+			p.platform.GetBIOSPlatform(),
+			p.platform.GetUEFIVendor(), true)
+		options.Greenboot = true
+		bootloader = osbuild.NewGRUB2Stage(options)
+	}
+
+	pipeline.AddStage(bootloader)
+
+	pipeline.AddStage(osbuild.NewOSTreeSelinuxStage(
+		&osbuild.OSTreeSelinuxStageOptions{
+			Deployment: osbuild.OSTreeDeployment{
+				OSName: p.osName,
+				Ref:    p.osTreeRef,
+			},
+		},
+	))
+
+	return pipeline
+}