Enum Opt 

pub(crate) enum Opt {
    Upgrade(UpgradeOpts),
    Switch(SwitchOpts),
    Rollback(RollbackOpts),
    Edit(EditOpts),
    Status(StatusOpts),
    UsrOverlay,
    Install(InstallOpts),
    Container(ContainerOpts),
    Image(ImageOpts),
    ExecInHostMountNamespace {
        args: Vec<OsString>,
    },
    State(StateOpts),
    Internals(InternalsOpts),
    ComposefsFinalizeStaged,
    ConfigDiff,
    Completion {
        shell: Shell,
    },
    DeleteDeployment {
        depl_id: String,
    },
}

Deploy and transactionally in-place with bootable container images.

The bootc project currently uses ostree-containers as a backend to support a model of bootable container images. Once installed, whether directly via bootc install (executed as part of a container) or via another mechanism such as an OS installer tool, further updates can be pulled and bootc upgrade.

Variants

Upgrade(UpgradeOpts)

Download and queue an updated container image to apply.

This does not affect the running system; updates operate in an “A/B” style by default.

A queued update is visible as staged in bootc status.

Currently by default, the update will be applied at shutdown time via ostree-finalize-staged.service. There is also an explicit bootc upgrade --apply verb which will automatically take action (rebooting) if the system has changed.

However, in the future this is likely to change such that reboots outside of a bootc upgrade --apply do not automatically apply the update in addition.

Switch(SwitchOpts)

Target a new container image reference to boot.

This is almost exactly the same operation as upgrade, but additionally changes the container image reference instead.

Usage

A common pattern is to have a management agent control operating system updates via container image tags; for example, quay.io/exampleos/someuser:v1.0 and quay.io/exampleos/someuser:v1.1 where some machines are tracking :v1.0, and as a rollout progresses, machines can be switched to v:1.1.

Rollback(RollbackOpts)

Change the bootloader entry ordering; the deployment under rollback will be queued for the next boot, and the current will become rollback. If there is a staged entry (an unapplied, queued upgrade) then it will be discarded.

Note that absent any additional control logic, if there is an active agent doing automated upgrades (such as the default bootc-fetch-apply-updates.timer and associated .service) the change here may be reverted. It’s recommended to only use this in concert with an agent that is in active control.

A systemd journal message will be logged with MESSAGE_ID=26f3b1eb24464d12aa5e7b544a6b5468 in order to detect a rollback invocation.

Edit(EditOpts)

Apply full changes to the host specification.

This command operates very similarly to kubectl apply; if invoked interactively, then the current host specification will be presented in the system default $EDITOR for interactive changes.

It is also possible to directly provide new contents via bootc edit --filename.

Only changes to the spec section are honored.

Status(StatusOpts)

Display status.

Shows bootc system state. Outputs YAML by default, human-readable if terminal detected.

UsrOverlay

Add a transient writable overlayfs on /usr.

Allows temporary package installation that will be discarded on reboot.

Install(InstallOpts)

Install the running container to a target.

Takes a container image and installs it to disk in a bootable format.

Container(ContainerOpts)

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

Image(ImageOpts)

Operations on container images.

Stability: This interface may change in the future.

ExecInHostMountNamespace

Execute the given command in the host mount namespace

Fields

args: Vec<OsString>

State(StateOpts)

Modify the state of the system

Internals(InternalsOpts)

ComposefsFinalizeStaged

ConfigDiff

Diff current /etc configuration versus default

Completion

Generate shell completion script for supported shells.

Example: bootc completion bash prints a bash completion script to stdout.

Fields

shell: Shell

Shell type to generate (bash, zsh, fish)

DeleteDeployment

Fields

depl_id: String

Implementations

impl Opt

fn parse_including_static<I>(args: I) -> Self

where I: IntoIterator, I::Item: Into<OsString> + Clone,

In some cases (e.g. systemd generator) we dispatch specifically on argv0. This requires some special handling in clap.

Trait Implementations

impl CommandFactory for Opt

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Opt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for Opt

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Opt

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl PartialEq for Opt

fn eq(&self, other: &Opt) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Subcommand for Opt

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

impl Eq for Opt

impl StructuralPartialEq for Opt