Skip to content

Commit 8aef374

Browse files
committed
doc: clarify cross-kernel snapshot compatibility
Simplify by just making the statement that we do not recommend it, and it generally doesnt work except for one limited case. Simplify the table by only listing what's working, an by having the first column directly refer to instance types (instead of cpu architectures, which we later map to instance types in the text). Closes firecracker-microvm#4912 Signed-off-by: Patrick Roy <[email protected]>
1 parent f6bd4b6 commit 8aef374

File tree

1 file changed

+14
-23
lines changed

1 file changed

+14
-23
lines changed

docs/snapshotting/snapshot-support.md

Lines changed: 14 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -640,26 +640,17 @@ booting, to avoid this issue.
640640

641641
## Snapshot compatibility across kernel versions
642642

643-
We have a mechanism in place to experiment with snapshot compatibility across
644-
supported host kernel versions by generating snapshot artifacts through
645-
[this test](../../tests/integration_tests/functional/test_snapshot_phase1.py)
646-
and checking devices' functionality using
647-
[this test](../../tests/integration_tests/functional/test_snapshot_restore_cross_kernel.py).
648-
The test restores the snapshot and ensures that all the devices set-up (network
649-
devices, disk, vsock, balloon and MMDS) are operational post-load.
650-
651-
In those tests the instance is fixed, except some combinations where we also
652-
test across the same CPU family (Intel x86, Gravitons). In general cross-CPU
653-
snapshots [are not supported](./versioning.md#cpu-model)
654-
655-
The tables below reflect the snapshot compatibility observed on the AWS
656-
instances we support.
657-
658-
**all** means all currently supported Intel/AMD/ARM metal instances (m6g, m7g,
659-
m5n, c5n, m6i, m6a). It does not mean cross-instance, i.e. a snapshot taken on
660-
m6i won't work on an m6g instance.
661-
662-
| *CPU family* | *taken on host kernel* | *restored on host kernel* | *working?* |
663-
| ------------ | ---------------------- | ------------------------- | ---------- |
664-
| **x86_64** | 5.10 | 6.1 | Y |
665-
| **x86_64** | 6.1 | 5.10 | N |
643+
Snapshots must be resumed on an software and hardware configuration which is
644+
identical to what they were generated on. However, in limited cases, snapshots
645+
can be resumed on identical hardware instances where they were taken on, but
646+
using newer host kernel versions. While we do not provide any guarantees on this
647+
setup (and do not recommend doing this in production), we are currently aware of
648+
the compatibility table reported below:
649+
650+
| Instance | taken on host kernel | restored on host kernel |
651+
| ----------------- | -------------------- | ----------------------- |
652+
| {c5n,m5n,m6i.m6a} | 5.10 | 6.1 |
653+
654+
For example, a snapshot taken on a m6i.metal host running a 5.10 host kernel can
655+
be restored on a different m6i.metal host running a 6.1 host kernel (but not
656+
vice versa), but could not be restored on a c5n.metal host.

0 commit comments

Comments
 (0)