manifest

type AnacondaInstaller struct {
	Base

	// The type of the Anaconda installer tree to prepare, this can be either
	// a 'live' or a 'payload' and it controls which stages are added to the
	// manifest.
	Type AnacondaInstallerType

	// Packages to install and/or exclude in addition to the ones required by the
	// pipeline.
	ExtraPackages   []string
	ExcludePackages []string

	// Extra repositories to install packages from
	ExtraRepos []rpmmd.RepoConfig

	// Biosdevname indicates whether or not biosdevname should be used to
	// name network devices when booting the installer. This may affect
	// the naming of network devices on the target system.
	Biosdevname bool

	// Variant is the variant of the product being installed, if applicable.
	Variant string

	// Interactive defaults is a kickstart stage that can be provided, it
	// will be written to /usr/share/anaconda/interactive-defaults
	InteractiveDefaults *AnacondaInteractiveDefaults

	// Kickstart options that will be written to the interactive defaults
	// kickstart file. Currently only supports Users and Groups. Other
	// properties are ignored.
	InteractiveDefaultsKickstart *kickstart.Options

	// Additional anaconda modules to enable
	AdditionalAnacondaModules []string
	// Anaconda modules to explicitly disable
	DisabledAnacondaModules []string

	// Additional dracut modules and drivers to enable
	AdditionalDracutModules []string
	AdditionalDrivers       []string

	Files []*fsnode.File

	// Temporary
	UseRHELLoraxTemplates bool

	// Uses the old, deprecated, Anaconda config option "kickstart-modules".
	// Only for RHEL 8.
	UseLegacyAnacondaConfig bool

	// SELinux policy, when set it enables the labeling of the installer
	// tree with the selected profile and selects the required package
	// for depsolving
	SELinux string

	// Locale for the installer. This should be set to the same locale as the
	// ISO OS payload, if known.
	Locale string
	// contains filtered or unexported fields
}

type AnacondaInstallerISOTree struct {
	Base

	// TODO: review optional and mandatory fields and their meaning
	Release string

	PartitionTable *disk.PartitionTable

	// The path where the payload (tarball, ostree repo, or container) will be stored.
	PayloadPath string

	// If set the skopeo stage will remove signatures during copy
	PayloadRemoveSignatures bool

	RootfsCompression string
	RootfsType        RootfsType

	OSPipeline         *OS
	OSTreeCommitSource *ostree.SourceSpec

	ContainerSource *container.SourceSpec

	// Kernel options for the ISO image
	KernelOpts []string

	// ISOBoot selects the type of boot support on the iso
	ISOBoot ISOBootType

	Kickstart *kickstart.Options

	Files []*fsnode.File

	// Pipeline object where subscription-related files are created for copying
	// onto the ISO.
	SubscriptionPipeline *Subscription

	InstallRootfsType disk.FSType
	// contains filtered or unexported fields
}

type AnacondaInstallerType int

type AnacondaInteractiveDefaults struct {
	TarPath string
}

type Base struct {
	// contains filtered or unexported fields
}

type Build interface {
	Name() string
	Checkpoint()
	Manifest() *Manifest
	// contains filtered or unexported methods
}

type BuildOptions struct {
	// ContainerBuildable tweaks the buildroot to be container friendly,
	// i.e. to not rely on an installed osbuild-selinux
	ContainerBuildable bool

	// DisableSELinux disables SELinux, this is not advised, but is
	// currently needed when using (experimental) cross-arch building.
	DisableSELinux bool

	// The SELinux policy to use in the buildroot, defaults to 'targeted' if not specified
	SELinuxPolicy string

	// BootstrapPipeline add the given bootstrap pipeline to the
	// build pipeline. This is only needed when doing cross-arch
	// building
	BootstrapPipeline Build

	// In some cases we have multiple build pipelines
	PipelineName string

	// Copy in files from other pipeline
	CopyFilesFrom map[string][]string

	// Ensure directories exist
	EnsureDirs []*fsnode.Directory
}

type BuildrootFromContainer struct {
	Base
	// contains filtered or unexported fields
}

type BuildrootFromPackages struct {
	Base
	// contains filtered or unexported fields
}

type ContentTest struct {
	Base
	// contains filtered or unexported fields
}

type CoreOSISOTree struct {
	Base

	// TODO: review optional and mandatory fields and their meaning
	OSName  string
	Release string
	Users   []users.User
	Groups  []users.Group

	PartitionTable *disk.PartitionTable

	// The path where the payload (tarball or ostree repo) will be stored.
	PayloadPath string

	// Enable ISOLinux stage
	ISOLinux bool

	KernelOpts []string
	// contains filtered or unexported fields
}

