pkg

Mar 4, 2026

Changes in this version

type WorkflowState

+ Progress reporter.Reporter

Feb 25, 2026

Changes in this version

+ func ExtractAndVerifyContainer(ctx context.Context, imageRef, localLayoutPath, mountPoint string, ...) error

+ func SetupTargetSystem(ctx context.Context, mountPoint string, dryRun, verbose bool, ...) error

type ImageCache

+ Progress Reporter

+ type JSONReporter struct

+ func NewJSONReporter(w io.Writer) *JSONReporter

+ func (r *JSONReporter) Complete(message string, details any)

+ func (r *JSONReporter) Error(err error, message string)

+ func (r *JSONReporter) IsJSON() bool

+ func (r *JSONReporter) Message(format string, args ...any)

+ func (r *JSONReporter) MessagePlain(format string, args ...any)

+ func (r *JSONReporter) Progress(percent int, message string)

+ func (r *JSONReporter) Step(step, total int, name string)

+ func (r *JSONReporter) Warning(format string, args ...any)

+ type NoopReporter struct

+ func (NoopReporter) Complete(string, any)

+ func (NoopReporter) Error(error, string)

+ func (NoopReporter) IsJSON() bool

+ func (NoopReporter) Message(string, ...any)

+ func (NoopReporter) MessagePlain(string, ...any)

+ func (NoopReporter) Progress(int, string)

+ func (NoopReporter) Step(int, int, string)

+ func (NoopReporter) Warning(string, ...any)

+ type Reporter interface

+ Complete func(message string, details any)

+ Error func(err error, message string)

+ IsJSON func() bool

+ Message func(format string, args ...any)

+ MessagePlain func(format string, args ...any)

+ Progress func(percent int, message string)

+ Step func(step, total int, name string)

+ Warning func(format string, args ...any)

+ type StepFunc func(ctx context.Context, state *WorkflowState) error

+ type TextReporter struct

+ func NewTextReporter(w io.Writer) *TextReporter

+ func (r *TextReporter) Complete(message string, _ any)

+ func (r *TextReporter) Error(err error, message string)

+ func (r *TextReporter) IsJSON() bool

+ func (r *TextReporter) Message(format string, args ...any)

+ func (r *TextReporter) MessagePlain(format string, args ...any)

+ func (r *TextReporter) Progress(_ int, message string)

+ func (r *TextReporter) Step(step, total int, name string)

+ func (r *TextReporter) Warning(format string, args ...any)

+ type Workflow struct

+ func NewWorkflow(reporter Reporter) *Workflow

+ func (w *Workflow) AddStep(name string, fn StepFunc)

+ func (w *Workflow) Run(ctx context.Context, state *WorkflowState) error

+ type WorkflowState struct

+ Device string

+ DryRun bool

+ Encrypted bool

+ FilesystemType string

+ ImageDigest string

+ ImageRef string

+ KernelArgs []string

+ MountPoint string

+ Passphrase string

+ Reporter Reporter

+ Scheme *PartitionScheme

+ TPM2 bool

+ Verbose bool

Jan 28, 2026

Changes in this version

+ const RebootRequiredMarker

+ func IsRebootRequired() bool

+ func WriteRebootRequiredMarker(info *RebootPendingInfo) error

+ type RebootPendingInfo struct

+ PendingImageDigest string

+ PendingImageRef string

+ TargetPartition string

+ UpdateTime string

+ func ReadRebootRequiredMarker() (*RebootPendingInfo, error)

Jan 21, 2026

Changes in this version

+ func PullImage(ctx context.Context, imageRef string, verbose bool, progress *ProgressReporter) error

type BootloaderInstaller

+ Progress *ProgressReporter

+ func (b *BootloaderInstaller) SetProgress(p *ProgressReporter)

type ContainerExtractor

+ func (c *ContainerExtractor) SetProgress(p *ProgressReporter)

+ type EncryptionOptions struct

+ Passphrase string

+ TPM2 bool

+ type InstallCallbacks struct

+ OnError func(err error, message string)

+ OnMessage func(message string)

+ OnProgress func(percent int, message string)

+ OnStep func(step, totalSteps int, name string)

+ OnWarning func(message string)

+ func CreateCLICallbacks(jsonOutput bool) *InstallCallbacks

+ type InstallConfig struct

+ Device string

+ DryRun bool

+ Encryption *EncryptionOptions

+ FilesystemType string

+ ImageRef string

