Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 45 additions & 4 deletions crates/lib/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,14 @@ pub(crate) struct SwitchOpts {
#[clap(long)]
pub(crate) retain: bool,

/// Use unified storage path to pull images (experimental)
///
/// When enabled, this uses bootc's container storage (/usr/lib/bootc/storage) to pull
/// the image first, then imports it from there. This is the same approach used for
/// logically bound images.
#[clap(long = "experimental-unified-storage", hide = true)]
pub(crate) unified_storage_exp: bool,

/// Target image to use for the next boot.
pub(crate) target: String,

Expand Down Expand Up @@ -445,6 +453,11 @@ pub(crate) enum ImageOpts {
/// this will make the image accessible via e.g. `podman run localhost/bootc` and for builds.
target: Option<String>,
},
/// Re-pull the currently booted image into the bootc-owned container storage.
///
/// This onboards the system to the unified storage path so that future
/// upgrade/switch operations can read from the bootc storage directly.
SetUnified,
/// Copy a container image from the default `containers-storage:` to the bootc-owned container storage.
PullFromDefaultStorage {
/// The image to pull
Expand Down Expand Up @@ -948,7 +961,15 @@ async fn upgrade(
}
}
} else {
let fetched = crate::deploy::pull(repo, imgref, None, opts.quiet, prog.clone()).await?;
// Auto-detect whether to use unified storage based on image presence in bootc storage
let use_unified = crate::deploy::image_exists_in_unified_storage(storage, imgref).await;

let fetched = if use_unified {
crate::deploy::pull_unified(repo, imgref, None, opts.quiet, prog.clone(), storage, None)
.await?
} else {
crate::deploy::pull(repo, imgref, None, opts.quiet, prog.clone()).await?
};
let staged_digest = staged_image.map(|s| s.digest().expect("valid digest in status"));
let fetched_digest = &fetched.manifest_digest;
tracing::debug!("staged: {staged_digest:?}");
Expand Down Expand Up @@ -1062,7 +1083,21 @@ async fn switch_ostree(

let new_spec = RequiredHostSpec::from_spec(&new_spec)?;

let fetched = crate::deploy::pull(repo, &target, None, opts.quiet, prog.clone()).await?;
// Determine whether to use unified storage path.
// If explicitly requested via flag, use unified storage directly.
// Otherwise, auto-detect based on whether the image exists in bootc storage.
let use_unified = if opts.unified_storage_exp {
true
} else {
crate::deploy::image_exists_in_unified_storage(storage, &target).await
};

let fetched = if use_unified {
crate::deploy::pull_unified(repo, &target, None, opts.quiet, prog.clone(), storage, None)
.await?
} else {
crate::deploy::pull(repo, &target, None, opts.quiet, prog.clone()).await?
};

if !opts.retain {
// By default, we prune the previous ostree ref so it will go away after later upgrades
Expand Down Expand Up @@ -1422,7 +1457,9 @@ async fn run_from_opt(opt: Opt) -> Result<()> {
tracing::debug!("Computing digest of {iid}");

if !host_container_store.try_exists()? {
anyhow::bail!("Must be readonly mount of host container store: {host_container_store}");
anyhow::bail!(
"Must be readonly mount of host container store: {host_container_store}"
);
}
// And ensure we're finding the image in the host storage
let mut cmd = Command::new("skopeo");
Expand Down Expand Up @@ -1460,6 +1497,7 @@ async fn run_from_opt(opt: Opt) -> Result<()> {
ImageOpts::CopyToStorage { source, target } => {
crate::image::push_entrypoint(source.as_deref(), target.as_deref()).await
}
ImageOpts::SetUnified => crate::image::set_unified_entrypoint().await,
ImageOpts::PullFromDefaultStorage { image } => {
let storage = get_storage().await?;
storage
Expand Down Expand Up @@ -1539,7 +1577,10 @@ async fn run_from_opt(opt: Opt) -> Result<()> {
let mut w = SplitStreamWriter::new(&cfs, None, Some(testdata_digest));
w.write_inline(testdata);
let object = cfs.write_stream(w, Some("testobject"))?.to_hex();
assert_eq!(object, "5d94ceb0b2bb3a78237e0a74bc030a262239ab5f47754a5eb2e42941056b64cb21035d64a8f7c2f156e34b820802fa51884de2b1f7dc3a41b9878fc543cd9b07");
assert_eq!(
object,
"5d94ceb0b2bb3a78237e0a74bc030a262239ab5f47754a5eb2e42941056b64cb21035d64a8f7c2f156e34b820802fa51884de2b1f7dc3a41b9878fc543cd9b07"
);
Ok(())
}
// We don't depend on fsverity-utils today, so re-expose some helpful CLI tools.
Expand Down
228 changes: 214 additions & 14 deletions crates/lib/src/deploy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

use std::collections::HashSet;
use std::io::{BufRead, Write};
use std::process::Command;

use anyhow::Ok;
use anyhow::{anyhow, Context, Result};
use bootc_kernel_cmdline::utf8::CmdlineOwned;
use cap_std::fs::{Dir, MetadataExt};
Expand Down Expand Up @@ -93,6 +93,17 @@ pub(crate) async fn new_importer(
Ok(imp)
}

/// Wrapper for pulling a container image with a custom proxy config (e.g. for unified storage).
pub(crate) async fn new_importer_with_config(
repo: &ostree::Repo,
imgref: &ostree_container::OstreeImageReference,
config: ostree_ext::containers_image_proxy::ImageProxyConfig,
) -> Result<ostree_container::store::ImageImporter> {
let mut imp = ostree_container::store::ImageImporter::new(repo, imgref, config).await?;
imp.require_bootable();
Ok(imp)
}

pub(crate) fn check_bootc_label(config: &ostree_ext::oci_spec::image::ImageConfiguration) {
if let Some(label) =
labels_of_config(config).and_then(|labels| labels.get(crate::metadata::BOOTC_COMPAT_LABEL))
Expand Down Expand Up @@ -316,6 +327,18 @@ pub(crate) async fn prune_container_store(sysroot: &Storage) -> Result<()> {
for deployment in deployments {
let bound = crate::boundimage::query_bound_images_for_deployment(ostree, &deployment)?;
all_bound_images.extend(bound.into_iter());
// Also include the host image itself
// Note: Use just the image name (not the full transport:image format) because
// podman's image names don't include the transport prefix.
if let Some(host_image) = crate::status::boot_entry_from_deployment(ostree, &deployment)?
.image
.map(|i| i.image)
{
all_bound_images.push(crate::boundimage::BoundImage {
image: host_image.image.clone(),
auth_file: None,
});
}
}
// Convert to a hashset of just the image names
let image_names = HashSet::from_iter(all_bound_images.iter().map(|img| img.image.as_str()));
Expand Down Expand Up @@ -381,6 +404,180 @@ pub(crate) async fn prepare_for_pull(
Ok(PreparedPullResult::Ready(Box::new(prepared_image)))
}

/// Check whether the image exists in bootc's unified container storage.
///
/// This is used for auto-detection: if the image already exists in bootc storage
/// (e.g., from a previous `bootc image set-unified` or LBI pull), we can use
/// the unified storage path for faster imports.
///
/// Returns true if the image exists in bootc storage.
pub(crate) async fn image_exists_in_unified_storage(
store: &Storage,
imgref: &ImageReference,
) -> bool {
let imgstore = match store.get_ensure_imgstore() {
Ok(s) => s,
Err(e) => {
tracing::warn!("Failed to access bootc storage: {e}; falling back to standard pull");
return false;
}
};

let image_ref_str = imgref.to_transport_image();
match imgstore.exists(&image_ref_str).await {
Ok(v) => v,
Err(e) => {
tracing::warn!(
"Failed to check bootc storage for image: {e}; falling back to standard pull"
);
false
}
}
}

/// Unified approach: Use bootc's CStorage to pull the image, then prepare from containers-storage.
/// This reuses the same infrastructure as LBIs.
///
/// The `sysroot_path` parameter specifies the path to the sysroot where bootc storage is located.
/// During install, this should be the path to the target disk's mount point.
/// During upgrade/switch on a running system, pass `None` to use the default `/sysroot`.
pub(crate) async fn prepare_for_pull_unified(
repo: &ostree::Repo,
imgref: &ImageReference,
target_imgref: Option<&OstreeImageReference>,
store: &Storage,
sysroot_path: Option<&camino::Utf8Path>,
) -> Result<PreparedPullResult> {
// Get or initialize the bootc container storage (same as used for LBIs)
let imgstore = store.get_ensure_imgstore()?;

let image_ref_str = imgref.to_transport_image();

// Always pull to ensure we have the latest image, whether from a remote
// registry or a locally rebuilt image
tracing::info!(
"Unified pull: pulling from transport '{}' to bootc storage",
&imgref.transport
);

// Pull the image to bootc storage using the same method as LBIs
// Show a spinner since podman pull can take a while and doesn't output progress
let pull_msg = format!("Pulling {} to bootc storage", &image_ref_str);
async_task_with_spinner(&pull_msg, async move {
imgstore
.pull(&image_ref_str, crate::podstorage::PullMode::Always)
.await
})
.await?;

// Now create a containers-storage reference to read from bootc storage
tracing::info!("Unified pull: now importing from containers-storage transport");
let containers_storage_imgref = ImageReference {
transport: "containers-storage".to_string(),
image: imgref.image.clone(),
signature: imgref.signature.clone(),
};
let ostree_imgref = OstreeImageReference::from(containers_storage_imgref);

// Configure the importer to use bootc storage as an additional image store
let mut config = ostree_ext::containers_image_proxy::ImageProxyConfig::default();
let mut cmd = Command::new("skopeo");
// Use the actual physical path to bootc storage
// During install, this is the target disk's mount point; otherwise default to /sysroot
let sysroot_base = sysroot_path
.map(|p| p.to_string())
.unwrap_or_else(|| "/sysroot".to_string());
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's clean this up post merge - should get this stuff from the Storage

let storage_path = format!(
"{}/{}",
sysroot_base,
crate::podstorage::CStorage::subpath()
);
crate::podstorage::set_additional_image_store(&mut cmd, &storage_path);
config.skopeo_cmd = Some(cmd);

// Use the preparation flow with the custom config
let mut imp = new_importer_with_config(repo, &ostree_imgref, config).await?;
if let Some(target) = target_imgref {
imp.set_target(target);
}
let prep = match imp.prepare().await? {
PrepareResult::AlreadyPresent(c) => {
println!("No changes in {imgref:#} => {}", c.manifest_digest);
return Ok(PreparedPullResult::AlreadyPresent(Box::new((*c).into())));
}
PrepareResult::Ready(p) => p,
};
check_bootc_label(&prep.config);
if let Some(warning) = prep.deprecated_warning() {
ostree_ext::cli::print_deprecated_warning(warning).await;
}
ostree_ext::cli::print_layer_status(&prep);
let layers_to_fetch = prep.layers_to_fetch().collect::<Result<Vec<_>>>()?;

// Log that we're importing a new image from containers-storage
const PULLING_NEW_IMAGE_ID: &str = "6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f1a0";
tracing::info!(
message_id = PULLING_NEW_IMAGE_ID,
bootc.image.reference = &imgref.image,
bootc.image.transport = "containers-storage",
bootc.original_transport = &imgref.transport,
bootc.status = "importing_from_storage",
"Importing image from bootc storage: {}",
ostree_imgref
);

let prepared_image = PreparedImportMeta {
imp,
n_layers_to_fetch: layers_to_fetch.len(),
layers_total: prep.all_layers().count(),
bytes_to_fetch: layers_to_fetch.iter().map(|(l, _)| l.layer.size()).sum(),
bytes_total: prep.all_layers().map(|l| l.layer.size()).sum(),
digest: prep.manifest_digest.clone(),
prep,
};

Ok(PreparedPullResult::Ready(Box::new(prepared_image)))
}

/// Unified pull: Use podman to pull to containers-storage, then read from there
///
/// The `sysroot_path` parameter specifies the path to the sysroot where bootc storage is located.
/// For normal upgrade/switch operations, pass `None` to use the default `/sysroot`.
pub(crate) async fn pull_unified(
repo: &ostree::Repo,
imgref: &ImageReference,
target_imgref: Option<&OstreeImageReference>,
quiet: bool,
prog: ProgressWriter,
store: &Storage,
sysroot_path: Option<&camino::Utf8Path>,
) -> Result<Box<ImageState>> {
match prepare_for_pull_unified(repo, imgref, target_imgref, store, sysroot_path).await? {
PreparedPullResult::AlreadyPresent(existing) => {
// Log that the image was already present (Debug level since it's not actionable)
const IMAGE_ALREADY_PRESENT_ID: &str = "5c4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9";
tracing::debug!(
message_id = IMAGE_ALREADY_PRESENT_ID,
bootc.image.reference = &imgref.image,
bootc.image.transport = &imgref.transport,
bootc.status = "already_present",
"Image already present: {}",
imgref
);
Ok(existing)
}
PreparedPullResult::Ready(prepared_image_meta) => {
// To avoid duplicate success logs, pass a containers-storage imgref to the importer
let cs_imgref = ImageReference {
transport: "containers-storage".to_string(),
image: imgref.image.clone(),
signature: imgref.signature.clone(),
};
pull_from_prepared(&cs_imgref, quiet, prog, *prepared_image_meta).await
}
}
}

#[context("Pulling")]
pub(crate) async fn pull_from_prepared(
imgref: &ImageReference,
Expand Down Expand Up @@ -430,18 +627,21 @@ pub(crate) async fn pull_from_prepared(
let imgref_canonicalized = imgref.clone().canonicalize()?;
tracing::debug!("Canonicalized image reference: {imgref_canonicalized:#}");

// Log successful import completion
const IMPORT_COMPLETE_JOURNAL_ID: &str = "4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8";

tracing::info!(
message_id = IMPORT_COMPLETE_JOURNAL_ID,
bootc.image.reference = &imgref.image,
bootc.image.transport = &imgref.transport,
bootc.manifest_digest = import.manifest_digest.as_ref(),
bootc.ostree_commit = &import.merge_commit,
"Successfully imported image: {}",
imgref
);
// Log successful import completion (skip if using unified storage to avoid double logging)
let is_unified_path = imgref.transport == "containers-storage";
if !is_unified_path {
const IMPORT_COMPLETE_JOURNAL_ID: &str = "4d3e2f1a0b9c8d7e6f5a4b3c2d1e0f9a8";

tracing::info!(
message_id = IMPORT_COMPLETE_JOURNAL_ID,
bootc.image.reference = &imgref.image,
bootc.image.transport = &imgref.transport,
bootc.manifest_digest = import.manifest_digest.as_ref(),
bootc.ostree_commit = &import.merge_commit,
"Successfully imported image: {}",
imgref
);
}

if let Some(msg) =
ostree_container::store::image_filtered_content_warning(&import.filtered_files)
Expand Down Expand Up @@ -1051,7 +1251,7 @@ pub(crate) fn fixup_etc_fstab(root: &Dir) -> Result<()> {
}

// Read the input, and atomically write a modified version
root.atomic_replace_with(fstab_path, move |mut w| {
root.atomic_replace_with(fstab_path, move |mut w| -> Result<()> {
for line in fd.lines() {
let line = line?;
if !edit_fstab_line(&line, &mut w)? {
Expand Down
Loading