type CoreOSInstaller struct {
	Base

	// Packages to install or exclude in addition to the ones required by the
	// pipeline.
	ExtraPackages   []string
	ExcludePackages []string

	// Extra repositories to install packages from
	ExtraRepos []rpmmd.RepoConfig

	Variant string

	// Biosdevname indicates whether or not biosdevname should be used to
	// name network devices when booting the installer. This may affect
	// the naming of network devices on the target system.
	Biosdevname bool

	FDO *fdo.Options

	// For the coreos-installer we only have EmbeddedOptions for ignition
	Ignition *ignition.EmbeddedOptions

	AdditionalDracutModules []string
	AdditionalDrivers       []string
	// contains filtered or unexported fields
}

type Distro uint64

type EFIBootTree struct {
	Base

	Platform platform.Platform

	UEFIVendor string
	ISOLabel   string

	KernelOpts []string
	// contains filtered or unexported fields
}

type FilePipeline interface {
	Pipeline
	Filename() string
	SetFilename(fname string)
}

type Gzip struct {
	Base
	// contains filtered or unexported fields
}

type ISO struct {
	Base
	ISOBoot ISOBootType
	// contains filtered or unexported fields
}

type ISOBootType uint64

type ISORootfsImg struct {
	Base

	Size uint64
	// contains filtered or unexported fields
}

type Inputs osbuild.SourceInputs

type Manifest struct {

	// Distro defines the distribution of the image that this manifest will
	// generate. It is used for determining package names that differ between
	// different distributions and version.
	Distro Distro

	// DistroBootstrapRef defines if a bootstrap container should be used
	// to generate the buildroot
	// XXX: ideally we would have "Distro distro.Distro" here and a
	// "BoostrapContainerRef()" method on this but we cannot because of
	// circular imports so we use the same workaround as Distro above.
	DistroBootstrapRef string
	// contains filtered or unexported fields
}

type OCIContainer struct {
	Base

	Cmd          []string
	ExposedPorts []string
	// contains filtered or unexported fields
}

type OS struct {
	Base

	// OSCustomizations to apply to the base OS
	OSCustomizations OSCustomizations

	// Environment the system will run in
	Environment environment.Environment
	// Workload to install on top of the base system
	Workload workload.Workload
	// Ref of ostree commit (optional). If empty the tree cannot be in an ostree commit
	OSTreeRef string
	// OSTreeParent source spec (optional). If nil the new commit (if
	// applicable) will have no parent
	OSTreeParent *ostree.SourceSpec
	// Enabling Bootupd runs bootupctl generate-update-metadata in the tree to
	// transform /usr/lib/ostree-boot into a bootupd-compatible update
	// payload. Only works with ostree-based images.
	Bootupd bool

	// Add a bootc config file to the image (for bootable containers)
	BootcConfig *bootc.Config

	// Partition table, if nil the tree cannot be put on a partitioned disk
	PartitionTable *disk.PartitionTable

	OSProduct string
	OSVersion string
	OSNick    string
	// contains filtered or unexported fields
}

type OSBuildManifest []byte