+ JSONOutput bool

+ KernelArgs []string

+ LocalImage *LocalImageSource

+ Loopback *LoopbackOptions

+ MountPoint string

+ RootPassword string

+ SkipPull bool

+ Verbose bool

+ func (c *InstallConfig) Validate() error

+ type InstallResult struct

+ BootloaderType BootloaderType

+ Cleanup func() error

+ Device string

+ Duration time.Duration

+ FilesystemType string

+ ImageDigest string

+ ImageRef string

+ LoopbackPath string

+ type Installer struct

+ func NewInstaller(cfg *InstallConfig) (*Installer, error)

+ func (i *Installer) Install(ctx context.Context) (*InstallResult, error)

+ func (i *Installer) SetCallbacks(cb *InstallCallbacks)

+ type LocalImageSource struct

+ LayoutPath string

+ Metadata *CachedImageMetadata

+ type LoopbackOptions struct

+ Force bool

+ ImagePath string

+ SizeGB int

Jan 7, 2026

Changes in this version

+ const CacheLockFile

+ const DefaultLoopbackSizeGB

+ const LegacyOverlayUpperNbc

+ const LegacySystemConfigDir

+ const LegacySystemConfigFile

+ const LockDir

+ const MinLoopbackSizeGB

+ const SystemLockFile

+ var ErrLockHeld = errors.New("lock held by another process")

+ func AttachLoopback(imagePath string) (string, error)

+ func CacheLockPath() string

+ func CreateLoopbackFile(imagePath string, sizeGB int, force bool) error

+ func DetachLoopback(device string) error

+ func GetDiskID(device string) (string, error)

+ func InstallDracutEtcOverlay(targetDir string, dryRun bool) error

+ func IsRootMountedReadOnly() string

+ func IsTPMAvailable() bool

+ func ParseSizeGB(sizeStr string) (int, error)

+ func PopulateEtcLower(targetDir string, dryRun bool, progress *ProgressReporter) error

+ func PrepareMachineID(targetDir string, progress *ProgressReporter) error

+ func SetRootPasswordInTarget(targetDir, password string, dryRun bool) error

+ func SystemLockPath() string

+ func VerifyDiskID(device, expectedDiskID string) (bool, error)

+ func WriteSystemConfigToVar(varMountPoint string, config *SystemConfig, dryRun bool, ...) error

type BootcInstaller

+ RootPassword string

+ func (b *BootcInstaller) SetRootPassword(password string)

type ContainerExtractor

+ JSONOutput bool

+ Progress *ProgressReporter

+ func (c *ContainerExtractor) SetJSONOutput(jsonOutput bool)

+ type FileLock struct

+ func AcquireCacheLock() (*FileLock, error)

+ func AcquireCacheLockShared() (*FileLock, error)

+ func AcquireExclusive(lockPath string) (*FileLock, error)

+ func AcquireShared(lockPath string) (*FileLock, error)

+ func AcquireSystemLock() (*FileLock, error)

+ func (l *FileLock) Path() string

+ func (l *FileLock) Release() error

+ type LoopbackDevice struct

+ Device string

+ ImagePath string

+ SizeGB int

+ func SetupLoopbackInstall(imagePath string, sizeGB int, force bool) (*LoopbackDevice, error)

+ func (l *LoopbackDevice) Cleanup() error

type SystemConfig

+ DiskID string

Dec 25, 2025

Changes in this version

+ const MetadataFileName

+ const StagedInstallDir

+ const StagedUpdateDir

+ func LoadImageFromOCILayout(layoutPath string) (v1.Image, error)

type BootcInstaller

+ LocalLayoutPath string

+ LocalMetadata *CachedImageMetadata

+ func (b *BootcInstaller) SetLocalImage(layoutPath string, metadata *CachedImageMetadata)

+ type CachedImageMetadata struct

+ Architecture string

+ DownloadDate string

+ ImageDigest string

+ ImageRef string

+ Labels map[string]string

+ OSReleaseID string

+ OSReleasePrettyName string

+ OSReleaseVersionID string

+ SizeBytes int64

+ func GetImageByPath(layoutPath string) (v1.Image, *CachedImageMetadata, error)

type ContainerExtractor

+ LocalLayoutPath string

+ func NewContainerExtractorFromLocal(layoutPath, targetDir string) *ContainerExtractor

+ type ImageCache struct

+ CacheDir string

+ Verbose bool

