Skip to content

Commit 153e3f1

Browse files
vibharyadianpopa
authored andcommitted
Docs: Update snapshot support doc
- Add details to the snapshot characteristics - Fix vsock limitation link within doc - Remove one known issues link Signed-off-by: Vibha Acharya <[email protected]>
1 parent 32c7f1e commit 153e3f1

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/snapshotting/snapshot-support.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- [Overview](#overview)
99
- [Snapshot files management](#snapshot-files-management)
1010
- [Performance](#performance)
11-
- [Known issues and limitations](#known-issues-and-limitations)
11+
- [Known issues](#known-issues)
1212
- [Firecracker Snapshotting characteristics](#firecracker-snapshotting-characteristics)
1313
- [Snapshot versioning](#snapshot-versioning)
1414
- [Snapshot API](#snapshot-api)
@@ -23,8 +23,7 @@
2323
- [Snapshot security and uniqueness](#snapshot-security-and-uniqueness)
2424
- [Secure and insecure usage examples](#usage-examples)
2525
- [Reusing snapshotted states securely](#reusing-snapshotted-states-securely)
26-
- [Known Issues](#known-issues)
27-
- [Vsock device limitation](#vsock-device-limitation)
26+
- [Vsock device limitation](#vsock-device-limitation)
2827

2928
## About microVM snapshotting
3029

@@ -84,7 +83,7 @@ resumed microVM.
8483
The Firecracker snapshot design offers a very simple interface to interact with
8584
snapshots but provides no functionality to package or manage them on the host.
8685
Using snapshots in production is currently not recommended as there are open
87-
[Known issues and limitations](#known-issues-and-limitations).
86+
[Known issues](#known-issues).
8887

8988
The [threat containment model](../design.md#threat-containment) states
9089
that the host, host/API communication and snapshot files are trusted by Firecracker.
@@ -111,7 +110,7 @@ The baseline for snapshot resume latency target on Intel is under **8ms** with
111110
5ms p90, and on ARM is under **3ms** for a microVM with the following specs:
112111
2vCPU/512MB/1 block/1 net device.
113112

114-
### Known issues and limitations
113+
### Known issues
115114

116115
- High snapshot latency on 5.4+ host kernels - [#2129](https://github.com/firecracker-microvm/firecracker/issues/2129)
117116
- Guest network connectivity is not guaranteed to be preserved after resume.
@@ -138,6 +137,10 @@ The baseline for snapshot resume latency target on Intel is under **8ms** with
138137
creation. The disk contents are _not_ explicitly flushed to their backing files.
139138
- The API calls exposing the snapshotting functionality have clear **Prerequisites**
140139
that describe the requirements on when/how they should be used.
140+
- The Firecracker microVM's MMDS config is included in the snapshot. However, the
141+
data store is not persisted across snapshots.
142+
- Configuration information for metrics and logs are not saved to the snapshot.
143+
These need to be reconfigured on the restored microVM.
141144

142145
## Snapshot versioning
143146

@@ -573,9 +576,7 @@ properties are preserved and guaranteed before resuming the workload.
573576
We've started a discussion on how the Linux operating system might securely
574577
handle being snapshotted [here](https://lkml.org/lkml/2020/10/16/629).
575578

576-
## Known Issues
577-
578-
### Vsock device limitation
579+
## Vsock device limitation
579580

580581
Vsock must be inactive during snapshot. Vsock device can break if snapshotted
581582
while having active connections. Firecracker snapshots do not capture any

0 commit comments

Comments
 (0)