Module cli 

Bootable container image CLI

Command line tool to manage bootable ostree-based containers.

Structs

ApplyFromDownloadedOpts 🔒

ComposefsFinalizeStagedOpts 🔒

Finalize a staged composefs deployment.

DownloadOnlyOpts 🔒

EditOpts 🔒

Perform an edit operation

ProgressOptions 🔒

Shared progress options

RollbackOpts 🔒

Options controlling rollback

SetOptionsForSourceOpts 🔒

Options for the set-options-for-source subcommand.

StatusOpts 🔒

Perform an status operation

SwitchOpts 🔒

Perform an switch operation

UpgradeOpts 🔒

Perform an upgrade operation

UsrOverlayOpts 🔒

Add a transient overlayfs on /usr

Enums

BlockdevOpts 🔒

Subcommands for bootc internals blockdev.

BootArtifactErofsVersionArg 🔒

EROFS format and compatibility arguments to embed in a boot artifact.

CliExitStatus

The outcome of executing the CLI.

ContainerOpts 🔒

Subcommands which can be executed as part of a container build.

ErofsVersionArg 🔒

EROFS format version for computing a composefs digest.

ExportFormat 🔒

ExportSelinuxMode 🔒

FsverityOpts 🔒

Options for consistency checking

ImageCmdOpts 🔒

Subcommands which operate on images.

ImageListFormat 🔒

ImageListType 🔒

ImageOpts 🔒

Subcommands which operate on images.

InstallOpts 🔒

InternalsOpts 🔒

Hidden, internal only options

LoaderEntriesOpts 🔒

Operations on Boot Loader Specification (BLS) entries.

Opt 🔒

Deploy and transactionally in-place with bootable container images.

OutputFormat 🔒

SchemaType 🔒

SelinuxOpts 🔒

Subcommands for bootc internals selinux.

SoftRebootMode 🔒

StateOpts 🔒

UkiAddonCliOpts 🔒

UkiAddonScope 🔒

UkiSubcommands 🔒

Constants

EXIT_UNAVAILABLE

Exit status when a subcommand is unavailable because the running host lacks the feature behind it (see host_feature_gate_rejects). Distinct from a usage error (2) and a runtime failure (1) so that a caller probing for the feature, as TuneD does with bootc loader-entries set-options-for-source --help, can tell “not supported here” from “failed”. 77 is the status test harnesses use for “skipped”.

LOADER_ENTRIES_SUBCOMMAND 🔒

The name of the bootc loader-entries subcommand.

Functions

apply_from_downloaded_ostree 🔒

apply_host_feature_gates 🔒

Hide subcommands whose backing functionality is missing on the running host from --help. Invoking one is rejected before parsing by host_feature_gate_rejects.

callname_from_argv0 🔒

Find the base binary name from argv0 (without a full path). The empty string is never returned; instead a fallback string is used. If the input is not valid UTF-8, a default is used.

edit 🔒

Implementation of the bootc edit CLI command.

edit_ostree 🔒

Implementation of the bootc edit CLI command for ostree backend.

ensure_self_unshared_mount_namespace 🔒

Ensure we’ve entered a mount namespace, so that we can remount /sysroot read-write TODO use https://github.com/ostreedev/ostree/pull/2779 once we can depend on a new enough ostree

get_storage 🔒

Load global storage state, expecting that we’re booted into a bootc system. This prepares the process for write operations (re-exec, mount namespace, etc).

global_init

Perform process global initialization. This should be called as early as possible in the standard main function.

handle_soft_reboot 🔒

Handle soft reboot based on the configured mode

handle_staged_soft_reboot 🔒

Handle soft reboot for staged deployments (used by upgrade and switch)

has_soft_reboot_capability 🔒

Check if a deployment has soft reboot capability

host_feature_gate_rejects 🔒

Whether args (argv, including argv0) invoke a subcommand that apply_host_feature_gates made unavailable. The top-level command has no options that take a value, so the first non-option argument is the subcommand name.

imgref_for_switch 🔒

is_unlabeled_exit_status 🔒

join_host_ipc_namespace 🔒

Join the host IPC namespace if we’re in an isolated one and have sufficient privileges. The default for podman run is a separate IPC namespace, which for e.g. bootc install can cause failures where tools like udev/cryptsetup expect semaphores to be in sync with the host. While we do want callers to pass --ipc=host, we don’t want to force them to need to either.

parse_absolute_path 🔒

prepare_for_write 🔒

A few process changes that need to be made for writing. IMPORTANT: This may end up re-executing the current process, so anything that happens before this should be idempotent.

prepare_soft_reboot 🔒

Prepare a soft reboot for the given deployment

require_root 🔒

rollback 🔒

Implementation of the bootc rollback CLI command.

rollback_ostree 🔒

Implementation of the bootc rollback CLI command for ostree backend.

run_from_iter

Parse the provided arguments and execute. Calls [clap::Error::exit] on failure, printing the error message and aborting the program.

run_from_opt 🔒

Internal (non-generic/monomorphized) primary CLI entrypoint

soft_reboot_rollback 🔒

Perform a soft reboot for a rollback deployment

soft_reboot_staged 🔒

Perform a soft reboot for a staged deployment

switch 🔒

Implementation of the bootc switch CLI command.

switch_ostree 🔒

Implementation of the bootc switch CLI command for ostree backend.

upgrade 🔒

Implementation of the bootc upgrade CLI command.

usroverlay 🔒

Implementation of bootc usroverlay