+ func NewImageCache(cacheDir string) *ImageCache

+ func NewStagedInstallCache() *ImageCache

+ func NewStagedUpdateCache() *ImageCache

+ func (c *ImageCache) Clear() error

+ func (c *ImageCache) Download(imageRef string) (*CachedImageMetadata, error)

+ func (c *ImageCache) GetImage(digestOrRef string) (v1.Image, *CachedImageMetadata, error)

+ func (c *ImageCache) GetLayoutPath(digest string) string

+ func (c *ImageCache) GetSingle() (*CachedImageMetadata, error)

+ func (c *ImageCache) IsCached(digest string) (bool, error)

+ func (c *ImageCache) List() ([]CachedImageMetadata, error)

+ func (c *ImageCache) Remove(digestOrPrefix string) error

+ func (c *ImageCache) SetVerbose(verbose bool)

type SystemUpdater

+ LocalLayoutPath string

+ LocalMetadata *CachedImageMetadata

+ func (u *SystemUpdater) SetLocalImage(layoutPath string, metadata *CachedImageMetadata)

Dec 24, 2025

Changes in this version

+ func VerifyExtraction(targetDir string) error

Dec 24, 2025

Changes in this version

+ func InitramfsHasEtcOverlay(initramfsPath string) (bool, error)

Dec 24, 2025

Changes in this version

+ func IsRunningInContainer() bool

type LintIssue

+ Fixed bool

type LintResult

+ FixedCount int

type Linter

+ func (l *Linter) SetFix(fix bool)

Dec 23, 2025

Changes in this version

+ type LintCheck func(rootDir string) []LintIssue

+ type LintIssue struct

+ Check string

+ Message string

+ Path string

+ Severity LintSeverity

+ func CheckMachineID(rootDir string) []LintIssue

+ func CheckRandomSeed(rootDir string) []LintIssue

+ func CheckSSHHostKeys(rootDir string) []LintIssue

+ type LintResult struct

+ ErrorCount int

+ Issues []LintIssue

+ WarnCount int

+ type LintSeverity string

+ const SeverityError

+ const SeverityWarning

+ type Linter struct

+ func NewLinter() *Linter

+ func (l *Linter) Lint(rootDir string) *LintResult

+ func (l *Linter) LintContainerImage(imageRef string) (*LintResult, error)

+ func (l *Linter) RegisterCheck(check LintCheck)

+ func (l *Linter) RegisterDefaultChecks()

+ func (l *Linter) SetQuiet(quiet bool)

+ func (l *Linter) SetVerbose(verbose bool)

Dec 23, 2025

Changes in this version

+ func EnsureCriticalFilesInOverlay(dryRun bool) error

Dec 23, 2025

Changes in this version

type LUKSDevice

+ func TryTPM2Unlock(partition, mapperName string) (*LUKSDevice, error)

Dec 23, 2025

Changes in this version

+ const NBCTmpfilesConfig

+ func InstallTmpfilesConfig(targetDir string, dryRun bool) error

Dec 23, 2025

Changes in this version

+ const EtcOverlayPath

+ const NBCBootedMarker

+ func IsNBCBooted() bool

+ func RegenerateInitramfs(targetDir string, dryRun bool, verbose bool) error

+ func SetupEtcOverlay(targetDir string, dryRun bool) error

+ func VerifyDracutEtcOverlay(targetDir string, dryRun bool) error

Dec 22, 2025

Changes in this version

type SystemUpdater

+ TargetMapperName string

+ TargetMapperPath string

Dec 22, 2025

Changes in this version

+ type EncryptionConfig struct

+ Enabled bool

+ Root1LUKSUUID string

+ Root2LUKSUUID string

+ TPM2 bool

+ VarLUKSUUID string

type SystemConfig

+ Encryption *EncryptionConfig

type SystemUpdater

+ Encryption *EncryptionConfig

Dec 22, 2025

Changes in this version

type LUKSConfig

+ Keyfile string

Dec 22, 2025

Changes in this version

+ func CloseLUKS(mapperName string) error

+ func CreateLUKSContainer(partition, passphrase string) error

+ func EnrollTPM2(partition, passphrase string) error

+ func GenerateCrypttab(devices []*LUKSDevice, tpm2Enabled bool) string

+ func GetLUKSUUID(partition string) (string, error)

+ func SetupLUKS(scheme *PartitionScheme, passphrase string, dryRun bool) error

