Skip to content

Commit 27ae5a2

Browse files
docs: add initial documentation for criu-image-streamer
Signed-off-by: Manogna Polikepad <manognapolikepad@gmail.com>
1 parent 9e5fbcd commit 27ae5a2

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

Documentation/image-streamer.txt

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## criu-image-streamer
2+
3+
### Overview
4+
criu-image-streamer is an optional helper component used with CRIU to stream checkpoint images instead of writing them entirely to disk before transfer.
5+
6+
It is built and installed separately from CRIU and is typically used in workflows where reducing downtime or disk I/O is important.
7+
8+
### When is criu-image-streamer used?
9+
criu-image-streamer can be used when checkpoint images need to be transferred efficiently, for example during migration scenarios where writing full image sets to disk may be slow or undesirable.
10+
11+
### Difference from live migration
12+
Unlike traditional live migration, criu-image-streamer does not continuously synchronize memory pages. Instead, it focuses on streaming CRIU checkpoint images during the checkpoint/restore process.
13+
14+
### Installation
15+
The CRIU repository provides a helper script to install criu-image-streamer:
16+
17+
`scripts/install-criu-image-streamer.sh`
18+
19+
This script installs the Rust toolchain, clones the criu-image-streamer repository, and builds the project.
20+
21+
### References
22+
- scripts/install-criu-image-streamer.sh
23+
- https://github.com/checkpoint-restore/criu-image-streamer
24+
25+
26+
Internally, CRIU and criu-image-streamer communicate using a simple request–reply protocol to coordinate image transfer during dump and restore.

0 commit comments

Comments
 (0)