Structsยง
- Bootloader
Entry ๐ - Composefs
Cmdline ๐ - A parsed composefs command line
- Deployment
Boot ๐Info - Information about a deployment for soft reboot comparison
- ImgConfig
Manifest ๐ - Used for storing the container image info alongside of .origin file
- Staged
Deployment ๐ - The JSON schema for staged deployment information
stored in
/run/composefs/staged-deployment
Constantsยง
- BLS_
ENTRIES_ ๐DIR - Directory where BLS-compatible bootloaders expect Type 1 boot entries.
- GRUB_
DIRS ๐ - Directories where GRUB keeps its own configuration and modules. Their
presence means GRUB owns the boot flow even if BLS Type 1 entries also
exist, because GRUB can consume those entries itself via the
blscfgmodule โ Fedora and RHEL enable exactly that withGRUB_ENABLE_BLSCFG=true./boot/grub2is the Fedora/RHEL path,/boot/grubthe Debian/Ubuntu one.
Functionsยง
- aboot_
entry ๐ - boot_
entry_ ๐from_ composefs_ deployment - build_
composefs_ ๐karg - Render a composefs karg that identifies the EROFS format of
digest. - classify_
bootloader ๐ - Pure classifier for the bootloader kind, split from I/O for testability.
- compare_
cmdline_ ๐skip_ cfs - Compares cmdline
firstandsecondskipping either composefs karg spelling. - composefs_
aboot_ ๐status - composefs_
aboot_ ๐status_ from - composefs_
booted ๐ - Detect if we have
composefs=<digest>in/proc/cmdline - composefs_
deployment_ ๐status_ from - find_
bls_ ๐entry - get_
bootloader ๐ - get_
composefs_ ๐status - Get composefs status using provided storage and booted composefs data instead of scraping global state.
- get_
container_ ๐manifest_ and_ config - imgref = transport:image_name
- get_
imginfo ๐ - Retrieves the OCI manifest and config for a deployment from the composefs repository.
- get_
sorted_ ๐grub_ uki_ boot_ entries - Get the grub UKI menuentries
- get_
sorted_ ๐grub_ uki_ boot_ entries_ helper - get_
sorted_ ๐grub_ uki_ boot_ entries_ staged - Get the staged grub UKI menuentries
- get_
sorted_ ๐staged_ type1_ boot_ entries - Same as
get_sorted_type1_boot_entries, but returns staged entries Seeget_sorted_type1_boot_entriesfor more details - get_
sorted_ ๐type1_ boot_ entries - Get sorted boot entries
The sort here is done in terms of what will be shown on the boot menu
For systemd-boot, the entries are sorted by
sort-keyFor grub, the entries are sorted by the filename in descending order - get_
sorted_ ๐type1_ boot_ entries_ helper - image_
version_ ๐and_ created - Version and created timestamp for a composefs deployment image.
- is_
soft_ ๐rebootable - Determines whether a soft reboot can be performed between the currently booted deployment and a target deployment.
- list_
bootloader_ ๐entries - Get all Type1/Type2 bootloader entries
- list_
type1_ ๐entries - read_
staged_ ๐deployment - reconcile_
composefs_ ๐cmdline_ with_ mount_ source - rollback_
queued_ ๐from_ first_ entry - Whether the bootloader will boot a deployment other than the booted one, i.e. whether the first (default) boot entry references some other deployment.
- set_
reboot_ ๐capable_ type1_ deployments - set_
reboot_ ๐capable_ uki_ deployments - set_
soft_ ๐reboot_ capability - Check whether any deployment is capable of being soft rebooted or not