+ func ValidateInitramfsSupport(targetDir string, tpm2Enabled bool) []string

type BootcInstaller

+ Encryption *LUKSConfig

+ func (b *BootcInstaller) SetEncryption(passphrase string, tpm2 bool)

type BootloaderInstaller

+ Encryption *LUKSConfig

+ func (b *BootloaderInstaller) SetEncryption(config *LUKSConfig)

+ type LUKSConfig struct

+ Enabled bool

+ Passphrase string

+ TPM2 bool

+ type LUKSDevice struct

+ LUKSUUID string

+ MapperName string

+ MapperPath string

+ Partition string

+ func OpenLUKS(partition, mapperName, passphrase string) (*LUKSDevice, error)

type PartitionScheme

+ Encrypted bool

+ LUKSDevices []*LUKSDevice

+ func (s *PartitionScheme) CloseLUKSDevices()

+ func (s *PartitionScheme) GetLUKSDevice(mapperName string) *LUKSDevice

+ func (s *PartitionScheme) GetRoot1Device() string

+ func (s *PartitionScheme) GetRoot2Device() string

+ func (s *PartitionScheme) GetVarDevice() string

Dec 20, 2025

Changes in this version

type BootcInstaller

+ JSONOutput bool

+ Progress *ProgressReporter

+ func (b *BootcInstaller) SetJSONOutput(jsonOutput bool)

+ type EventType string

+ const EventTypeComplete

+ const EventTypeError

+ const EventTypeMessage

+ const EventTypeProgress

+ const EventTypeStep

+ const EventTypeWarning

+ type ProgressEvent struct

+ Details any

+ Message string

+ Percent int

+ Step int

+ StepName string

+ Timestamp string

+ TotalSteps int

+ Type EventType

+ type ProgressReporter struct

+ func NewProgressReporter(jsonEnabled bool, totalSteps int) *ProgressReporter

+ func (p *ProgressReporter) Complete(message string, details any)

+ func (p *ProgressReporter) Error(err error, message string)

+ func (p *ProgressReporter) IsJSON() bool

+ func (p *ProgressReporter) Message(format string, args ...any)

+ func (p *ProgressReporter) MessagePlain(format string, args ...any)

+ func (p *ProgressReporter) Progress(percent int, message string)

+ func (p *ProgressReporter) Step(step int, name string)

+ func (p *ProgressReporter) Warning(format string, args ...any)

type SystemUpdater

+ Progress *ProgressReporter

+ func (u *SystemUpdater) SetJSONOutput(jsonOutput bool)

type UpdaterConfig

+ JSONOutput bool

Dec 20, 2025

Changes in this version

+ const PristineEtcPath

+ const SystemConfigDir

+ const SystemConfigFile

+ const VarEtcPath

+ func CheckRequiredTools() error

+ func CheckUpdateNeeded(installedDigest, remoteDigest string) bool

+ func ChrootCommand(targetDir string, command string, args ...string) error

+ func CreateFstab(targetDir string, scheme *PartitionScheme) error

+ func FormatPartitions(scheme *PartitionScheme, dryRun bool) error

+ func FormatSize(bytes uint64) string

+ func GetActiveRootPartition() (string, error)

+ func GetBootDeviceFromPartition(partition string) (string, error)

+ func GetCurrentBootDevice() (string, error)

+ func GetCurrentBootDeviceInfo(verbose bool) (string, error)

+ func GetDiskByPath(path string) (string, error)

+ func GetInactiveRootPartition(scheme *PartitionScheme) (string, bool, error)

+ func GetPartitionUUID(partition string) (string, error)

+ func GetRemoteImageDigest(imageRef string) (string, error)

+ func InstallEtcMountUnit(targetDir string, dryRun bool) error

+ func IsBlockDevice(path string) bool

+ func MergeEtcFromActive(targetDir string, activeRootPartition string, dryRun bool) error

+ func MountPartitions(scheme *PartitionScheme, mountPoint string, dryRun bool) error

+ func ParseDeviceName(device string) (string, error)

+ func ParseOSRelease(targetDir string) string

+ func SavePristineEtc(targetDir string, dryRun bool) error

+ func SetupEtcPersistence(targetDir string, dryRun bool) error

+ func SetupSystemDirectories(targetDir string) error

+ func UnmountPartitions(mountPoint string, dryRun bool) error

+ func UpdateSystemConfigImageRef(imageRef, imageDigest string, dryRun bool) error