type OSCustomizations struct {

	// Packages to install in addition to the ones required by the pipeline.
	// These are the statically defined packages for the image type.
	BasePackages []string

	// Packages to exclude from the base package set. This is useful in
	// case of weak dependencies, comps groups, or where multiple packages
	// can satisfy a dependency. Must not conflict with the included base
	// package set.
	ExcludeBasePackages []string

	// Additional repos to install the base packages from.
	ExtraBaseRepos []rpmmd.RepoConfig

	// Containers to embed in the image (source specification)
	// TODO: move to workload
	Containers []container.SourceSpec

	// KernelName indicates that a kernel is installed, and names the kernel
	// package.
	KernelName string

	// KernelOptionsAppend are appended to the kernel commandline
	KernelOptionsAppend []string

	// KernelOptionsBootloader controls whether kernel command line options
	// should be specified in the bootloader grubenv configuration. Otherwise
	// they are specified in /etc/kernel/cmdline (default).
	//
	// NB: The kernel options need to be still specified in /etc/default/grub
	// under the GRUB_CMDLINE_LINUX variable. The reason is that it is used by
	// the 10_linux script executed by grub2-mkconfig to override the kernel
	// options in /etc/kernel/cmdline if the file has older timestamp than
	// /etc/default/grub.
	//
	// This should only be used for RHEL 8 and CentOS 8 images that use grub
	// (non s390x).  Newer releases (9+) should keep this disabled.
	KernelOptionsBootloader bool

	GPGKeyFiles      []string
	Language         string
	Keyboard         *string
	X11KeymapLayouts []string
	Hostname         string
	Timezone         string
	EnabledServices  []string
	DisabledServices []string
	MaskedServices   []string
	DefaultTarget    string

	// SELinux policy, when set it enables the labeling of the
	// tree with the selected profile
	SELinux string
	// BuildSELinux policy, when set it enables the labeling of
	// the *build tree* with the selected profile
	BuildSELinux string

	SELinuxForceRelabel *bool

	// Do not install documentation
	ExcludeDocs bool

	Groups []users.Group
	Users  []users.User

	ShellInit []shell.InitFile

	// TODO: drop osbuild types from the API
	Firewall              *osbuild.FirewallStageOptions
	Grub2Config           *osbuild.GRUB2Config
	Sysconfig             []*osbuild.SysconfigStageOptions
	SystemdLogind         []*osbuild.SystemdLogindStageOptions
	CloudInit             []*osbuild.CloudInitStageOptions
	Modprobe              []*osbuild.ModprobeStageOptions
	DracutConf            []*osbuild.DracutConfStageOptions
	SystemdDropin         []*osbuild.SystemdUnitStageOptions
	SystemdUnit           []*osbuild.SystemdUnitCreateStageOptions
	Authselect            *osbuild.AuthselectStageOptions
	SELinuxConfig         *osbuild.SELinuxConfigStageOptions
	Tuned                 *osbuild.TunedStageOptions
	Tmpfilesd             []*osbuild.TmpfilesdStageOptions
	PamLimitsConf         []*osbuild.PamLimitsConfStageOptions
	Sysctld               []*osbuild.SysctldStageOptions
	DNFConfig             []*osbuild.DNFConfigStageOptions
	DNFAutomaticConfig    *osbuild.DNFAutomaticConfigStageOptions
	YUMConfig             *osbuild.YumConfigStageOptions
	YUMRepos              []*osbuild.YumReposStageOptions
	SshdConfig            *osbuild.SshdConfigStageOptions
	GCPGuestAgentConfig   *osbuild.GcpGuestAgentConfigOptions
	AuthConfig            *osbuild.AuthconfigStageOptions
	PwQuality             *osbuild.PwqualityConfStageOptions
	ChronyConfig          *osbuild.ChronyStageOptions
	WAAgentConfig         *osbuild.WAAgentConfStageOptions
	UdevRules             *osbuild.UdevRulesStageOptions
	WSLConfig             *osbuild.WSLConfStageOptions
	WSLDistributionConfig *osbuild.WSLDistributionConfStageOptions
	InsightsClientConfig  *osbuild.InsightsClientConfigStageOptions
	NetworkManager        *osbuild.NMConfStageOptions
	Presets               []osbuild.Preset
	ContainersStorage     *string

	// OpenSCAP config
	OpenSCAPRemediationConfig *oscap.RemediationConfig

	Subscription *subscription.ImageOptions
	// Indicates if rhc should be set to permissive when creating the registration script
	PermissiveRHC *bool

	// The final RHSM config to be applied to the image
	RHSMConfig *subscription.RHSMConfig
	RHSMFacts  *facts.ImageOptions

	// Custom directories to create in the image. The stages for the
	// directories defined here are always added at the end of the pipeline.
	Directories []*fsnode.Directory

	// Custom files to create in the image. The stages for the files defined
	// here are always added at the end of the pipeline.
	Files []*fsnode.File

	CACerts []string

	FIPS bool

	// NoBLS configures the image bootloader with traditional menu entries
	// instead of BLS. Required for legacy systems like RHEL 7.
	NoBLS bool

	// InstallWeakDeps enables installation of weak dependencies for packages
	// that are statically defined for the pipeline.
	// Defaults to True.
	InstallWeakDeps bool

	// Determines if the machine id should be set to "uninitialized" which allows
	// "ConditionFirstBoot" to work in systemd
	MachineIdUninitialized bool

	// MountUnits creates systemd .mount units to describe the filesystem
	// instead of writing to /etc/fstab
	MountUnits bool

	// VersionlockPackges uses dnf versionlock to lock a package to the version
	// that is installed during image build, preventing it from being updated.
	// This is only supported for distributions that use dnf4, because osbuild
	// only has a stage for dnf4 version locking.
	VersionlockPackages []string
}

