Module install 

Writing a container to a block device in a bootable way

This module supports installing a bootc-compatible image to a block device directly via the install verb, or to an externally set up filesystem via install to-filesystem.

Modules

aleph 🔒

baseline 🔒

The baseline installer

completion 🔒

This module handles finishing/completion after an ostree-based install from e.g. Anaconda.

config 🔒

Configuration for bootc install

osbuild 🔒

Helper APIs for interacting with bootc-image-builder

osconfig 🔒

Structs

InstallComposefsOpts 🔒

InstallConfigOpts 🔒

InstallPrintConfigurationOpts 🔒

InstallResetOpts 🔒

InstallSourceOpts 🔒

InstallTargetFilesystemOpts 🔒

Options for installing to a filesystem

InstallTargetOpts 🔒

InstallToDiskOpts 🔒

InstallToExistingRootOpts 🔒

InstallToFilesystemOpts 🔒

MountSpec 🔒

A mount specification is a subset of a line in /etc/fstab.

PostFetchState 🔒

RootMountInfo 🔒

RootSetup 🔒

SourceInfo 🔒

Global state captured from the container.

State 🔒

Enums

BoundImages 🔒

BoundImagesOpt 🔒

Cleanup

ReplaceMode 🔒

SELinuxFinalState 🔒

Constants

ALONGSIDE_ROOT_MOUNT 🔒

The default path for the host rootfs

ARCH_USES_EFI 🔒

BOOT 🔒

The toplevel boot directory

DEFAULT_REPO_CONFIG 🔒

DESTRUCTIVE_CLEANUP 🔒

Global flag to signal the booted system was provisioned via an alongside bootc install

EFIVARFS 🔒

The mount path for uefi

EFI_LOADER_INFO 🔒

LOST_AND_FOUND 🔒

This is an ext4 special directory we need to ignore.

OSTREE_COMPOSEFS_SUPER 🔒

The filename of the composefs EROFS superblock; TODO move this into ostree

RUN_BOOTC 🔒

Directory for transient runtime state

RW_KARG 🔒

Kernel argument used to specify we want the rootfs mounted read-write by default

SELINUXFS 🔒

The mount path for selinux

Functions

check_disk_space 🔒

clean_boot_directories 🔒

exec_in_host_mountns 🔒

finalize_filesystem 🔒

Trim, flush outstanding writes, and freeze/thaw the target mounted filesystem; these steps prepare the filesystem for its first booted use.

find_root_args_to_inherit 🔒

Discover how to mount the root filesystem, using existing kernel arguments and information about the root mount.

initialize_ostree_root 🔒

install_container 🔒

install_finalize 🔒

Implementation of bootc install finalize.

install_reset 🔒

install_to_disk 🔒

Implementation of the bootc install to-disk CLI command.

install_to_existing_root 🔒

install_to_filesystem 🔒

Implementation of the bootc install to-filesystem CLI command.

install_to_filesystem_impl 🔒

install_with_sysroot 🔒

Given a baseline root filesystem with an ostree sysroot initialized:

installation_complete 🔒

ostree_install 🔒

prepare_install 🔒

Preparation for an install; validates and prepares some (thereafter immutable) global state.

print_configuration 🔒

read_boot_fstab_entry 🔒

Read the /boot entry from /etc/fstab, if it exists

reexecute_self_for_selinux_if_needed 🔒

If we detect that the target ostree commit has SELinux labels, and we aren’t passed an override to disable it, then ensure the running process is labeled with install_t so it can write arbitrary labels.

remove_all_except_loader_dirs 🔒

remove_all_in_dir_no_xdev 🔒

Remove all entries in a directory, but do not traverse across distinct devices. If mount_err is true, then an error is returned if a mount point is found; otherwise it is silently ignored.

require_boot_uuid 🔒

require_dir_contains_only_mounts 🔒

Require that a directory contains only mount points recursively. Returns Ok(()) if all entries in the directory tree are either:

require_empty_rootdir 🔒

require_host_pidns 🔒

A heuristic check that we were invoked with –pid=host

require_host_userns 🔒

Verify that we can access /proc/1, which will catch rootless podman (with –pid=host) for example.

run_in_host_mountns 🔒

Run a command in the host mount namespace

setup_sys_mount 🔒

By default, podman/docker etc. when passed --privileged mount /sys as read-only, but non-recursively. We selectively grab sub-filesystems that we need.

setup_tmp_mount 🔒

Ensure that /tmp is a tmpfs because in some cases we might perform operations which expect it (as it is on a proper host system). Ideally we have people run this container via podman run –read-only-tmpfs actually.

verify_target_fetch 🔒

Verify that we can load the manifest of the target image

warn_on_host_root 🔒