Skip to content

Commit 2d5b47a

Browse files
committed
doc: clarify cross-kernel snapshot compatibility
Update the explanation text to refer to the "working?" column instead of some mystical "**all**", which doesnt exist. Also expand a bit on the explanation to make it clearer what works and what doesnt. Closes firecracker-microvm#4912 Signed-off-by: Patrick Roy <[email protected]>
1 parent f6bd4b6 commit 2d5b47a

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/snapshotting/snapshot-support.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -655,11 +655,17 @@ snapshots [are not supported](./versioning.md#cpu-model)
655655
The tables below reflect the snapshot compatibility observed on the AWS
656656
instances we support.
657657

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.
658+
The *working?* column indicates whether snapshots taken on the host kernel
659+
version specified in the *taken* column can be restored on a host _of the same
660+
hardware kind_ running the kernel version specified in the *restored* column:
661+
E.g. a snapshot taken on a m6i.metal (Intel IceLake) instance with a 5.10 host
662+
kernel can be restored on a m6i.metal instance with a 6.1 host kernel, but _not_
663+
on a m5n.metal (Intel CascadeLake) instance with a 6.1 host kernel. **x86_64**
664+
means all currently supported Intel/AMD metal instances (m5n, c5n, m6i, m6a),
665+
while **aarch64** mean all currently support ARM metal instances (m6g, m7g).
661666

662667
| *CPU family* | *taken on host kernel* | *restored on host kernel* | *working?* |
663668
| ------------ | ---------------------- | ------------------------- | ---------- |
664669
| **x86_64** | 5.10 | 6.1 | Y |
665670
| **x86_64** | 6.1 | 5.10 | N |
671+
| **aarch64** | any | any | N |

0 commit comments

Comments
 (0)