type OSTreeCommit struct {
	Base
	OSVersion string
	// contains filtered or unexported fields
}

type OSTreeCommitServer struct {
	Base
	// Packages to install in addition to the ones required by the
	// pipeline.
	ExtraPackages []string
	// Extra repositories to install packages from
	ExtraRepos []rpmmd.RepoConfig
	// TODO: should this be configurable?
	Language string
	// contains filtered or unexported fields
}

type OSTreeDeployment struct {
	Base

	// Customizations to apply to the deployment
	OSTreeDeploymentCustomizations

	Remote ostree.Remote

	OSVersion string

	PartitionTable *disk.PartitionTable

	EnabledServices  []string
	DisabledServices []string

	// Use bootupd instead of grub2 as the bootloader
	UseBootupd bool
	// contains filtered or unexported fields
}

type OSTreeDeploymentCustomizations struct {
	SysrootReadOnly bool

	KernelOptionsAppend []string
	Keyboard            string
	Locale              string

	Users  []users.User
	Groups []users.Group

	// Specifies the ignition platform to use.
	// If empty, ignition is not enabled.
	IgnitionPlatform string

	Directories []*fsnode.Directory
	Files       []*fsnode.File

	FIPS bool

	CustomFileSystems []string

	// Lock the root account in the deployment unless the user defined root
	// user options in the build configuration.
	LockRoot bool

	// MountUnits creates systemd .mount units to describe the filesystem
	// instead of writing to /etc/fstab
	MountUnits bool
}

type OSTreeEncapsulate struct {
	Base
	// contains filtered or unexported fields
}

type OVF struct {
	Base
	// contains filtered or unexported fields
}

type PackageSelector func([]rpmmd.PackageSet) []rpmmd.PackageSet

type Pipeline interface {

	// Name of the pipeline.
	Name() string

	// Checkpoint this pipeline when osbuild is called.
	Checkpoint()

	// Export this tree of this pipeline as an artifact when osbuild is called.
	Export() *artifact.Artifact

	// BuildPipeline returns a reference to the pipeline that creates the build
	// root for this pipeline. For build pipelines, it should return nil.
	BuildPipeline() Build

	// Manifest returns a reference to the Manifest which this Pipeline belongs to.
	Manifest() *Manifest
	// contains filtered or unexported methods
}

type QCOW2 struct {
	Base

	Compat string
	// contains filtered or unexported fields
}

type RawBootcImage struct {
	Base

	// customizations go here because there is no intermediate
	// tree, with `bootc install to-filesystem` we can only work
	// with the image itself
	PartitionTable *disk.PartitionTable

	KernelOptionsAppend []string

	// The users to put into the image, note that /etc/paswd (and friends)
	// will become unmanaged state by bootc when used
	Users  []users.User
	Groups []users.Group

	// Custom directories and files to create in the image
	Directories []*fsnode.Directory
	Files       []*fsnode.File

	// SELinux policy, when set it enables the labeling of the tree with the
	// selected profile
	SELinux string

	// MountUnits creates systemd .mount units to describe the filesystem
	// instead of writing to /etc/fstab
	MountUnits bool
	// contains filtered or unexported fields
}

type RawImage struct {
	Base

	PartTool osbuild.PartTool
	// contains filtered or unexported fields
}

type RawOSTreeImage struct {
	Base
	// contains filtered or unexported fields
}

type RootfsType uint64

type SerializeOptions struct {
	RpmDownloader osbuild.RpmDownloader
}

type Subscription struct {
	Base

	Subscription *subscription.ImageOptions

	// Custom directories and files to create in the pipeline
	Directories []*fsnode.Directory
	Files       []*fsnode.File
}

type Tar struct {
	Base

	Format      osbuild.TarArchiveFormat
	Compression osbuild.TarArchiveCompression
	RootNode    osbuild.TarRootNode
	Paths       []string
	ACLs        *bool
	SELinux     *bool
	Xattrs      *bool
	Transform   string
	// contains filtered or unexported fields
}

type TreePipeline interface {
	Name() string
	Manifest() *Manifest
	BuildPipeline() Build
	Platform() platform.Platform
}

type VMDK struct {
	Base
	// contains filtered or unexported fields
}

type VPC struct {
	Base

	ForceSize *bool
	// contains filtered or unexported fields
}

type Vagrant struct {
	Base
	// contains filtered or unexported fields
}

type XZ struct {
	Base
	// contains filtered or unexported fields
}

type Zstd struct {
	Base
	// contains filtered or unexported fields
}