Add API for Snapshot metadata - #1860
Merged
Merged
Conversation
ludfjig
requested review from
andreiltd,
danbugs,
dblnz,
devigned,
jprendes,
jsturtevant,
simongdavies,
squillace and
syntactically
as code owners
September 28, 2026 18:02
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Older v3 readers may reject metadata-bearing snapshots due to the expanded config schema.
Review effort: Lite
Findings: 1
What changed in this PR
Adds immutable, namespaced JSON metadata APIs for snapshots, persisted through OCI config blobs.
Changes:
- Adds metadata read/write APIs.
- Shares immutable snapshot state through
Arc. - Adds persistence tests, documentation, and changelog updates.
| File | Summary |
|---|---|
src/hyperlight_host/src/sandbox/snapshot/mod.rs |
Snapshot state sharing and metadata APIs |
src/hyperlight_host/src/sandbox/snapshot/file/mod.rs |
Metadata serialization and loading |
src/hyperlight_host/src/sandbox/snapshot/file/config.rs |
OCI config metadata field |
src/hyperlight_host/src/sandbox/snapshot/file_tests.rs |
Metadata behavior and persistence tests |
docs/snapshot-versioning.md |
Compatibility documentation |
docs/snapshot-oci-format.md |
OCI metadata format documentation |
CHANGELOG.md |
User-facing feature entry |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
ludfjig
force-pushed
the
snapshot-metadata
branch
2 times, most recently
from
September 28, 2026 18:40
5c441b1 to
84a39e6
Compare
ludfjig
added
kind/enhancement
simongdavies
approved these changes
Sep 28, 2026
Signed-off-by: Ludvig Liljenberg <4257730+ludfjig@users.noreply.github.com>
Signed-off-by: Ludvig Liljenberg <4257730+ludfjig@users.noreply.github.com>
ludfjig
force-pushed
the
snapshot-metadata
branch
from
September 28, 2026 22:05
84a39e6 to
c655301
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds api to store arbitrary
Serilaizeinto a snapshot. This is persisted on disk as json. Useful for hyperlight-wasm and js to tag snapshtos and embed extra data needed.First commit is a refactor to keep immutable state in it's own arc, second commit adds the feature. Snapshots are still immutable
Closes #1860