Skip to content

fix(vm): scope rootfs cache by openshell version #1587

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.

Sign up for GitHub

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

Merged
maxamillion merged 1 commit into from
May 27, 2026
+23 −8
Merged

fix(vm): scope rootfs cache by openshell version #1587

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions crates/openshell-driver-vm/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,9 @@ Linux-owned ext4 storage. The resulting disk is cached under
sandboxes. Local Docker images are still exported as rootfs tar archives and
prepared inside the bootstrap VM. Set `OPENSHELL_VM_IMAGE_PULL_CONCURRENCY` to
tune registry layer download parallelism (default `4`, maximum `16`).
Both caches are scoped by source image identity and OpenShell version, so an
OpenShell upgrade builds a fresh guest rootfs instead of reusing one with an old
embedded supervisor.

Each sandbox gets its own sparse writable
`<state-dir>/sandboxes/<id>/overlay.ext4`. Guest init mounts overlayfs as `/`
Expand Down
28 changes: 20 additions & 8 deletions crates/openshell-driver-vm/src/driver.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ const GUEST_IMAGE_CONFIG_DIR: &str = "openshell-image";
const GUEST_IMAGE_OCI_LAYOUT_DIR: &str = "oci";
const GUEST_IMAGE_OCI_REF: &str = "openshell";
const IMAGE_EXPORT_ROOTFS_ARCHIVE: &str = "source-rootfs.tar";
const BOOTSTRAP_IMAGE_CACHE_LAYOUT_VERSION: &str = "sandbox-bootstrap-rootfs-ext4-v2";
const PREPARED_IMAGE_CACHE_LAYOUT_VERSION: &str = "sandbox-prepared-rootfs-ext4-umoci-v2";
const BOOTSTRAP_IMAGE_CACHE_LAYOUT_VERSION: &str = "sandbox-bootstrap-rootfs-ext4-v3";
const PREPARED_IMAGE_CACHE_LAYOUT_VERSION: &str = "sandbox-prepared-rootfs-ext4-umoci-v3";
const IMAGE_IDENTITY_FILE: &str = "image-identity";
const IMAGE_REFERENCE_FILE: &str = "image-reference";
const IMAGE_PREP_INIT_MODE: &str = "image-prep";
Expand Down Expand Up @@ -3725,11 +3725,17 @@ fn write_oci_layout_for_manifest(
}

fn bootstrap_image_cache_identity(image_identity: &str) -> String {
format!("{BOOTSTRAP_IMAGE_CACHE_LAYOUT_VERSION}:{image_identity}")
format!(
"{BOOTSTRAP_IMAGE_CACHE_LAYOUT_VERSION}:openshell-{}:{image_identity}",
openshell_core::VERSION
)
}

fn prepared_image_cache_identity(image_identity: &str) -> String {
format!("{PREPARED_IMAGE_CACHE_LAYOUT_VERSION}:{image_identity}")
format!(
"{PREPARED_IMAGE_CACHE_LAYOUT_VERSION}:openshell-{}:{image_identity}",
openshell_core::VERSION
)
}

fn registry_layer_download_concurrency() -> usize {
Expand Down Expand Up @@ -5517,18 +5523,24 @@ mod tests {
}

#[test]
fn prepared_image_cache_identity_includes_rootfs_layout_version() {
fn prepared_image_cache_identity_includes_rootfs_layout_and_openshell_version() {
assert_eq!(
prepared_image_cache_identity("sha256:local-image"),
"sandbox-prepared-rootfs-ext4-umoci-v2:sha256:local-image"
format!(
"sandbox-prepared-rootfs-ext4-umoci-v3:openshell-{}:sha256:local-image",
openshell_core::VERSION
)
);
}

#[test]
fn bootstrap_image_cache_identity_includes_rootfs_layout_version() {
fn bootstrap_image_cache_identity_includes_rootfs_layout_and_openshell_version() {
assert_eq!(
bootstrap_image_cache_identity("sha256:bootstrap-image"),
"sandbox-bootstrap-rootfs-ext4-v2:sha256:bootstrap-image"
format!(
"sandbox-bootstrap-rootfs-ext4-v3:openshell-{}:sha256:bootstrap-image",
openshell_core::VERSION
)
);
}

Expand Down
Loading