+ func ValidateDisk(device string, minSize uint64) error

+ func WipeDisk(device string, dryRun bool) error

+ func WriteSystemConfig(config *SystemConfig, dryRun bool) error

+ func WriteSystemConfigToTarget(targetDir string, config *SystemConfig, dryRun bool) error

+ type BootcInstaller struct

+ Device string

+ DryRun bool

+ FilesystemType string

+ ImageRef string

+ KernelArgs []string

+ MountPoint string

+ Verbose bool

+ func NewBootcInstaller(imageRef, device string) *BootcInstaller

+ func (b *BootcInstaller) AddKernelArg(arg string)

+ func (b *BootcInstaller) Install() error

+ func (b *BootcInstaller) InstallComplete(skipPull bool) error

+ func (b *BootcInstaller) PullImage() error

+ func (b *BootcInstaller) SetDryRun(dryRun bool)

+ func (b *BootcInstaller) SetFilesystemType(fsType string)

+ func (b *BootcInstaller) SetMountPoint(mountPoint string)

+ func (b *BootcInstaller) SetVerbose(verbose bool)

+ func (b *BootcInstaller) Verify() error

+ type BootloaderInstaller struct

+ Device string

+ KernelArgs []string

+ OSName string

+ Scheme *PartitionScheme

+ TargetDir string

+ Type BootloaderType

+ Verbose bool

+ func NewBootloaderInstaller(targetDir, device string, scheme *PartitionScheme, osName string) *BootloaderInstaller

+ func (b *BootloaderInstaller) AddKernelArg(arg string)

+ func (b *BootloaderInstaller) Install() error

+ func (b *BootloaderInstaller) SetType(t BootloaderType)

+ func (b *BootloaderInstaller) SetVerbose(verbose bool)

+ type BootloaderType string

+ const BootloaderGRUB2

+ const BootloaderSystemdBoot

+ func DetectBootloader(targetDir string) BootloaderType

+ type ContainerExtractor struct

+ ImageRef string

+ TargetDir string

+ Verbose bool

+ func NewContainerExtractor(imageRef, targetDir string) *ContainerExtractor

+ func (c *ContainerExtractor) Extract() error

+ func (c *ContainerExtractor) SetVerbose(verbose bool)

+ type DiskInfo struct

+ Device string

+ IsRemovable bool

+ Model string

+ Partitions []PartitionInfo

+ Size uint64

+ func ListDisks() ([]DiskInfo, error)

+ type FilesystemType string

+ const FilesystemBtrfs

+ const FilesystemExt4

+ type PartitionInfo struct

+ Device string

+ FileSystem string

+ MountPoint string

+ Size uint64

+ type PartitionScheme struct

+ BootPartition string

+ FilesystemType string

+ Root1Partition string

+ Root2Partition string

+ VarPartition string

+ func CreatePartitions(device string, dryRun bool) (*PartitionScheme, error)

+ func DetectExistingPartitionScheme(device string) (*PartitionScheme, error)

+ type SystemConfig struct

+ BootloaderType string

+ Device string

+ FilesystemType string

+ ImageDigest string

+ ImageRef string

+ InstallDate string

+ KernelArgs []string

+ func ReadSystemConfig() (*SystemConfig, error)

+ type SystemUpdater struct

+ Active bool

+ Config UpdaterConfig

+ Scheme *PartitionScheme

+ Target string

+ func NewSystemUpdater(device, imageRef string) *SystemUpdater

+ func (u *SystemUpdater) AddKernelArg(arg string)

+ func (u *SystemUpdater) InstallKernelAndInitramfs() error

+ func (u *SystemUpdater) IsUpdateNeeded() (bool, string, error)

+ func (u *SystemUpdater) PerformUpdate(skipPull bool) error

+ func (u *SystemUpdater) PrepareUpdate() error

+ func (u *SystemUpdater) PullImage() error

+ func (u *SystemUpdater) SetDryRun(dryRun bool)

+ func (u *SystemUpdater) SetForce(force bool)

+ func (u *SystemUpdater) SetVerbose(verbose bool)

+ func (u *SystemUpdater) Update() error

+ func (u *SystemUpdater) UpdateBootloader() error

+ type UpdaterConfig struct

+ BootMountPoint string

+ Device string

+ DryRun bool

+ FilesystemType string

+ Force bool

+ ImageDigest string

+ ImageRef string

+ KernelArgs []string

+ MountPoint string

+ Verbose bool