Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for split layers #123

Merged
merged 2 commits into from
Mar 24, 2022
Merged
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
505 changes: 505 additions & 0 deletions lib/src/chunking.rs

Large diffs are not rendered by default.

24 changes: 8 additions & 16 deletions lib/src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ use structopt::StructOpt;
use tokio_stream::StreamExt;

use crate::commit::container_commit;
use crate::container::store::{LayeredImageImporter, PrepareResult};
use crate::container::{self as ostree_container, UnencapsulationProgress};
use crate::container as ostree_container;
use crate::container::{Config, ImageReference, OstreeImageReference, UnencapsulateOptions};
use ostree_container::store::{ImageImporter, PrepareResult};
use ostree_container::UnencapsulationProgress;

/// Parse an [`OstreeImageReference`] from a CLI arguemnt.
pub fn parse_imgref(s: &str) -> Result<OstreeImageReference> {
Expand Down Expand Up @@ -257,7 +258,7 @@ struct ImaSignOpts {
/// Options for internal testing
#[derive(Debug, StructOpt)]
enum TestingOpts {
// Detect the current environment
/// Detect the current environment
DetectEnv,
/// Execute integration tests, assuming mutable environment
Run,
Expand Down Expand Up @@ -413,7 +414,8 @@ async fn container_export(
copy_meta_keys,
..Default::default()
};
let pushed = crate::container::encapsulate(repo, rev, &config, Some(opts), imgref).await?;
let pushed =
crate::container::encapsulate(repo, rev, &config, Some(opts), None, imgref).await?;
println!("{}", pushed);
Ok(())
}
Expand All @@ -431,25 +433,15 @@ async fn container_store(
imgref: &OstreeImageReference,
proxyopts: ContainerProxyOpts,
) -> Result<()> {
let mut imp = LayeredImageImporter::new(repo, imgref, proxyopts.into()).await?;
let mut imp = ImageImporter::new(repo, imgref, proxyopts.into()).await?;
let prep = match imp.prepare().await? {
PrepareResult::AlreadyPresent(c) => {
println!("No changes in {} => {}", imgref, c.merge_commit);
return Ok(());
}
PrepareResult::Ready(r) => r,
};
if prep.base_layer.commit.is_none() {
let size = crate::glib::format_size(prep.base_layer.size());
println!(
"Downloading base layer: {} ({})",
prep.base_layer.digest(),
size
);
} else {
println!("Using base: {}", prep.base_layer.digest());
}
for layer in prep.layers.iter() {
for layer in prep.all_layers() {
if layer.commit.is_some() {
println!("Using layer: {}", layer.digest());
} else {
Expand Down
9 changes: 3 additions & 6 deletions lib/src/container/deploy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,9 @@ pub async fn deploy(
let cancellable = ostree::gio::NONE_CANCELLABLE;
let options = options.unwrap_or_default();
let repo = &sysroot.repo().unwrap();
let mut imp = super::store::LayeredImageImporter::new(
repo,
imgref,
options.proxy_cfg.unwrap_or_default(),
)
.await?;
let mut imp =
super::store::ImageImporter::new(repo, imgref, options.proxy_cfg.unwrap_or_default())
.await?;
if let Some(target) = options.target_imgref {
imp.set_target(target);
}
Expand Down
129 changes: 103 additions & 26 deletions lib/src/container/encapsulate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
use super::ocidir::OciDir;
use super::{ocidir, OstreeImageReference, Transport};
use super::{ImageReference, SignatureSource, OSTREE_COMMIT_LABEL};
use crate::chunking::{Chunking, ObjectMetaSized};
use crate::container::skopeo;
use crate::tar as ostree_tar;
use anyhow::{anyhow, Context, Result};
Expand All @@ -12,6 +13,7 @@ use oci_spec::image as oci_image;
use ostree::gio;
use std::borrow::Cow;
use std::collections::{BTreeMap, HashMap};
use std::num::NonZeroU32;
use std::path::Path;
use std::rc::Rc;
use tracing::{instrument, Level};
Expand Down Expand Up @@ -70,6 +72,46 @@ fn commit_meta_to_labels<'a>(
Ok(())
}

/// Write an ostree commit to an OCI blob
#[context("Writing ostree root to blob")]
#[allow(clippy::too_many_arguments)]
fn export_chunked(
repo: &ostree::Repo,
ociw: &mut OciDir,
manifest: &mut oci_image::ImageManifest,
imgcfg: &mut oci_image::ImageConfiguration,
labels: &mut HashMap<String, String>,
mut chunking: Chunking,
compression: Option<flate2::Compression>,
description: &str,
) -> Result<()> {
let layers: Result<Vec<_>> = chunking
.take_chunks()
.into_iter()
.enumerate()
.map(|(i, chunk)| -> Result<_> {
let mut w = ociw.create_layer(compression)?;
ostree_tar::export_chunk(repo, &chunk, &mut w)
.with_context(|| format!("Exporting chunk {}", i))?;
let w = w.into_inner()?;
Ok((w.complete()?, chunk.name))
})
.collect();
for (layer, name) in layers? {
ociw.push_layer(manifest, imgcfg, layer, &name);
}
let mut w = ociw.create_layer(compression)?;
ostree_tar::export_final_chunk(repo, &chunking, &mut w)?;
let w = w.into_inner()?;
let final_layer = w.complete()?;
labels.insert(
crate::container::OSTREE_DIFFID_LABEL.into(),
format!("sha256:{}", final_layer.uncompressed_sha256),
);
ociw.push_layer(manifest, imgcfg, final_layer, description);
Ok(())
}

/// Generate an OCI image from a given ostree root
#[context("Building oci")]
fn build_oci(
Expand All @@ -78,6 +120,7 @@ fn build_oci(
ocidir_path: &Path,
config: &Config,
opts: ExportOpts,
contentmeta: Option<crate::chunking::ObjectMetaSized>,
) -> Result<ImageReference> {
// Explicitly error if the target exists
std::fs::create_dir(ocidir_path).context("Creating OCI dir")?;
Expand Down Expand Up @@ -109,52 +152,74 @@ fn build_oci(

let mut manifest = ocidir::new_empty_manifest().build().unwrap();

let chunking = contentmeta
.map(|meta| crate::chunking::Chunking::from_mapping(repo, commit, meta, opts.max_layers))
.transpose()?;

if let Some(version) =
commit_meta.lookup_value("version", Some(glib::VariantTy::new("s").unwrap()))
{
let version = version.str().unwrap();
labels.insert("version".into(), version.into());
}

labels.insert(OSTREE_COMMIT_LABEL.into(), commit.into());

for (k, v) in config.labels.iter().flat_map(|k| k.iter()) {
labels.insert(k.into(), v.into());
}
// Lookup the cmd embedded in commit metadata
let cmd = commit_meta.lookup::<Vec<String>>(ostree::COMMIT_META_CONTAINER_CMD)?;
// But support it being overridden by CLI options

// https://github.com/rust-lang/rust-clippy/pull/7639#issuecomment-1050340564
#[allow(clippy::unnecessary_lazy_evaluations)]
let cmd = config.cmd.as_ref().or_else(|| cmd.as_ref());
if let Some(cmd) = cmd {
ctrcfg.set_cmd(Some(cmd.clone()));
}

imgcfg.set_config(Some(ctrcfg));

let compression = if opts.compress {
flate2::Compression::default()
} else {
flate2::Compression::none()
};

let rootfs_blob = export_ostree_ref(repo, commit, &mut writer, Some(compression))?;
let mut annos = HashMap::new();
annos.insert(BLOB_OSTREE_ANNOTATION.to_string(), "true".to_string());
let description = if commit_subject.is_empty() {
Cow::Owned(format!("ostree export of commit {}", commit))
} else {
Cow::Borrowed(commit_subject)
};
let mut annos = HashMap::new();
annos.insert(BLOB_OSTREE_ANNOTATION.to_string(), "true".to_string());
writer.push_layer_annotated(
&mut manifest,
&mut imgcfg,
rootfs_blob,
Some(annos),
&description,
);

if let Some(chunking) = chunking {
export_chunked(
repo,
&mut writer,
&mut manifest,
&mut imgcfg,
labels,
chunking,
Some(compression),
&description,
)?;
} else {
let rootfs_blob = export_ostree_ref(repo, commit, &mut writer, Some(compression))?;
labels.insert(
crate::container::OSTREE_DIFFID_LABEL.into(),
format!("sha256:{}", rootfs_blob.uncompressed_sha256),
);
writer.push_layer_annotated(
&mut manifest,
&mut imgcfg,
rootfs_blob,
Some(annos),
&description,
);
}

// Lookup the cmd embedded in commit metadata
let cmd = commit_meta.lookup::<Vec<String>>(ostree::COMMIT_META_CONTAINER_CMD)?;
// But support it being overridden by CLI options

// https://github.com/rust-lang/rust-clippy/pull/7639#issuecomment-1050340564
#[allow(clippy::unnecessary_lazy_evaluations)]
let cmd = config.cmd.as_ref().or_else(|| cmd.as_ref());
if let Some(cmd) = cmd {
ctrcfg.set_cmd(Some(cmd.clone()));
}

imgcfg.set_config(Some(ctrcfg));
let ctrcfg = writer.write_config(imgcfg)?;
manifest.set_config(ctrcfg);
writer.write_manifest(manifest, oci_image::Platform::default())?;
Expand All @@ -166,12 +231,13 @@ fn build_oci(
}

/// Helper for `build()` that avoids generics
#[instrument(skip(repo))]
#[instrument(skip(repo, contentmeta))]
async fn build_impl(
repo: &ostree::Repo,
ostree_ref: &str,
config: &Config,
opts: Option<ExportOpts>,
contentmeta: Option<ObjectMetaSized>,
dest: &ImageReference,
) -> Result<String> {
let mut opts = opts.unwrap_or_default();
Expand All @@ -185,6 +251,7 @@ async fn build_impl(
Path::new(dest.name.as_str()),
config,
opts,
contentmeta,
)?;
None
} else {
Expand All @@ -193,7 +260,14 @@ async fn build_impl(
let tempdest = tempdest.to_str().unwrap();
let digestfile = tempdir.path().join("digestfile");

let src = build_oci(repo, ostree_ref, Path::new(tempdest), config, opts)?;
let src = build_oci(
repo,
ostree_ref,
Path::new(tempdest),
config,
opts,
contentmeta,
)?;

let mut cmd = skopeo::new_cmd();
tracing::event!(Level::DEBUG, "Copying {} to {}", src, dest);
Expand Down Expand Up @@ -230,6 +304,8 @@ pub struct ExportOpts {
pub compress: bool,
/// A set of commit metadata keys to copy as image labels.
pub copy_meta_keys: Vec<String>,
/// Maximum number of layers to use
pub max_layers: Option<NonZeroU32>,
}

/// Given an OSTree repository and ref, generate a container image.
Expand All @@ -240,7 +316,8 @@ pub async fn encapsulate<S: AsRef<str>>(
ostree_ref: S,
config: &Config,
opts: Option<ExportOpts>,
contentmeta: Option<ObjectMetaSized>,
dest: &ImageReference,
) -> Result<String> {
build_impl(repo, ostree_ref.as_ref(), config, opts, dest).await
build_impl(repo, ostree_ref.as_ref(), config, opts, contentmeta, dest).await
}
2 changes: 2 additions & 0 deletions lib/src/container/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ use std::ops::Deref;

/// The label injected into a container image that contains the ostree commit SHA-256.
pub const OSTREE_COMMIT_LABEL: &str = "ostree.commit";
/// The label/annotation which contains the sha256 of the final commit.
const OSTREE_DIFFID_LABEL: &str = "ostree.diffid";

/// Our generic catchall fatal error, expected to be converted
/// to a string to output to a terminal or logs.
Expand Down
Loading